{"info":{"_postman_id":"8097cef5-2488-42f9-9d40-6a84dc4146b4","name":"API Documentation","description":"

Omnitax Platform

Omnitax is a Brazilian company that develops and offers software solutions in SaaS format that add value to companies by optimizing tax document issuance, invoicing, tax assessment, tax assessment, tax and accounting bookkeeping, among others.

We are the first global, fully white-label tax intelligence technology platform capable of integrating via API with any ecosystem, be it an ERP, a marketplace, an online e-commerce or an offline POS embedded in Windows, Linux and Android platforms. This is the documentation for using our APIs, developed with great care to facilitate your integration work.

The step-by-step guide to safe and sustainable integration:

1. Initially, it is important to understand how the basic registration entities are hierarchically structured, necessary for the correct functioning of the services offered through the platform. The hierarchy is presented in the form of 4 main contexts:

Entities
\n
- whitelabel
  \n
- whitelabel.accounts
  \n
- whitelabel.accounts.companies
  \n
- whitelabel.accounts.companies.subsidiaries
  \n
\n

All other basic registrations are organized in light of these 4 main contexts.

2. The next step is to access the platform through your preferred domain to obtain a valid \"x-api-key\" required to make calls to our APIs. You can count on the help of your sales representative or our customer support team at suporte@omnitax.ai.

3. Assemble your team. We suggest that you register customizable access profiles for each group of users and invite them. This step is very important because users will be the ones who will actually use the services offered through the platform. Therefore, it is important that you understand everything that the platform offers (its resources and their respective actions), especially how they are charged and the impact of each service on your operation, and define what each member of your team can do. This way, you will be able to enjoy the benefits of the platform by assigning specific skills and responsibilities to each user.

4. Define which resources your team will use and set them up. For example, if you intend to manage invoices through the platform, you need to register accounts, companies, subsidiaries and tax issuance series, and if you intend to operate offline, you also need to register sales terminals.

5. Define which integrations will actually be necessary. For example, if you do not have many subsidiaries opened over time, you may decide to do a batch or individual registration by importing a spreadsheet or using our user application instead of doing a systemic integration.

6. Develop the payload of your request in Json format following the following additional guidelines:

We hope to anticipate and consider all possible situations when validating your request, but to avoid unknown issues, we ask that you do not enter empty fields (e.g. empty string) or special characters (e.g. º, § £, ™,@, ª , etc) at your request under any circumstances;
\n
If you want to edit a field by removing the existing content in it, inform the field followed by the literal null;
\n
Do not report duplicate fields, as the treatment implemented by the API is to use the last field read in the payload;
\n
Respect rate limit of up to 50 requests per minute, except in the tax calculation endpoints (rules-engine/evaluate) and issuing invoice events (invoices/event/{tpEvento}), which is unlimited;
\n
Respect limit of up to 50 items per page, in the case of resource listing endpoints
\n

7. Finally, consider that the responses obtained in calls made to our APIs will always return an “HTTP Status Code”, and expected codes and their respective standard response model can be found in each endpoint registered in this documentation.

8. In addition to this more technical documentation, you can also access our more functional looking content base here. If you still need help or even if you find strange behavior in your tests or not in line with what is documented, do not hesitate to contact us by sending an email to suporte@omnitax.ai.

We will be delighted to serve you.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18492219","collectionId":"8097cef5-2488-42f9-9d40-6a84dc4146b4","publishedId":"2sB3HtEby3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-09-19T21:59:02.000Z"},"item":[{"name":"entities","item":[{"name":"accounts","item":[{"name":"accounts","id":"442a2f13-34a0-4725-a542-85428a182c3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
whitelabelId	This is the whitelabelId where your account will be registered. It is required, must be a string and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
name	This is the name by which your account will be recognized on the platform. It is required, must be a string, must be a unique name, and can't exceed 60 characters.
images.logoBase64	This is your account logo on a white background. It is optional, it must be a string and the informed content must be in base64.
images.iconBase64	This is your account icon on a white background. It is optional, it must be a string and the informed content must be in base64.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["accounts"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"2c88c50c-5130-43ae-b62b-424feb0a5316","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"whitelabelId\": \"required, string\",\n \"name\": \"required, string\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Account registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"dc824067-bca9-4d7c-ab80-6db4bbdba7cc","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"whitelabelId\": \"required, string\",\n \"name\": \"required, string\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"name\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"ddbd4b96-1cc1-4bb6-84fb-d9df782acc1f","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"whitelabelId\": \"required, string\",\n \"name\": \"required, string\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"16b6b823-6b0b-4b74-92c9-b5336ff251cf","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"whitelabelId\": \"required, string\",\n \"name\": \"required, string\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ff517938-9b7f-4218-9b60-04307a58f359","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"whitelabelId\": \"required, string\",\n \"name\": \"required, string\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"whitelabelId\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"},{"id":"f9e85c9d-93c6-4503-868f-c2e29fcc13f4","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"whitelabelId\": \"required, string\",\n \"name\": \"required, string\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"name\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"442a2f13-34a0-4725-a542-85428a182c3d"},{"name":"accounts (list)","id":"abc1a121-4191-4b72-a874-be20123fdcfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts?page=1&limit=50&sort=asc&orderBy=id&q=","urlObject":{"protocol":"{{PROTOCOL}}","path":["accounts"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of item per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, name, createdAt, updatedAt, enabled, companiesTotal or usersTotal

\n","type":"text/plain"},"key":"orderBy","value":"id"},{"description":{"content":"

Search by: id, remoteId, name, companyId, federalDocument

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"d3a76501-2eae-407b-bf7f-18e06f5ce9f0","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts?page=1&limit=50&sort=asc&orderBy=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["accounts"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of item per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"id","description":"Order by: id, name, createdAt, updatedAt, enabled, companiesTotal or usersTotal"},{"key":"q","value":"","description":"Search by: id, remoteId, name, companyId, federalDocument"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743540466,\n \"formatted\": \"01/04/2025 - 17:47:46\"\n },\n \"updatedAt\": {\n \"epoch\": 1743856933,\n \"formatted\": \"05/04/2025 - 09:42:13\"\n },\n \"name\": \"\",\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"images\": {\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743528734,\n \"formatted\": \"01/04/2025 - 14:32:14\"\n },\n \"updatedAt\": {\n \"epoch\": 1743619784,\n \"formatted\": \"02/04/2025 - 15:49:44\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 0,\n \"usersTotal\": 0\n },\n \"apiKeys\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"authorizationHeaderEnabled\": false,\n \"enabled\": true,\n \"creatorEmail\": null,\n \"createdAt\": {\n \"epoch\": 1743540466,\n \"formatted\": \"01/04/2025 - 17:47:46\"\n },\n \"updatedAt\": null\n }\n ]\n }\n ]\n}"},{"id":"306fc06f-cb29-49be-8241-9a2d5ac72d56","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts?page=1&limit=50&sort=asc&orderBy=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["accounts"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of item per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"id","description":"Order by: id, name, createdAt, updatedAt, enabled, companiesTotal or usersTotal"},{"key":"q","value":"","description":"Search by: id, remoteId, name, companyId, federalDocument"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"c04638e0-b358-4d9c-82fd-e5afab54b076","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts?page=1&limit=50&sort=asc&orderBy=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["accounts"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of item per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"id","description":"Order by: id, name, createdAt, updatedAt, enabled, companiesTotal or usersTotal"},{"key":"q","value":"","description":"Search by: id, remoteId, name, companyId, federalDocument"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"abc1a121-4191-4b72-a874-be20123fdcfe"},{"name":"accounts (detail)","id":"8d119054-6aea-494b-8e6f-921bc78e58d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["accounts","{accountId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"cc9599cf-5fb0-4918-b245-4b1472d64510","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743540466,\n \"formatted\": \"01/04/2025 - 17:47:46\"\n },\n \"updatedAt\": {\n \"epoch\": 1743856933,\n \"formatted\": \"05/04/2025 - 09:42:13\"\n },\n \"name\": \"\",\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"images\": {\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743528734,\n \"formatted\": \"01/04/2025 - 14:32:14\"\n },\n \"updatedAt\": {\n \"epoch\": 1743619784,\n \"formatted\": \"02/04/2025 - 15:49:44\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 0,\n \"usersTotal\": 0\n },\n \"apiKeys\": [\n {\n \"key\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"authorizationHeaderEnabled\": false,\n \"enabled\": true,\n \"creatorEmail\": null,\n \"createdAt\": {\n \"epoch\": 1743540466,\n \"formatted\": \"01/04/2025 - 17:47:46\"\n },\n \"updatedAt\": null\n }\n ]\n }\n}"},{"id":"69c54e60-a5dc-4a97-9070-c1c457facddd","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"3172cb0f-f72f-4b54-9e3b-4c7f6d404849","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"fa5ccc04-38fa-42d0-b042-0d3a2e43ce62","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"8d119054-6aea-494b-8e6f-921bc78e58d5"},{"name":"accounts","id":"97e1a5e4-c761-472f-a42b-ae1f4fdcfcae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
name	This is the name by which your account will be recognized on the platform. It is required, must be a string, must be a unique name, and can't exceed 60 characters.
enabled	This information defines whether your account is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false.
images.logoBase64	This is your account logo on a white background. It is optional, it must be a string and the informed content must be in base64.
images.iconBase64	This is your account icon on a white background. It is optional, it must be a string and the informed content must be in base64.
apiKeys.key	This is the API authentication token automatically generated by the Omnitax platform. It can't be edited.
apiKeys.name	It is the name to identify the key used as a token in API authentication. It is optional, must be a string and its maximum size is 60 characters.
apiKeys.description	The description for a key used as a token in API authentication. It is optional, must be a string, and its maximum length is 256 characters.
apiKeys.authorizationHeaderEnabled	It is used to define whether the Authorization header can be used together with the ApiKey key in API authentication. It is required, it must be a boolean and the informed content must be true or false.
apiKeys.enabled	It is used to defines whether your ApiKey is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["accounts","{accountId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"492ad144-5226-4ae7-896b-7836bf208a88","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n },\n \"apiKeys\": [\n {\n \"key\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"authorizationHeaderEnabled\": \"optional, boolean\",\n \"enabled\": \"optional, boolean\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Account updated successfully\"\n}"},{"id":"6a6c308e-53a5-479b-bc1f-7085be0d3b38","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n },\n \"apiKeys\": [\n {\n \"key\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"authorizationHeaderEnabled\": \"optional, boolean\",\n \"enabled\": \"optional, boolean\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"152f228c-4269-434b-ac25-ec962cb28319","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n },\n \"apiKeys\": [\n {\n \"key\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"authorizationHeaderEnabled\": \"optional, boolean\",\n \"enabled\": \"optional, boolean\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"2b0436fe-c10f-42dc-83d3-93181c3463db","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n },\n \"apiKeys\": [\n {\n \"key\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"authorizationHeaderEnabled\": \"optional, boolean\",\n \"enabled\": \"optional, boolean\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"97e1a5e4-c761-472f-a42b-ae1f4fdcfcae"},{"name":"accounts","id":"58aa7f87-f270-4ad7-9eea-b73d957615ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["accounts","{accountId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"7269e118-7ea9-4609-9631-5464fcc5e5e9","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Account removed successfully\"\n}"},{"id":"815c340c-b219-4045-9ef2-6fa678a7dcc0","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"491186cd-a945-4673-9e02-88ee772240c6","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"3cc2c942-7d8f-47c1-abbe-fa4aaf31df86","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/accounts/{accountId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"58aa7f87-f270-4ad7-9eea-b73d957615ab"}],"id":"1649e924-a08f-4417-aa4e-132770465bef","description":"

Users are allowed to register business accounts under some previously selected whitelabel. The account is the ultimate entity within a whitelabel. It is under it that you will be able to simultaneously register and manage several companies of the same customers. The unit of an account within a whitelabel will be given by its name.

\n","_postman_id":"1649e924-a08f-4417-aa4e-132770465bef"},{"name":"companies","item":[{"name":"companies","id":"2a1d0a41-d2f3-4aa3-8417-e6aa6e659720","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
accountId	This is the accountId where your company will be registered. It is required, must be a string and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter only the first 8 digits. If it is a CPF, enter the 9 digits. It is mandatory and must be a string.
name	This is the name by which your company will be recognized on the platform. It is required, must be a string, must be a unique name, and can't exceed 128 characters.
countryIsoAlphaThree	This is the country of origin of your company in ISO 3166-1 alpha-3 format (eg \"BRA\"). It is required and must be a string.
certificate.fileBase64	This is your company's digital certificate, optional for company registration, but mandatory to use some services on the platform, such as issuing invoices. It must be a string and the content entered must be in base64.
certificate.password	This is the access password for the digital certificate, mandatory if \"certificateBase64\" is informed. It must be a string.
certificate.filename	This is the name of the digital certificate file, required if \"certificateBase64\" is entered. It must be a string.
images.logoBase64	This is your company logo on a white background. It is optional, it must be a string and the informed content must be in base64.
images.iconBase64	This is your company icon on a white background. It is optional, it must be a string and the informed content must be in base64.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["companies"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"01a18f4f-f927-4811-9555-7fe9c72b215c","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"name\": \"required, string\",\n \"countryIsoAlphaThree\": \"required, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Company registered with success.\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"2d4a35dd-1be7-4423-a731-0c4ce7ff4e68","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"name\": \"required, string\",\n \"countryIsoAlphaThree\": \"required, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"name\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"0fb4f7d8-f94b-41d9-9b86-8f8dc9fe5abe","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"name\": \"required, string\",\n \"countryIsoAlphaThree\": \"required, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"80d89442-153c-4bb1-9edf-63ddd04c3ca1","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"name\": \"required, string\",\n \"countryIsoAlphaThree\": \"required, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"bca51bfa-c8b3-4d52-ab04-6fc210ccf79f","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"name\": \"required, string\",\n \"countryIsoAlphaThree\": \"required, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"accountId\",\n \"messages\": [\n \"Not Found\"\n ]\n }\n ]\n}"},{"id":"0256ad6c-4604-4d19-a2a3-a8a04e657fe2","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"name\": \"required, string\",\n \"countryIsoAlphaThree\": \"required, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"name\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"2a1d0a41-d2f3-4aa3-8417-e6aa6e659720"},{"name":"companies (list)","id":"cd729f44-efec-4839-b143-f7fa47c5e4d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies?page=1&limit=50&accountId=id&sort=asc&orderBy=id&q=","urlObject":{"protocol":"{{PROTOCOL}}","path":["companies"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of item per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Filter by all companies from account

\n","type":"text/plain"},"key":"accountId","value":"id"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, name, createdAt, updatedAt, federalDocument, enabled, subsidiariesTotal or usersTotal

\n","type":"text/plain"},"key":"orderBy","value":"id"},{"description":{"content":"

Search by: id, remoteId, accountId, name or federalDocument

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"8dbb0322-eafc-4e6b-a6f9-4fa3fe5071f3","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/companies?page=1&limit=50&accountId=id&sort=asc&orderBy=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["companies"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of item per page"},{"key":"accountId","value":"id","description":"Filter by all companies from account"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"id","description":"Order by: id, name, createdAt, updatedAt, federalDocument, enabled, subsidiariesTotal or usersTotal"},{"key":"q","value":"","description":"Search by: id, remoteId, accountId, name or federalDocument"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743547419,\n \"formatted\": \"01/04/2025 - 19:43:39\"\n },\n \"updatedAt\": {\n \"epoch\": 1743549239,\n \"formatted\": \"01/04/2025 - 20:13:59\"\n },\n \"name\": \"\",\n \"federalDocument\": \"\",\n \"certificate\": {\n \"filename\": \"\",\n \"expirationAt\": \"\",\n \"downloadLink\": \"\"\n },\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 0,\n \"images\": {\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743540466,\n \"formatted\": \"01/04/2025 - 17:47:46\"\n },\n \"updatedAt\": {\n \"epoch\": 1743547419,\n \"formatted\": \"01/04/2025 - 19:43:39\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 0,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743528734,\n \"formatted\": \"01/04/2025 - 14:32:14\"\n },\n \"updatedAt\": {\n \"epoch\": 1743540517,\n \"formatted\": \"01/04/2025 - 17:48:37\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 2,\n \"usersTotal\": 0\n }\n },\n \"country\": {\n \"xPais\": \"\",\n \"cPaisIbge\": \"\",\n \"cPaisSiscomex\": \"\",\n \"isoAlphaThree\": \"\"\n },\n \"headSubsidiary\": {\n \"id\": \"\",\n \"enabled\": true,\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": null,\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1743547800,\n \"formatted\": \"01/04/2025 - 19:50:00\"\n },\n \"endDate\": null\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1743547829,\n \"formatted\": \"01/04/2025 - 19:50:29\"\n },\n \"endDate\": null\n }\n ],\n \"createdAt\": {\n \"epoch\": 1743549239,\n \"formatted\": \"01/04/2025 - 20:13:59\"\n },\n \"updatedAt\": null\n },\n \"period\": {\n \"year\": 2025,\n \"months\": {\n \"january\": \"\",\n \"february\": \"\",\n \"march\": \"\",\n \"april\": \"\",\n \"may\": \"\",\n \"june\": \"\",\n \"july\": \"\",\n \"august\": \"\",\n \"september\": \"\",\n \"october\": \"\",\n \"november\": \"\",\n \"december\": \"\"\n },\n \"transactions\": [],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n }\n ]\n}"},{"id":"d04eac86-5009-41cb-88fa-be98d0d30bf5","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/companies?page=1&limit=50&accountId=id&sort=asc&orderBy=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["companies"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of item per page"},{"key":"accountId","value":"id","description":"Filter by all companies from account"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"id","description":"Order by: id, name, createdAt, updatedAt, federalDocument, enabled, subsidiariesTotal or usersTotal"},{"key":"q","value":"","description":"Search by: id, remoteId, accountId, name or federalDocument"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"90698bfa-2b13-4c42-99b2-da35ad9abbbc","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/companies?page=1&limit=50&accountId=id&sort=asc&orderBy=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["companies"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of item per page"},{"key":"accountId","value":"id","description":"Filter by all companies from account"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"id","description":"Order by: id, name, createdAt, updatedAt, federalDocument, enabled, subsidiariesTotal or usersTotal"},{"key":"q","value":"","description":"id, remoteId, accountId, name or federalDocument"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"cd729f44-efec-4839-b143-f7fa47c5e4d3"},{"name":"companies (detail)","id":"44391c5d-2fd5-4c3d-b988-1db5228880a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["companies","{companyId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"7cbc85a3-92a5-46c5-897b-f063766380da","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743547419,\n \"formatted\": \"01/04/2025 - 19:43:39\"\n },\n \"updatedAt\": {\n \"epoch\": 1743549239,\n \"formatted\": \"01/04/2025 - 20:13:59\"\n },\n \"name\": \"\",\n \"federalDocument\": \"\",\n \"certificate\": {\n \"filename\": \"\",\n \"expirationAt\": \"\",\n \"downloadLink\": \"\"\n },\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 0,\n \"images\": {\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743540466,\n \"formatted\": \"01/04/2025 - 17:47:46\"\n },\n \"updatedAt\": {\n \"epoch\": 1743547419,\n \"formatted\": \"01/04/2025 - 19:43:39\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 0,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1743528734,\n \"formatted\": \"01/04/2025 - 14:32:14\"\n },\n \"updatedAt\": {\n \"epoch\": 1743540517,\n \"formatted\": \"01/04/2025 - 17:48:37\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 2,\n \"usersTotal\": 0\n }\n },\n \"country\": {\n \"xPais\": \"\",\n \"cPaisIbge\": \"\",\n \"cPaisSiscomex\": \"\",\n \"isoAlphaThree\": \"\"\n },\n \"headSubsidiary\": {\n \"id\": \"\",\n \"enabled\": true,\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": null,\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1743547800,\n \"formatted\": \"01/04/2025 - 19:50:00\"\n },\n \"endDate\": null\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1743547829,\n \"formatted\": \"01/04/2025 - 19:50:29\"\n },\n \"endDate\": null\n }\n ],\n \"createdAt\": {\n \"epoch\": 1743549239,\n \"formatted\": \"01/04/2025 - 20:13:59\"\n },\n \"updatedAt\": null\n },\n \"period\": {\n \"year\": 2025,\n \"months\": {\n \"january\": \"\",\n \"february\": \"\",\n \"march\": \"\",\n \"april\": \"\",\n \"may\": \"\",\n \"june\": \"\",\n \"july\": \"\",\n \"august\": \"\",\n \"september\": \"\",\n \"october\": \"\",\n \"november\": \"\",\n \"december\": \"\"\n },\n \"transactions\": [],\n \"company\": {\n \"id\": \"\",\n \"name\": \"\"\n }\n }\n }\n}"},{"id":"9fed3929-6a3b-46f8-8b6b-223425d6bc53","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"103a9977-942b-404d-af35-a518bb7772cf","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"39f9f308-04b3-461f-b1eb-1a6a07956658","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"44391c5d-2fd5-4c3d-b988-1db5228880a0"},{"name":"companies (certificate)","id":"dbd5e3d9-eab0-4ba1-8dd0-84bbc891864c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/certificate/{companyId}/download","description":"

Download the company's digital certificate file.

To use this API endpoint, you must use the same authentication headers as the other endpoints. Thus maintaining the security and integrity of sensitive data.

\n","urlObject":{"protocol":"{{PROTOCOL}}","path":["companies","certificate","{companyId}","download"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"508b1977-a969-45d7-b4c2-ab02c6062361","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/certificate/{companyId}/download"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"FILE CONTENT"},{"id":"b38ccd4f-3eff-4c73-a3c7-30400c0e18af","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/certificate/{companyId}/download"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"ca565c43-646b-4e6e-afe4-1b9872eb726c","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/certificate/{companyId}/download"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"014e955e-f53c-41b0-b531-7f241e59dabe","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/certificate/{companyId}/download"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"dbd5e3d9-eab0-4ba1-8dd0-84bbc891864c"},{"name":"companies","id":"18e59ef7-f4e6-4b1b-9f24-5252706935d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter only the first 8 digits. If it is a CPF, enter the 9 digits. It is mandatory and must be a string.
name	This is the name by which your company will be recognized on the platform. It is required, must be a string, must be a unique name, and can't exceed 128 characters.
countryIsoAlphaThree	This is the country of origin of your company in ISO 3166-1 alpha-3 format (eg \"BRA\"). It is required and must be a string.
certificate.fileBase64	This is your company's digital certificate, optional for company registration, but mandatory to use some services on the platform, such as issuing invoices. It must be a string and the content entered must be in base64.
certificate.password	This is the access password for the digital certificate, mandatory if \"certificateBase64\" is informed. It must be a string.
certificate.filename	This is the name of the digital certificate file, required if \"certificateBase64\" is entered. It must be a string.
images.logoBase64	This is your company logo on a white background. It is optional, it must be a string and the informed content must be in base64.
images.iconBase64	This is your company icon on a white background. It is optional, it must be a string and the informed content must be in base64.
enabled	This information defines whether your company is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["companies","{companyId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"1a974f22-6e3a-4b17-bed5-5cc8e7239268","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"name\": \"optional, string\",\n \"countryIsoAlphaThree\": \"optional, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, strin(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Company updated successfully\"\n}"},{"id":"ca93bc98-5394-40cb-a01e-282b68de172d","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"name\": \"optional, string\",\n \"countryIsoAlphaThree\": \"optional, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, strin(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"cde9c3d7-b6fd-4176-b7f4-d8379dbd6525","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"name\": \"optional, string\",\n \"countryIsoAlphaThree\": \"optional, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, strin(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"04ae43c8-b9f4-46ce-af0b-9984df1a90e8","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"name\": \"optional, string\",\n \"countryIsoAlphaThree\": \"optional, string\",\n \"certificate\": {\n \"fileBase64\": \"optional, strin(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n },\n \"images\": {\n \"logoBase64\": \"optional, string(base64)\",\n \"iconBase64\": \"optional, string(base64)\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"18e59ef7-f4e6-4b1b-9f24-5252706935d4"},{"name":"companies","id":"358ca15a-3b74-4dad-ba17-5f9f75604b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["companies","{companyId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"acd27c96-b153-4776-806b-34e8562f25f6","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Company removed successfully\"\n}"},{"id":"6222d7f2-3aa7-4c4f-aece-90768a1bc73b","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"e3910510-cc62-41f5-aef2-42f5e69190b2","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"9129e013-0f2f-4b5f-8c44-9a5ac4d1184b","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/companies/{companyId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"358ca15a-3b74-4dad-ba17-5f9f75604b12"}],"id":"29431f97-f52a-462c-a022-d57a21b63547","description":"

Users can register companies under a previously selected account. The company is the final entity within an account. It is here that you can simultaneously register and manage several subsidiaries of the same company. A company unit within an account will be given by its root federalDocument. In Brazil, for example, the federalDocument of a company (legal entity) is the root of the CNPJ (CNPJ: 00.000.000) consisting of 8 digits and the federalDocument of a person (natural person) is the root of their CPF (CPF: 000.000.000) complete with 9 digits.

\n","_postman_id":"29431f97-f52a-462c-a022-d57a21b63547"},{"name":"subsidiaries","item":[{"name":"subsidiaries","id":"ff801586-9e64-4ec6-bf7f-9313f91e7d4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries","description":"

`Attribute`	`Details`
companyId	This is the companyId where your subsidiary will be registered. It is required, must be a string and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
identification.headquarters	This attribute is used to indicate whether the subsidiary is a headquarter or not. It does not need to be informed in the registration because the first registered subsidiary must be the headquarter. It can only be informed in the update of a subsidiary that was not a headquarter and became one. It is optional and must be a boolean.
identification.federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is required and must be a string.
identification.xNome	This is the legal name by which your subsidiary is recognized. It is required, must be a string and can't exceed 60 characters.
identification.xFant	This is the personal name by which your subsidiary is recognized. It is required, must be a string and can't exceed 60 characters.
identification.nire	This is your state subsidiary's business registration identification number. It is optional, must be a string and can't exceed 11 characters.
identification.codQualif	This is the headquarters subsidiary qualification code. It is required for the headquarters and must not be informed for other subsidiaries, because they will automatically inherit the qualification code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=codQualif\"
identification.openingDate	This is the start date of the subsidiary's activities. It is optional, must be a string, must be in UTC format, and must be less than the end date of subsidiary activities.
identification.closingDate	This is the closing date of the subsidiary's activities. It is optional, it must be a string, it must be in UTC format and it must be greater than the start date of the subsidiary activities.
identification.sitEspecial	This is the special status code for the headquarters subsidiary. It is required for the headquarter and should not be informed for the other subsidiaries, as they will automatically inherit the code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=sitEspecial\"
identification.specialSituationDate	This is the date of the special situation registered in the parent subsidiary. It is only required for the parent subsidiary that has “sitSpecial” other than “0”. It should not be entered in any other situation. It must be a string and the content must be in UTC format.
identification.email	This is the subsidiary's contact email address. It is optional, must be a string and can't exceed 60 characters.
identification.fone	This is the subsidiary's contact phone. It is optional, must be a string and can't exceed 30 characters.
identification.website	This is the website address of the subsidiary. It is optional, must be a string and can't exceed 60 characters.
address.cep	This is the postal address code (CEP) of the subsidiary established in Brazil. It is required, must be a string and must be of length 8.
address.xLgr	This is the subsidiary's address. It is required, it must be a string and can't exceed 60 characters.
address.nro	This is the subsidiary address number. It is mandatory, it must be a string and can't exceed 60 characters.
address.xCpl	This is the subsidiary address complement. It is optional, it must be a string and can't exceed 60 characters.
address.xBairro	This is the neighborhood of the subsidiary's address. It is required, it must be a string and can't exceed 60 characters.
address.cMun	This is the municipality code of the subsidiary in Brazil. It is required, it must be a string, it must have a length of 7 and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
address.UF	This is the abbreviation of the state of the subsidiary in Brazil. It is required, it must be a string, it must have length 2 and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
address.cPais	This is the acronym of the country of the subsidiary. It is required, it must be a string, it must be in ISO 3166-1 alpha-2 format (ex Brasil: \"1058\") and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=GLOBAL&sortKey=COUNTRIES\"
legalNatures[].natJur	This is the legal nature code of the headquarters subsidiary. It is required for the headquarters and should not be informed for the other subsidiaries, as they will automatically inherit the qualification code entered for the headquarters. It must be a string and the specified content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=natJur\"
legalNatures[].startDate	This is the initial effective date of the legal nature record of the parent subsidiary which is also inherited by all other subsidiaries. It is required, must be a string and the content entered must be in UTC format.
legalNatures[].endDate	This is the final effective date of the legal nature record of the parent subsidiary which is also inherited by all other subsidiaries. It is optional, must be a string and the content entered must be in UTC format.
cnaes[].main	This is the indication that the declared economic activity is the main one. It is required and must be a boolean.
cnaes[].cnae	This is one of the subsidiary's economic activity codes within a list of codes it has (we suggest informing all). It is required, it must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CNAE\"
cnaes[].indAtiv	This is the subsidiary activity indicator related to the national economic activity code declared in \"cnae.cnaesList.cnae\". It is required, it must be a string and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=indAtiv\"
countryTaxes[].crt	This is the federal tax regime for the headquarter subsidiary. It is required for the head office subsidiary and should not be informed for the other subsidiaries, as they will automatically inherit the federal tax regime informed for the head office subsidiary. It must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CRT\"
countryTaxes[].crtEspecial	This is the special federal tax regime for the headquarters subsidiary. It is optional for the head office subsidiary and should not be informed for the other subsidiaries, as they will automatically inherit the special federal tax regime informed for the head office subsidiary. It must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
countryTaxes[].startDate	This is the initial effective date of the federal tax regime registration of the parent subsidiary which is also inherited by all other subsidiaries. It is required, must be a string and the inserted content must be in UTC format.
countryTaxes[].endDate	This is the final effective date of the federal tax regime registration of the parent subsidiary which is also inherited by all other subsidiaries. It is optional, must be a string and the inserted content must be in UTC format.
stateTaxes[].taxPayer	This is the code that identifies the subsidiary's state taxpayer type. It is required, it must be a string and the informed content must be \"1\" (taxpayer with state registration), \"2\" (taxpayer without state registration) or \"9\" (non-taxpayer).
stateTaxes[].typeTaxPayer	This is the code that identifies the subsidiary as a \"Normal\" or \"Substitute\" taxpayer in the state. It is required, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"stateTaxes.UF\" and \"address.UF\" are the same and \"1\" (Substitute) whenever the value entered in \"stateTaxes.UF\" and \"address.UF \" are different.
stateTaxes[].stateDocument	This is the subsidiary's state taxpayer registration code. It is required to inform the registration code whenever the subsidiary has registration (\"stateTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"stateTaxes.taxPayer\"= 2) and must be a string .
stateTaxes[].UF	This is the abbreviation of the state where the Brazilian subsidiary has state registration. It is required, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
stateTaxes[].suframa	This is the SUFRAMA code for the Brazilian subsidiary. It is optional, must be a string, must be up to 9 in length and can only be declared for subsidiaries located in the states of AM, AC, RO, RR and PA.
stateTaxes[].crtEspecial	This is the subsidiary's special state taxation regime. It is optional, it must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
stateTaxes[].cscId	This is the taxpayer security code ID. It is optional in the registration of the subsidiary, but mandatory for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].cscToken	This is the taxpayer security code token. It is optional in the registration of the subsidiary, but mandatory for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].startDate	This is the initial effective date of the state tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is required, must be a string and the content entered must be in UTC format.
stateTaxes[].endDate	This is the final effective date of the state tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
cityTaxes[].taxPayer	This is the code that identifies the subsidiary's municipal taxpayer type. It is mandatory, it must be a string and the informed content must be \"1\" (taxpayer with municipal registration), \"2\" (taxpayer without municipal registration) or \"9\" (non-taxpayer).
cityTaxes[].typeTaxPayer	This is the code that identifies the subsidiary as a \"Normal\" or \"Substitute\" taxpayer in the municipal. It is required, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun\" are the same and \"1\" (Substitute) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun\" are different.
cityTaxes[].cityDocument	This is the subsidiary's municipal taxpayer registration code. It is required to inform the registration code whenever the subsidiary has registration (\"cityTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"cityTaxes.taxPayer\"= 2) and must be a string .
cityTaxes[].crtEspecial	This is the special municipal tax regime of the subsidiary. It is optional, must be an array of strings and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
cityTaxes[].UF	This is the abbreviation of the state where the Brazilian subsidiary has municipal registration. It is required, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
cityTaxes[].cMun	This is the code of the municipality where the Brazilian subsidiary has municipal registration. Is required, must be a string, must be 7 long, and the content entered must be taken from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
cityTaxes[].startDate	This is the initial effective date of the municipal tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is required, must be a string and the content entered must be in UTC format.
cityTaxes[].endDate	This is the final effective date of the municipal tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["subsidiaries"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"0bcb71ac-8348-4bec-9c61-9a6215b33081","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"required, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"required, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"required, string\",\n \"xLgr\": \"required, string\",\n \"nro\": \"required, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"required, string\",\n \"cMun\": \"required, string\",\n \"UF\": \"required, string\",\n \"cPais\": \"required, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"required, boolean\",\n \"indAtiv\": \"required, string\",\n \"cnae\": \"required, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"cMun\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subsidiary registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"c4806ae0-b598-48c7-b615-b5b26e9604d3","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"required, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"required, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"required, string\",\n \"xLgr\": \"required, string\",\n \"nro\": \"required, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"required, string\",\n \"cMun\": \"required, string\",\n \"UF\": \"required, string\",\n \"cPais\": \"required, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"required, boolean\",\n \"indAtiv\": \"required, string\",\n \"cnae\": \"required, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"cMun\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"federalDocument\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"fd7edf04-eed4-439b-a2d4-480afcc05233","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"required, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"required, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"required, string\",\n \"xLgr\": \"required, string\",\n \"nro\": \"required, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"required, string\",\n \"cMun\": \"required, string\",\n \"UF\": \"required, string\",\n \"cPais\": \"required, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"required, boolean\",\n \"indAtiv\": \"required, string\",\n \"cnae\": \"required, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"cMun\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"6066c43c-195d-48de-9291-78244dba7ab4","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"required, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"required, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"required, string\",\n \"xLgr\": \"required, string\",\n \"nro\": \"required, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"required, string\",\n \"cMun\": \"required, string\",\n \"UF\": \"required, string\",\n \"cPais\": \"required, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"required, boolean\",\n \"indAtiv\": \"required, string\",\n \"cnae\": \"required, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"cMun\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"a89e18a8-8067-4f22-aa64-8763667e384b","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"required, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"required, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"required, string\",\n \"xLgr\": \"required, string\",\n \"nro\": \"required, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"required, string\",\n \"cMun\": \"required, string\",\n \"UF\": \"required, string\",\n \"cPais\": \"required, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"required, boolean\",\n \"indAtiv\": \"required, string\",\n \"cnae\": \"required, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"cMun\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"companyId\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"},{"id":"da6022eb-7b0f-41b8-b74b-5ec6644f979e","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"required, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"required, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"required, string\",\n \"xLgr\": \"required, string\",\n \"nro\": \"required, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"required, string\",\n \"cMun\": \"required, string\",\n \"UF\": \"required, string\",\n \"cPais\": \"required, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"required, boolean\",\n \"indAtiv\": \"required, string\",\n \"cnae\": \"required, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"required, string\",\n \"taxPayer\": \"required, string\",\n \"typeTaxPayer\": \"required, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"required, string\",\n \"cMun\": \"required, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"federalDocument\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"ff801586-9e64-4ec6-bf7f-9313f91e7d4b"},{"name":"subsidiaries (list)","id":"2ca29b00-43da-4874-9e5e-226eed27ffdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q=","urlObject":{"protocol":"{{PROTOCOL}}","path":["subsidiaries"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled

\n","type":"text/plain"},"key":"orderBy","value":"federalDocument"},{"description":{"content":"

Filter by all subsidiaries from account

\n","type":"text/plain"},"key":"whitelabelId","value":"id"},{"description":{"content":"

Filter by all subsidiaries from account

\n","type":"text/plain"},"key":"accountId","value":"id"},{"description":{"content":"

Filter by all subsidiaries from company

\n","type":"text/plain"},"key":"companyId","value":"id"},{"description":{"content":"

Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"e1043ddd-2fc2-4ffe-b619-6598f3473e31","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["subsidiaries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"federalDocument","description":"Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":"id","description":"Filter by all subsidiaries from whitelabel"},{"key":"accountId","value":"id","description":"Filter by all subsidiaries from account"},{"key":"companyId","value":"id","description":"Filter by all subsidiaries from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"updatedAt\": {\n \"epoch\": 1717006881,\n \"formatted\": \"29/05/2024 - 15:21:21\"\n },\n \"identification\": {\n \"headquarters\": \"\",\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": \"\",\n \"codQualifPj\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"openingDate\": \"\",\n \"closingDate\": \"\",\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\"\n },\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"xMun\": \"\",\n \"cMun\": \"\",\n \"xUF\": \"\",\n \"cUF\": \"\",\n \"UF\": \"\",\n \"xPais\": \"\",\n \"cPais\": \"\",\n \"Pais\": \"\"\n },\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704078000,\n \"formatted\": \"01/01/2024 - 00:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735700399,\n \"formatted\": \"31/12/2024 - 23:59:59\"\n }\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"\",\n \"indAtiv\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cnae\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"suframa\": \"\",\n \"cscId\": \"\",\n \"cscToken\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"cMun\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n },\n \"headSubsidiary\": {\n \"id\": \"\",\n \"enabled\": true,\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": null,\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704088800,\n \"formatted\": \"01/01/2024 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735711199,\n \"formatted\": \"01/01/2025 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1735711200,\n \"formatted\": \"01/01/2025 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1767247199,\n \"formatted\": \"01/01/2026 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1767247200,\n \"formatted\": \"01/01/2026 - 03:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1735592400,\n \"formatted\": \"30/12/2024 - 18:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"createdAt\": {\n \"epoch\": 1741483497,\n \"formatted\": \"08/03/2025 - 22:24:57\"\n },\n \"updatedAt\": {\n \"epoch\": 1741801452,\n \"formatted\": \"12/03/2025 - 14:44:12\"\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"89479984-6384-494e-93a1-32d945247eb4","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["subsidiaries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"federalDocument","description":"Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":"id","description":"Filter by all subsidiaries from whitelabel"},{"key":"accountId","value":"id","description":"Filter by all subsidiaries from account"},{"key":"companyId","value":"id","description":"Filter by all subsidiaries from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"a54180cc-0aec-4ffd-9bb0-e424a1f98552","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["subsidiaries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"federalDocument","description":"Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":"id","description":"Filter by all subsidiaries from whitelabel"},{"key":"accountId","value":"id","description":"Filter by all subsidiaries from account"},{"key":"companyId","value":"id","description":"Filter by all subsidiaries from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"2ca29b00-43da-4874-9e5e-226eed27ffdd"},{"name":"subsidiaries (detail)","id":"0e3ffcfe-0647-4e7a-ac89-3c96e57f72be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["subsidiaries","{subsidiaryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"2ffc72e1-138e-4207-94bd-5321a0147237","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"updatedAt\": {\n \"epoch\": 1717006881,\n \"formatted\": \"29/05/2024 - 15:21:21\"\n },\n \"identification\": {\n \"headquarters\": \"\",\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": \"\",\n \"codQualifPj\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"openingDate\": \"\",\n \"closingDate\": \"\",\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\"\n },\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"xMun\": \"\",\n \"cMun\": \"\",\n \"xUF\": \"\",\n \"cUF\": \"\",\n \"UF\": \"\",\n \"xPais\": \"\",\n \"cPais\": \"\",\n \"Pais\": \"\"\n },\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704078000,\n \"formatted\": \"01/01/2024 - 00:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735700399,\n \"formatted\": \"31/12/2024 - 23:59:59\"\n }\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"\",\n \"indAtiv\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cnae\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"suframa\": \"\",\n \"cscId\": \"\",\n \"cscToken\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"cMun\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n },\n \"headSubsidiary\": {\n \"id\": \"\",\n \"enabled\": true,\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": null,\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704088800,\n \"formatted\": \"01/01/2024 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735711199,\n \"formatted\": \"01/01/2025 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1735711200,\n \"formatted\": \"01/01/2025 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1767247199,\n \"formatted\": \"01/01/2026 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1767247200,\n \"formatted\": \"01/01/2026 - 03:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1735592400,\n \"formatted\": \"30/12/2024 - 18:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"createdAt\": {\n \"epoch\": 1741483497,\n \"formatted\": \"08/03/2025 - 22:24:57\"\n },\n \"updatedAt\": {\n \"epoch\": 1741801452,\n \"formatted\": \"12/03/2025 - 14:44:12\"\n }\n }\n }\n }\n}"},{"id":"bec4933c-5ff1-4bd4-b3f3-54b4d4e37b38","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"698d5fa9-f612-44a6-810d-f6d29864034c","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"0f017c62-069c-4c0e-aedb-5accfed7963b","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"0e3ffcfe-0647-4e7a-ac89-3c96e57f72be"},{"name":"subsidiaries","id":"fdcc4ffd-9d74-48e1-8186-0a77c1e27a08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}","description":"

`Attribute`	`Details`
identification.headquarters	This attribute is used to indicate whether the subsidiary is a headquarter or not. It does not need to be informed in the registration because the first registered subsidiary must be the headquarter. It can only be informed in the update of a subsidiary that was not a headquarter and became one. It is optional and must be a boolean.
identification.federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is required and must be a string.
identification.xNome	This is the legal name by which your subsidiary is recognized. It is required, must be a string and can't exceed 60 characters.
identification.xFant	This is the personal name by which your subsidiary is recognized. It is required, must be a string and can't exceed 60 characters.
identification.nire	This is your state subsidiary's business registration identification number. It is optional, must be a string and can't exceed 11 characters.
identification.codQualif	This is the headquarters subsidiary qualification code. It is required for the headquarters and must not be informed for other subsidiaries, because they will automatically inherit the qualification code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=codQualif\"
identification.openingDate	This is the start date of the subsidiary's activities. It is optional, must be a string, must be in UTC format, and must be less than the end date of subsidiary activities.
identification.closingDate	This is the closing date of the subsidiary's activities. It is optional, it must be a string, it must be in UTC format and it must be greater than the start date of the subsidiary activities.
identification.sitEspecial	This is the special status code for the headquarters subsidiary. It is required for the headquarter and should not be informed for the other subsidiaries, as they will automatically inherit the code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=sitEspecial\"
identification.specialSituationDate	This is the date of the special situation registered in the parent subsidiary. It is only required for the parent subsidiary that has “sitSpecial” other than “0”. It should not be entered in any other situation. It must be a string and the content must be in UTC format.
identification.email	This is the subsidiary's contact email address. It is optional, must be a string and can't exceed 60 characters.
identification.fone	This is the subsidiary's contact phone. It is optional, must be a string and can't exceed 30 characters.
identification.website	This is the website address of the subsidiary. It is optional, must be a string and can't exceed 60 characters.
address.cep	This is the postal address code (CEP) of the subsidiary established in Brazil. It is required, must be a string and must be of length 8.
address.xLgr	This is the subsidiary's address. It is required, it must be a string and can't exceed 60 characters.
address.nro	This is the subsidiary address number. It is mandatory, it must be a string and can't exceed 60 characters.
address.xCpl	This is the subsidiary address complement. It is optional, it must be a string and can't exceed 60 characters.
address.xBairro	This is the neighborhood of the subsidiary's address. It is required, it must be a string and can't exceed 60 characters.
address.cMun	This is the municipality code of the subsidiary in Brazil. It is required, it must be a string, it must have a length of 7 and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
address.UF	This is the abbreviation of the state of the subsidiary in Brazil. It is required, it must be a string, it must have length 2 and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
address.cPais	This is the acronym of the country of the subsidiary. It is required, it must be a string, it must be in ISO 3166-1 alpha-2 format (ex Brasil: \"1058\") and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=GLOBAL&sortKey=COUNTRIES\"
legalNatures[].natJur	This is the legal nature code of the headquarters subsidiary. It is required for the headquarters and should not be informed for the other subsidiaries, as they will automatically inherit the qualification code entered for the headquarters. It must be a string and the specified content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=natJur\"
legalNatures[].startDate	This is the initial effective date of the legal nature record of the parent subsidiary which is also inherited by all other subsidiaries. It is required, must be a string and the content entered must be in UTC format.
legalNatures[].endDate	This is the final effective date of the legal nature record of the parent subsidiary which is also inherited by all other subsidiaries. It is optional, must be a string and the content entered must be in UTC format.
cnaes[].main	This is the indication that the declared economic activity is the main one. It is required and must be a boolean.
cnaes[].cnae	This is one of the subsidiary's economic activity codes within a list of codes it has (we suggest informing all). It is required, it must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CNAE\"
cnaes[].indAtiv	This is the subsidiary activity indicator related to the national economic activity code declared in \"cnae.cnaesList.cnae\". It is required, it must be a string and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=indAtiv\"
countryTaxes[].crt	This is the federal tax regime for the headquarter subsidiary. It is required for the head office subsidiary and should not be informed for the other subsidiaries, as they will automatically inherit the federal tax regime informed for the head office subsidiary. It must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CRT\"
countryTaxes[].crtEspecial	This is the special federal tax regime for the headquarters subsidiary. It is optional for the head office subsidiary and should not be informed for the other subsidiaries, as they will automatically inherit the special federal tax regime informed for the head office subsidiary. It must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
countryTaxes[].startDate	This is the initial effective date of the federal tax regime registration of the parent subsidiary which is also inherited by all other subsidiaries. It is required, must be a string and the inserted content must be in UTC format.
countryTaxes[].endDate	This is the final effective date of the federal tax regime registration of the parent subsidiary which is also inherited by all other subsidiaries. It is optional, must be a string and the inserted content must be in UTC format.
stateTaxes[].taxPayer	This is the code that identifies the subsidiary's state taxpayer type. It is required, it must be a string and the informed content must be \"1\" (taxpayer with state registration), \"2\" (taxpayer without state registration) or \"9\" (non-taxpayer).
stateTaxes[].typeTaxPayer	This is the code that identifies the subsidiary as a \"Normal\" or \"Substitute\" taxpayer in the state. It is required, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"stateTaxes.UF\" and \"address.UF\" are the same and \"1\" (Substitute) whenever the value entered in \"stateTaxes.UF\" and \"address.UF \" are different.
stateTaxes[].stateDocument	This is the subsidiary's state taxpayer registration code. It is required to inform the registration code whenever the subsidiary has registration (\"stateTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"stateTaxes.taxPayer\"= 2) and must be a string .
stateTaxes[].UF	This is the abbreviation of the state where the Brazilian subsidiary has state registration. It is required, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
stateTaxes[].suframa	This is the SUFRAMA code for the Brazilian subsidiary. It is optional, must be a string, must be up to 9 in length and can only be declared for subsidiaries located in the states of AM, AC, RO, RR and PA.
stateTaxes[].crtEspecial	This is the subsidiary's special state taxation regime. It is optional, it must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
stateTaxes[].cscId	This is the taxpayer security code ID. It is optional in the registration of the subsidiary, but mandatory for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].cscToken	This is the taxpayer security code token. It is optional in the registration of the subsidiary, but mandatory for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].startDate	This is the initial effective date of the state tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is required, must be a string and the content entered must be in UTC format.
stateTaxes[].endDate	This is the final effective date of the state tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
cityTaxes[].taxPayer	This is the code that identifies the subsidiary's municipal taxpayer type. It is mandatory, it must be a string and the informed content must be \"1\" (taxpayer with municipal registration), \"2\" (taxpayer without municipal registration) or \"9\" (non-taxpayer).
cityTaxes[].typeTaxPayer	This is the code that identifies the subsidiary as a \"Normal\" or \"Substitute\" taxpayer in the municipal. It is required, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun\" are the same and \"1\" (Substitute) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun \" are different.
cityTaxes[].cityDocument	This is the subsidiary's municipal taxpayer registration code. It is required to inform the registration code whenever the subsidiary has registration (\"cityTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"cityTaxes.taxPayer\"= 2) and must be a string .
cityTaxes[].crtEspecial	This is the special municipal tax regime of the subsidiary. It is optional, must be an array of strings and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
cityTaxes[].UF	This is the abbreviation of the state where the Brazilian subsidiary has municipal registration. It is required, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
cityTaxes[].cMun	This is the code of the municipality where the Brazilian subsidiary has municipal registration. Is required, must be a string, must be 7 long, and the content entered must be taken from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
cityTaxes[].startDate	This is the initial effective date of the municipal tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is required, must be a string and the content entered must be in UTC format.
cityTaxes[].endDate	This is the final effective date of the municipal tax regime registration of the subsidiary itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
enabled	This information defines whether your subsidiary is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["subsidiaries","{subsidiaryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"37f93582-615d-4c52-a1ee-90f8ad24fd3c","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subsidiary updated successfully\"\n}"},{"id":"323278e5-7b24-47c1-a83c-597c2a6f6ff7","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"10bffe58-7a11-4663-82ad-99af3afd754d","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"3a28ae3f-8a51-4a8f-81c1-c7f56160641c","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"optional, string\",\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"fdcc4ffd-9d74-48e1-8186-0a77c1e27a08"},{"name":"subsidiaries","id":"3fe703d0-ac21-406c-b7b0-00357d2be8b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["subsidiaries","{subsidiaryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"d18b2663-b897-4f70-8907-8ab0b2f4206f","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subsidiary removed successfully\"\n}"},{"id":"393b7c4b-fbba-462c-821f-2c3593309b4a","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"e3d46eae-065f-4be1-99a1-3adc835e9381","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"689c6840-fc4b-4e39-9b90-2ba93df92ae2","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries/{subsidiaryId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"3fe703d0-ac21-406c-b7b0-00357d2be8b8"}],"id":"7a538df8-d352-4ab6-bdb6-2ec784dad365","description":"

Users can register subsidiaries in a previously selected company. The subsidiary is the final entity within a company. It is in the subsidiary of a company that all commercial operations and, consequently, tax and accounting operations are effectively carried out. The registration and maintenance of the data of a subsidiary is one of the most important steps of the platform and must be carried out with great care and attention. A subsidiary unit within a company will be given by its complete federal document, which must have the same root numbers as the federalDocument registered in the company. In Brazil, for example, the federalDocument of a company (legal entity) is its complete CNPJ (CNPJ: 00.000.000/0000-00) consisting of 14 digits and the federalDocument of a person (natural person) is their complete CPF (CPF: 000.000.000-11) consisting of 11 digits.

\n","_postman_id":"7a538df8-d352-4ab6-bdb6-2ec784dad365"},{"name":"participants","item":[{"name":"participants","id":"5603ee59-59c7-43e3-93f6-10e64c1d6617","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants","description":"

`Attribute`	`Details`
companyId	This is the companyId where your participant will be registered. It is required, must be a string and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
identification.federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is required and must be a string.
identification.xNome	This is the legal name by which your participant is recognized. It is required, must be a string and can't exceed 60 characters.
identification.xFant	This is the personal name by which your participant is recognized. It is optional, must be a string and can't exceed 60 characters.
identification.nire	This is your state participants business registration identification number. It is optional, must be a string and can't exceed 11 characters.
identification.codQualif	This is the headquarters participant qualification code. It is optional for the headquarters and must not be informed for other participants, because they will automatically inherit the qualification code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=codQualif\"
identification.openingDate	This is the start date of the participants activities. It is optional, must be a string, must be in UTC format, and must be less than the end date of participant activities.
identification.closingDate	This is the closing date of the participants activities. It is optional, it must be a string, it must be in UTC format and it must be greater than the start date of the participant activities.
identification.sitEspecial	This is the special status code for the headquarters participant. It is optional for the headquarter and should not be informed for the other participants, as they will automatically inherit the code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=sitEspecial\"
identification.specialSituationDate	This is the date of the special situation registered in the parent participant. It is only required for the parent participant that has “sitSpecial” other than “0”. It should not be entered in any other situation. It must be a string and the content must be in UTC format.
identification.email	This is the participants contact email address. It is optional, must be a string and can't exceed 60 characters.
identification.fone	This is the participants contact phone. It is optional, must be a string and can't exceed 30 characters.
identification.website	This is the website address of the participant. It is optional, must be a string and can't exceed 60 characters.
address.cep	This is the postal address code (CEP) of the participant established in Brazil. It is optional, must be a string and must be of length 8.
address.xLgr	This is the participants address. It is optional, it must be a string and can't exceed 60 characters.
address.nro	This is the participant address number. It is optional, it must be a string and can't exceed 60 characters.
address.xCpl	This is the participant address complement. It is optional, it must be a string and can't exceed 60 characters.
address.xBairro	This is the neighborhood of the participants address. It is optional, it must be a string and can't exceed 60 characters.
address.cMun	This is the municipality code of the participant in Brazil. It is optional, it must be a string, it must have a length of 7 and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
address.UF	This is the abbreviation of the state of the participant in Brazil. It is optional, it must be a string, it must have length 2 and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
address.cPais	This is the acronym of the country of the participant. It is optional, it must be a string, it must be in ISO 3166-1 alpha-2 format (ex Brasil: \"1058\") and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=GLOBAL&sortKey=COUNTRIES\"
legalNatures[].natJur	This is the legal nature code of the headquarters participant. It is optional, it must be a string and the specified content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=natJur\"
legalNatures[].startDate	This is the initial effective date of the legal nature record of the parent participant which is also inherited by all other participants. It is optional, must be a string and the content entered must be in UTC format.
legalNatures[].endDate	This is the final effective date of the legal nature record of the parent participant which is also inherited by all other participants. It is optional, must be a string and the content entered must be in UTC format.
cnaes[].main	This is the indication that the declared economic activity is the main one. It is optional and must be a boolean.
cnaes[].cnae	This is one of the participants economic activity codes within a list of codes it has (we suggest informing all). It is optional, it must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CNAE\"
cnaes[].indAtiv	This is the participant activity indicator related to the national economic activity code declared in \"cnae.cnaesList.cnae\". It is optional, it must be a string and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=indAtiv\"
countryTaxes[].crt	This is the federal tax regime for the headquarter participant. It is optional, it must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CRT\"
countryTaxes[].crtEspecial	This is the special federal tax regime for the headquarters participant. It is optional, it must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
countryTaxes[].startDate	This is the initial effective date of the federal tax regime registration of the parent participant which is also inherited by all other participants. It is optional, must be a string and the inserted content must be in UTC format.
countryTaxes[].endDate	This is the final effective date of the federal tax regime registration of the parent participant which is also inherited by all other participants. It is optional, must be a string and the inserted content must be in UTC format.
stateTaxes[].taxPayer	This is the code that identifies the participants state taxpayer type. It is optional, it must be a string and the informed content must be \"1\" (taxpayer with state registration), \"2\" (taxpayer without state registration) or \"9\" (non-taxpayer).
stateTaxes[].typeTaxPayer	This is the code that identifies the participant as a \"Normal\" or \"Substitute\" taxpayer in the state. It is optional, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"stateTaxes.UF\" and \"address.UF\" are the same and \"1\" (Substitute) whenever the value entered in \"stateTaxes.UF\" and \"address.UF \" are different.
stateTaxes[].stateDocument	This is the participants state taxpayer registration code. It is optional to inform the registration code whenever the subsidiary has registration (\"stateTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"stateTaxes.taxPayer\"= 2) and must be a string .
stateTaxes[].UF	This is the abbreviation of the state where the Brazilian participant has state registration. It is optional, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
stateTaxes[].suframa	This is the SUFRAMA code for the Brazilian participant. It is optional, must be a string, must be up to 9 in length and can only be declared for participants located in the states of AM, AC, RO, RR and PA.
stateTaxes[].crtEspecial	This is the participants special state taxation regime. It is optional, it must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
stateTaxes[].cscId	This is the taxpayer security code ID. It is optional in the registration of the participant, but optional for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].cscToken	This is the taxpayer security code token. It is optional in the registration of the participant, but mandatory for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].startDate	This is the initial effective date of the state tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
stateTaxes[].endDate	This is the final effective date of the state tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
cityTaxes[].taxPayer	This is the code that identifies the participants municipal taxpayer type. It is optional, it must be a string and the informed content must be \"1\" (taxpayer with municipal registration), \"2\" (taxpayer without municipal registration) or \"9\" (non-taxpayer).
cityTaxes[].typeTaxPayer	This is the code that identifies the participant as a \"Normal\" or \"Substitute\" taxpayer in the municipal. It is optional, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun\" are the same and \"1\" (Substitute) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun\" are different.
cityTaxes[].cityDocument	This is the participants municipal taxpayer registration code. It is optional to inform the registration code whenever the subsidiary has registration (\"cityTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"cityTaxes.taxPayer\"= 2) and must be a string .
cityTaxes[].crtEspecial	This is the special municipal tax regime of the participant. It is optional, must be an array of strings and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
cityTaxes[].UF	This is the abbreviation of the state where the Brazilian participant has municipal registration. It is optional, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
cityTaxes[].cMun	This is the code of the municipality where the Brazilian participant has municipal registration. Is optional, must be a string, must be 7 long, and the content entered must be taken from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
cityTaxes[].startDate	This is the initial effective date of the municipal tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
cityTaxes[].endDate	This is the final effective date of the municipal tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["participants"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"1afd96c1-46ed-42eb-ac8e-81a10a1761a6","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Participant registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"e528e3a6-1464-428c-8d29-338162b1afb8","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"federalDocument\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"b3ca3a9b-cdc5-47ff-9ac8-4b846a4ec820","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"189beb47-be70-48dd-84c8-1c7bb4366e90","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ed9975d8-1eac-4856-8fe2-c64038f8dd37","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"companyId\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"},{"id":"e9c46def-f069-469f-80b8-cef6d8fb0916","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"identification\": {\n \"headquarters\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"xNome\": \"required, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"federalDocument\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"5603ee59-59c7-43e3-93f6-10e64c1d6617"},{"name":"participants (list)","id":"b5f642a7-c2c1-4223-8098-6ae5ecf9150f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q=","urlObject":{"protocol":"{{PROTOCOL}}","path":["participants"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled

\n","type":"text/plain"},"key":"orderBy","value":"federalDocument"},{"description":{"content":"

Filter by all participants from account

\n","type":"text/plain"},"key":"whitelabelId","value":"id"},{"description":{"content":"

Filter by all participants from account

\n","type":"text/plain"},"key":"accountId","value":"id"},{"description":{"content":"

Filter by all participants from company

\n","type":"text/plain"},"key":"companyId","value":"id"},{"description":{"content":"

Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"6f62f958-dc2e-4ae8-9851-4863d1aa32bf","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["subsidiaries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"federalDocument","description":"Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":"id","description":"Filter by all participants from whitelabel"},{"key":"accountId","value":"id","description":"Filter by all participants from account"},{"key":"companyId","value":"id","description":"Filter by all participants from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"updatedAt\": {\n \"epoch\": 1717006881,\n \"formatted\": \"29/05/2024 - 15:21:21\"\n },\n \"identification\": {\n \"headquarters\": \"\",\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": \"\",\n \"codQualifPj\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"openingDate\": \"\",\n \"closingDate\": \"\",\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\"\n },\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"xMun\": \"\",\n \"cMun\": \"\",\n \"xUF\": \"\",\n \"cUF\": \"\",\n \"UF\": \"\",\n \"xPais\": \"\",\n \"cPais\": \"\",\n \"Pais\": \"\"\n },\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704078000,\n \"formatted\": \"01/01/2024 - 00:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735700399,\n \"formatted\": \"31/12/2024 - 23:59:59\"\n }\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"\",\n \"indAtiv\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cnae\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"suframa\": \"\",\n \"cscId\": \"\",\n \"cscToken\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"cMun\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n },\n \"headSubsidiary\": {\n \"id\": \"\",\n \"enabled\": true,\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": null,\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704088800,\n \"formatted\": \"01/01/2024 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735711199,\n \"formatted\": \"01/01/2025 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1735711200,\n \"formatted\": \"01/01/2025 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1767247199,\n \"formatted\": \"01/01/2026 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1767247200,\n \"formatted\": \"01/01/2026 - 03:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1735592400,\n \"formatted\": \"30/12/2024 - 18:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"createdAt\": {\n \"epoch\": 1741483497,\n \"formatted\": \"08/03/2025 - 22:24:57\"\n },\n \"updatedAt\": {\n \"epoch\": 1741801452,\n \"formatted\": \"12/03/2025 - 14:44:12\"\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"de01fd00-72a4-4dea-adae-e961e5a09e81","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["subsidiaries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"federalDocument","description":"Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":"id","description":"Filter by all participants from whitelabel"},{"key":"accountId","value":"id","description":"Filter by all participants from account"},{"key":"companyId","value":"id","description":"Filter by all participants from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"73ba6e25-422e-4f48-84bc-f10fb2c8ffec","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/subsidiaries?page=1&limit=50&sort=asc&orderBy=federalDocument&whitelabelId=id&accountId=id&companyId=id&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["subsidiaries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"federalDocument","description":"Order by: id, xNome, federalDocument, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":"id","description":"Filter by all participants from whitelabel"},{"key":"accountId","value":"id","description":"Filter by all participants from account"},{"key":"companyId","value":"id","description":"Filter by all participants from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"b5f642a7-c2c1-4223-8098-6ae5ecf9150f"},{"name":"participants (detail)","id":"370f0013-5b2e-4b15-9c31-7d9f47e5fffa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["participants","{participantId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"68bb839f-64fe-4aa2-a326-62d0dab53def","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"updatedAt\": {\n \"epoch\": 1717006881,\n \"formatted\": \"29/05/2024 - 15:21:21\"\n },\n \"identification\": {\n \"headquarters\": \"\",\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": \"\",\n \"codQualifPj\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"openingDate\": \"\",\n \"closingDate\": \"\",\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\"\n },\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"xMun\": \"\",\n \"cMun\": \"\",\n \"xUF\": \"\",\n \"cUF\": \"\",\n \"UF\": \"\",\n \"xPais\": \"\",\n \"cPais\": \"\",\n \"Pais\": \"\"\n },\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704078000,\n \"formatted\": \"01/01/2024 - 00:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735700399,\n \"formatted\": \"31/12/2024 - 23:59:59\"\n }\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"\",\n \"indAtiv\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cnae\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"suframa\": \"\",\n \"cscId\": \"\",\n \"cscToken\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"\",\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"UF\": \"\",\n \"cMun\": \"\",\n \"startDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"endDate\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n }\n }\n ],\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n },\n \"headSubsidiary\": {\n \"id\": \"\",\n \"enabled\": true,\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"sitEspecial\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"specialSituationDate\": null,\n \"legalNatures\": [\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1704088800,\n \"formatted\": \"01/01/2024 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1735711199,\n \"formatted\": \"01/01/2025 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1735711200,\n \"formatted\": \"01/01/2025 - 03:00:00\"\n },\n \"endDate\": {\n \"epoch\": 1767247199,\n \"formatted\": \"01/01/2026 - 02:59:59\"\n }\n },\n {\n \"code\": \"\",\n \"description\": \"\",\n \"startDate\": {\n \"epoch\": 1767247200,\n \"formatted\": \"01/01/2026 - 03:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n },\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"startDate\": {\n \"epoch\": 1735592400,\n \"formatted\": \"30/12/2024 - 18:00:00\"\n },\n \"endDate\": null\n }\n ],\n \"createdAt\": {\n \"epoch\": 1741483497,\n \"formatted\": \"08/03/2025 - 22:24:57\"\n },\n \"updatedAt\": {\n \"epoch\": 1741801452,\n \"formatted\": \"12/03/2025 - 14:44:12\"\n }\n }\n }\n }\n}"},{"id":"fd0f0c36-d212-4935-a3c8-c2c35de9a432","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"e2e4f164-ef40-4cb4-85c1-cf73c5a38869","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"6a673840-c132-4b65-9784-75148e064c0a","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"370f0013-5b2e-4b15-9c31-7d9f47e5fffa"},{"name":"participants","id":"d2e7bb65-c5ec-43a1-9d07-4ec5e9d302c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}","description":"

`Attribute`	`Details`
identification.xNome	This is the legal name by which your participant is recognized. It is required, must be a string and can't exceed 60 characters.
identification.xFant	This is the personal name by which your participant is recognized. It is optional, must be a string and can't exceed 60 characters.
identification.nire	This is your state participants business registration identification number. It is optional, must be a string and can't exceed 11 characters.
identification.codQualif	This is the headquarters participant qualification code. It is optional for the headquarters and must not be informed for other participants, because they will automatically inherit the qualification code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=codQualif\"
identification.openingDate	This is the start date of the participants activities. It is optional, must be a string, must be in UTC format, and must be less than the end date of participant activities.
identification.closingDate	This is the closing date of the participants activities. It is optional, it must be a string, it must be in UTC format and it must be greater than the start date of the participant activities.
identification.sitEspecial	This is the special status code for the headquarters participant. It is optional for the headquarter and should not be informed for the other participants, as they will automatically inherit the code entered for the headquarter. It must be a string and the content informed must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=sitEspecial\"
identification.specialSituationDate	This is the date of the special situation registered in the parent participant. It is only required for the parent participant that has “sitSpecial” other than “0”. It should not be entered in any other situation. It must be a string and the content must be in UTC format.
identification.email	This is the participants contact email address. It is optional, must be a string and can't exceed 60 characters.
identification.fone	This is the participants contact phone. It is optional, must be a string and can't exceed 30 characters.
identification.website	This is the website address of the participant. It is optional, must be a string and can't exceed 60 characters.
address.cep	This is the postal address code (CEP) of the participant established in Brazil. It is optional, must be a string and must be of length 8.
address.xLgr	This is the participants address. It is optional, it must be a string and can't exceed 60 characters.
address.nro	This is the participant address number. It is optional, it must be a string and can't exceed 60 characters.
address.xCpl	This is the participant address complement. It is optional, it must be a string and can't exceed 60 characters.
address.xBairro	This is the neighborhood of the participants address. It is optional, it must be a string and can't exceed 60 characters.
address.cMun	This is the municipality code of the participant in Brazil. It is optional, it must be a string, it must have a length of 7 and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
address.UF	This is the abbreviation of the state of the participant in Brazil. It is optional, it must be a string, it must have length 2 and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
address.cPais	This is the acronym of the country of the participant. It is optional, it must be a string, it must be in ISO 3166-1 alpha-2 format (ex Brasil: \"1058\") and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=GLOBAL&sortKey=COUNTRIES\"
legalNatures[].natJur	This is the legal nature code of the headquarters participant. It is optional, it must be a string and the specified content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=natJur\"
legalNatures[].startDate	This is the initial effective date of the legal nature record of the parent participant which is also inherited by all other participants. It is optional, must be a string and the content entered must be in UTC format.
legalNatures[].endDate	This is the final effective date of the legal nature record of the parent participant which is also inherited by all other participants. It is optional, must be a string and the content entered must be in UTC format.
cnaes[].main	This is the indication that the declared economic activity is the main one. It is optional and must be a boolean.
cnaes[].cnae	This is one of the participants economic activity codes within a list of codes it has (we suggest informing all). It is optional, it must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CNAE\"
cnaes[].indAtiv	This is the participant activity indicator related to the national economic activity code declared in \"cnae.cnaesList.cnae\". It is optional, it must be a string and the content entered must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=indAtiv\"
countryTaxes[].crt	This is the federal tax regime for the headquarter participant. It is optional, it must be a string and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CRT\"
countryTaxes[].crtEspecial	This is the special federal tax regime for the headquarters participant. It is optional, it must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
countryTaxes[].startDate	This is the initial effective date of the federal tax regime registration of the parent participant which is also inherited by all other participants. It is optional, must be a string and the inserted content must be in UTC format.
countryTaxes[].endDate	This is the final effective date of the federal tax regime registration of the parent participant which is also inherited by all other participants. It is optional, must be a string and the inserted content must be in UTC format.
stateTaxes[].taxPayer	This is the code that identifies the participants state taxpayer type. It is optional, it must be a string and the informed content must be \"1\" (taxpayer with state registration), \"2\" (taxpayer without state registration) or \"9\" (non-taxpayer).
stateTaxes[].typeTaxPayer	This is the code that identifies the participant as a \"Normal\" or \"Substitute\" taxpayer in the state. It is optional, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"stateTaxes.UF\" and \"address.UF\" are the same and \"1\" (Substitute) whenever the value entered in \"stateTaxes.UF\" and \"address.UF \" are different.
stateTaxes[].stateDocument	This is the participants state taxpayer registration code. It is optional to inform the registration code whenever the subsidiary has registration (\"stateTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"stateTaxes.taxPayer\"= 2) and must be a string .
stateTaxes[].UF	This is the abbreviation of the state where the Brazilian participant has state registration. It is optional, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
stateTaxes[].suframa	This is the SUFRAMA code for the Brazilian participant. It is optional, must be a string, must be up to 9 in length and can only be declared for participants located in the states of AM, AC, RO, RR and PA.
stateTaxes[].crtEspecial	This is the participants special state taxation regime. It is optional, it must be a string array and the informed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
stateTaxes[].cscId	This is the taxpayer security code ID. It is optional in the registration of the participant, but optional for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].cscToken	This is the taxpayer security code token. It is optional in the registration of the participant, but mandatory for issuing electronic invoices to the final consumer (NFC-e, model 65). It must be a string and can't exceed 60 characters.
stateTaxes[].startDate	This is the initial effective date of the state tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
stateTaxes[].endDate	This is the final effective date of the state tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
cityTaxes[].taxPayer	This is the code that identifies the participants municipal taxpayer type. It is optional, it must be a string and the informed content must be \"1\" (taxpayer with municipal registration), \"2\" (taxpayer without municipal registration) or \"9\" (non-taxpayer).
cityTaxes[].typeTaxPayer	This is the code that identifies the participant as a \"Normal\" or \"Substitute\" taxpayer in the municipal. It is optional, it must be a string and the entered content must be \"0\" (Normal) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun\" are the same and \"1\" (Substitute) whenever the value entered in \"cityTaxes.cMun\" and \"address.cMun\" are different.
cityTaxes[].cityDocument	This is the participants municipal taxpayer registration code. It is optional to inform the registration code whenever the subsidiary has registration (\"cityTaxes.taxPayer\"= 1) and the literal \"ISENTO\" whenever the subsidiary was exempt from registration (\"cityTaxes.taxPayer\"= 2) and must be a string .
cityTaxes[].crtEspecial	This is the special municipal tax regime of the participant. It is optional, must be an array of strings and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=crtEspecial\"
cityTaxes[].UF	This is the abbreviation of the state where the Brazilian participant has municipal registration. It is optional, it must be a string, it must be 2 in length, and the typed content must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
cityTaxes[].cMun	This is the code of the municipality where the Brazilian participant has municipal registration. Is optional, must be a string, must be 7 long, and the content entered must be taken from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
cityTaxes[].startDate	This is the initial effective date of the municipal tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.
cityTaxes[].endDate	This is the final effective date of the municipal tax regime registration of the participant itself (whether it is a parent company or a branch). It is optional, must be a string and the content entered must be in UTC format.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["participants","{participantId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"de913801-d5a6-41f3-a52e-b584cb04c604","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Participant updated successfully\"\n}"},{"id":"95523df3-6b38-46b2-995a-6478037bc64d","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b4bef2d5-f056-4437-9ea0-93235d114567","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"4761be4a-54f5-478a-bbcf-6f34cd1a265b","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"identification\": {\n \"xNome\": \"optional, string\",\n \"xFant\": \"optional, string\",\n \"nire\": \"optional, string\",\n \"codQualif\": \"optional, string\",\n \"openingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"closingDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"sitEspecial\": \"optional, string\",\n \"specialSituationDate\": \"conditional, string and UTC format - YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"website\": \"optional, string\"\n },\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"legalNatures\": [\n {\n \"natJur\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cnaes\": [\n {\n \"main\": \"optional, boolean\",\n \"indAtiv\": \"optional, string\",\n \"cnae\": \"optional, string\"\n }\n ],\n \"countryTaxes\": [\n {\n \"crt\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"stateTaxes\": [\n {\n \"stateDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"suframa\": \"conditional, string\",\n \"cscId\": \"optinal, string\",\n \"cscToken\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"cityTaxes\": [\n {\n \"cityDocument\": \"optional, string\",\n \"taxPayer\": \"optional, string\",\n \"typeTaxPayer\": \"optional, string\",\n \"crtEspecial\": [\n \"optional, string\"\n ],\n \"UF\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"startDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"d2e7bb65-c5ec-43a1-9d07-4ec5e9d302c1"},{"name":"participants","id":"44299fa2-d45f-41cd-8a9a-4387441c05c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["participants","{participantId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"57163044-04dc-4bd5-98e7-db55272dd40d","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Particpant removed successfully\"\n}"},{"id":"7d3b8654-d04b-43bf-b403-eb056084d709","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"d2147457-c7e0-4495-9351-37f7b1cd821a","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"52a8c3ea-4501-4e96-8b1d-d5f23bed26c6","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/participants/{participantId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"44299fa2-d45f-41cd-8a9a-4387441c05c4"}],"id":"dd60edee-61fa-4138-9773-d7cbf80740b9","description":"

Users can register participants (clients and suppliers) in a previously selected company. Registration and maintenance of a participant's data are important steps on the platform and must be carried out with great care and attention. A participant will be identified by their complete federal document. In Brazil, for example, a company's (legal entity's) federal document is its complete CNPJ (CNPJ: 00.000.000/0000-00), composed of 14 digits, and an individual's federal document is their complete CPF (CPF: 000.000.000-11), composed of 11 digits.

\n","_postman_id":"dd60edee-61fa-4138-9773-d7cbf80740b9"},{"name":"signatories","item":[{"name":"signatories","id":"096c5732-3604-407c-9b0a-c5ee8bc27f59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories","description":"

`Attribute`	`Details`
companyId	This is the companyId where your signatory will be registered. It is required, must be a string and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is mandatory and must be a string.
legalRepresentative	This information defines whether your signatory is authorized as a legal representative of the company in public records. It is required, must be a boolean and the content provided must be true or false.
name	This is the legal name by which your signatory is recognized. It is required, must be a string and can't exceed 60 characters.
codQualif	This is the signatory qualification code. It is mandatory, must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=codQualif\"
crc	This is the registration code of the signatory qualified as an accountant. It is only mandatory that the \"codQualif\" informed is equal to 900. It must be a string and cannot exceed 128 characters.
numSeqCrc	This is the sequential registration code of the signatory registered as an accountant. It is only mandatory that the \"codQualif\" entered is equal to 900. It must be a string and cannot exceed 128 characters.
ufCrc	This is the acronym of the federation unit where the signatory is registered as an accountant. It is only mandatory that the \"codQualif\" entered is equal to 900. It must be a string, must have length 2 and the inserted content can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
dtCrc	This is the date the signatory was registered as an accountant. The only requirement is that the \"codQualif\" entered is 900. It must be a string and the content entered must be in UTC format.
cvm	This is the registration code of the signatory authorized as an auditor at the Brazilian Securities and Exchange Commission (CVM). The only requirement is that the \"codQualif\" entered be equal to 111. It must be a string and cannot exceed 128 characters.
email	This is the signatory contact email address. It is optional, must be a string and can't exceed 60 characters.
fone	This is the signatory contact phone. It is optional, must be a string and can't exceed 30 characters.
address.cep	This is the postal address code (CEP) of the signatory established in Brazil. It is optional, must be a string and must be of length 8.
address.xLgr	This is the signatory address. It is optional, it must be a string and can't exceed 60 characters.
address.nro	This is the signatory address number. It is optional, it must be a string and can't exceed 60 characters.
address.xCpl	This is the signatory address complement. It is optional, it must be a string and can't exceed 60 characters.
address.xBairro	This is the neighborhood of the signatory address. It is optional, it must be a string and can't exceed 60 characters.
address.cMun	This is the municipality code of the signatory in Brazil. It is optional, it must be a string, it must have a length of 7 and the informed content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
address.UF	This is the abbreviation of the state of the signatory in Brazil. It is optional, it must be a string, it must have length 2 and the content entered can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
address.cPais	This is the acronym of the country of the signatory. It is optional, it must be a string, it must be in ISO 3166-1 alpha-2 format (ex Brasil: \"1058\") and the informed content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=GLOBAL&sortKey=COUNTRIES\"
certificate.fileBase64	This is your digital signatory certificate, optional for registering signatories, but optional for using some services on the platform, such as signing accounting records. It must be a string and the content provided must be in base64.
certificate.password	This is the access password for the digital certificate, mandatory if \"certificateBase64\" is informed. It must be a string.
certificate.filename	This is the name of the digital certificate file, required if \"certificateBase64\" is entered. It must be a string.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["signatories"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"f50eba9f-b09f-45e9-9f19-bcd84342f8d7","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Signatory registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"9aaf5878-522c-41ce-94d8-de6b1e98b228","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"name\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"de5aaf53-75ae-4d24-a44c-3fcae6380c0a","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"a28520e7-bc59-421e-8dcc-ed730b667a98","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"8ace98e5-5889-44fa-8ef3-c93dde1f73a0","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"companyId\",\n \"messages\": [\n \"Not Found\"\n ]\n }\n ]\n}"},{"id":"a24d08fd-ec1f-4607-861a-5e5abd04734d","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"federalDocument\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"096c5732-3604-407c-9b0a-c5ee8bc27f59"},{"name":"signatories (list)","id":"26247a94-0421-47c4-83ce-e7020fdeedbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories?page=1&limit=50&accountId=&companyId&q&sort=asc","urlObject":{"protocol":"{{PROTOCOL}}","path":["signatories"],"host":["{{API_DOMAIN}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"accountId","value":""},{"key":"companyId","value":null},{"key":"q","value":null},{"key":"sort","value":"asc"}],"variable":[]}},"response":[{"id":"8419deca-4ca1-4d21-82bd-00cfeec71b46","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories?page=1&limit=50&sort=asc&orderBy&whitelabelId&accountId=&companyId&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["signatories"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, xNome, federalDocument, accountId, companyId, createdAt, updatedAt or enabled","type":"text"},{"key":"whitelabelId","value":null,"description":"Filter by all signatories from whitelabel","type":"text"},{"key":"accountId","value":"","description":"Filter by all signatories from account"},{"key":"companyId","value":null,"description":"Filter by all signatories from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"c1c8b729-057e-4b81-a24c-2472d7681e83\",\n \"remoteId\": null,\n \"federalDocument\": \"\",\n \"legalRepresentative\": \"\",\n \"name\": \"\",\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crc\": \"\",\n \"numSeqCrc\": \"\",\n \"ufCrc\": \"\",\n \"dtCrc\": \"\",\n \"cvm\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"cPais\": \"\"\n },\n \"certificate\": {\n \"filename\": \"\",\n \"downloadLink\": \"\",\n \"expirationAt\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n }\n },\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1710781642,\n \"formatted\": \"18/03/2024 - 14:07:22\"\n },\n \"updatedAt\": {\n \"epoch\": 1710783274,\n \"formatted\": \"18/03/2024 - 14:34:34\"\n },\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"6bda0e73-6074-4192-ad68-79e2a640f362","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories?page=1&limit=50&sort=asc&orderBy&whitelabelId&accountId=&companyId&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["signatories"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, xNome, federalDocument, accountId, companyId, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":null,"description":"Filter by all signatories from whitelabel"},{"key":"accountId","value":"","description":"Filter by all signatories from account"},{"key":"companyId","value":null,"description":"Filter by all signatories from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"381e16f3-c40d-49ab-969c-44afa7563c5b","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories?page=1&limit=50&sort=asc&orderBy&whitelabelId&accountId=&companyId&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["signatories"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, xNome, federalDocument, accountId, companyId, createdAt, updatedAt or enabled"},{"key":"whitelabelId","value":null,"description":"Filter by all signatories from whitelabel"},{"key":"accountId","value":"","description":"Filter by all signatories from account"},{"key":"companyId","value":null,"description":"Filter by all signatories from company"},{"key":"q","value":null,"description":"Search by: id, remoteId, accountId, companyId, federalDocument, xNome or xFant"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"26247a94-0421-47c4-83ce-e7020fdeedbf"},{"name":"signatories (detail)","id":"daa52950-a04a-48a1-a3c2-5b13bbad9ffa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["signatories","{signatoryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"a534def9-d21b-4646-865a-e97bd2be4da6","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"c1c8b729-057e-4b81-a24c-2472d7681e83\",\n \"remoteId\": null,\n \"federalDocument\": \"\",\n \"legalRepresentative\": \"\",\n \"name\": \"\",\n \"codQualif\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"crc\": \"\",\n \"numSeqCrc\": \"\",\n \"ufCrc\": \"\",\n \"dtCrc\": \"\",\n \"cvm\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"cPais\": \"\"\n },\n \"certificate\": {\n \"filename\": \"\",\n \"downloadLink\": \"\",\n \"expirationAt\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n }\n },\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1710781642,\n \"formatted\": \"18/03/2024 - 14:07:22\"\n },\n \"updatedAt\": {\n \"epoch\": 1710783274,\n \"formatted\": \"18/03/2024 - 14:34:34\"\n },\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n}"},{"id":"c3030f96-905c-4b03-b1bc-360751a06c86","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"87e78c4a-c1a8-485a-9193-79e6f5ddd6ac","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"db083a25-3843-4cee-a915-58ad646c6c0d","name":"410 Gone","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"daa52950-a04a-48a1-a3c2-5b13bbad9ffa"},{"name":"signatories","id":"bb94ee49-1a1b-4bd0-9a47-3fc64636a46a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}","description":"

`Attribute`	`Details`
companyId	This is the companyId where your signatory will be registered. It is required, must be a string and the entered content must be a valid UUID.
federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is mandatory and must be a string.
legalRepresentative	This information defines whether your signatory is authorized as a legal representative of the company in public records. It is required, must be a boolean and the content provided must be true or false.
name	This is the legal name by which your signatory is recognized. It is required, must be a string and can't exceed 60 characters.
codQualif	This is the signatory qualification code. It is mandatory, must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=codQualif\"
crc	This is the registration code of the signatory qualified as an accountant. It is only mandatory that the \"codQualif\" informed is equal to 900. It must be a string and cannot exceed 128 characters.
numSeqCrc	This is the sequential registration code of the signatory registered as an accountant. It is only mandatory that the \"codQualif\" entered is equal to 900. It must be a string and cannot exceed 128 characters.
ufCrc	This is the acronym of the federation unit where the signatory is registered as an accountant. It is only mandatory that the \"codQualif\" entered is equal to 900. It must be a string, must have length 2 and the inserted content can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
dtCrc	This is the date the signatory was registered as an accountant. The only requirement is that the \"codQualif\" entered is 900. It must be a string and the content entered must be in UTC format.
cvm	This is the registration code of the signatory authorized as an auditor at the Brazilian Securities and Exchange Commission (CVM). The only requirement is that the \"codQualif\" entered be equal to 111. It must be a string and cannot exceed 128 characters.
email	This is the signatory contact email address. It is optional, must be a string and can't exceed 60 characters.
fone	This is the signatory contact phone. It is optional, must be a string and can't exceed 30 characters.
address.cep	This is the postal address code (CEP) of the signatory established in Brazil. It is optional, must be a string and must be of length 8.
address.xLgr	This is the signatory address. It is optional, it must be a string and can't exceed 60 characters.
address.nro	This is the signatory address number. It is optional, it must be a string and can't exceed 60 characters.
address.xCpl	This is the signatory address complement. It is optional, it must be a string and can't exceed 60 characters.
address.xBairro	This is the neighborhood of the signatory address. It is optional, it must be a string and can't exceed 60 characters.
address.cMun	This is the municipality code of the signatory in Brazil. It is optional, it must be a string, it must have a length of 7 and the informed content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=CITIES&sortKey=BRA or state abbreviation\"
address.UF	This is the abbreviation of the state of the signatory in Brazil. It is optional, it must be a string, it must have length 2 and the content entered can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=STATES&sortKey=BRA\"
address.cPais	This is the acronym of the country of the signatory. It is optional, it must be a string, it must be in ISO 3166-1 alpha-2 format (ex Brasil: \"1058\") and the informed content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=GLOBAL&sortKey=COUNTRIES\"
certificate.fileBase64	This is your digital signatory certificate, optional for registering signatories, but optional for using some services on the platform, such as signing accounting records. It must be a string and the content provided must be in base64.
certificate.password	This is the access password for the digital certificate, mandatory if \"certificateBase64\" is informed. It must be a string.
certificate.filename	This is the name of the digital certificate file, required if \"certificateBase64\" is entered. It must be a string.
enabled	This information defines whether resource is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["signatories","{signatoryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"07d7a3f3-71d3-4956-bee3-16023c04ad73","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-homologation.omnitax.ai/signatories/{signatoryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Signatory updated successfully\"\n}"},{"id":"e6bf44c1-81f2-4a16-afbc-638f248a54b3","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"528c2848-5503-4bc5-aa64-f6c7f227cdb7","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\"\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"cbdefe4c-f7c7-48bb-823f-03daeed7016a","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enabled\": \"optional, boolean\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificate\": {\n \"fileBase64\": \"optional, string(base64)\",\n \"filename\": \"optional, string\",\n \"password\": \"optional, string\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"bb94ee49-1a1b-4bd0-9a47-3fc64636a46a"},{"name":"signatories","id":"6c1d9392-1df3-41b1-a615-8f8d8c62df70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["signatories","{signatoryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"7a9092d8-415d-44f9-8bfc-40a6aca082d4","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Signatory removed successfully\"\n}"},{"id":"70679f62-cd96-42f0-8aae-4a8ca5dc6d7a","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b0b3c916-d775-472b-870f-8cbe18d8c59c","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"9c4a19aa-142d-4928-bdd9-729e047fac51","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/{signatoryId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"6c1d9392-1df3-41b1-a615-8f8d8c62df70"},{"name":"signatories/company","id":"87439eb2-a268-4dd6-a42c-99a245ee322b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/company/{companyId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["signatories","company","{companyId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"dce516b1-a490-4042-a9ad-aad1d4a5e3bf","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/company/{companyId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Signatories removed successfully\"\n}"},{"id":"4170dcd0-0d8e-47ae-af98-364b17b67b47","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/company/{companyId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"ed9f5375-df14-4baf-a32f-9d3099c36954","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/company/{companyId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"7f1ba130-34dd-470b-8288-89732e5a0d91","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/signatories/company/{companyId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"87439eb2-a268-4dd6-a42c-99a245ee322b"}],"id":"c13564fa-b2c9-4b69-a90d-a12e2496108d","description":"

Users can register signatories for a previously selected company. By registering signatories for your company, it becomes possible to sign company accounting records.

\n","_postman_id":"c13564fa-b2c9-4b69-a90d-a12e2496108d"}],"id":"e82e9894-3cb1-4d3c-b5f4-4b8dc894b604","description":"

This is a set of endpoints that allows users to manage essential basic records for consuming the services offered by the platform. The main entities are structured hierarchically as follows:

whitelabel
\n
whitelabel.accounts
\n
whitelabel.accounts.companies
\n
whitelabel.accounts.companies.subsidiaries
\n

All other basic records and services offered through the platform depend on these 4 main contexts. For example:

To register an account, it is necessary to access a previously registered domain, which can be a proprietary domain or a partner's domain.
\n
To use the Rules Engine module, you need to have a registered account.
\n
To use the invoice module, you need to have a company-type entity and its respective subsidiaries registered.
\n

\n","_postman_id":"e82e9894-3cb1-4d3c-b5f4-4b8dc894b604"},{"name":"teams","item":[{"name":"profiles","item":[{"name":"profiles/resources (list)","id":"5546a589-cd66-4d8b-ae94-02c355688aef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","description":"

The first step is to consult the list of resources that the Omnitax platform provides and their respective actions. It is based on this list of resources and their actions that you can create customized access profiles.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute Details

label This is the name of the resource available for use in the Omnitax platform. The resource can be understood as an entity or module. Some non-exhaustive examples of resource names made available through the Omnitax platform: Whitelabel, Account, Company, Subsidiary, Invoice, Rules Engine.

actions This is the name of the action allowed on the selected resource. Some non-exhaustive examples of names of actions allowed by resources:

Resource: Whitelabel
Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token

Resource: Account
Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token

Resource: Company
Actions: Register, List, Detail, Edit, Remove

Resource: Subsidiary
Actions: Register, List, Detail, Edit, Remove

Resource: Invoice
Actions: Issue, Correct, Cancel, List, Detail, Distribution, Disablement

Resource: Rules Engine
Actions: Register, List, Detail, Edit or Remove Rule Base; Register, List, Detail, Edit or Remove Rules from a Base; Apply Scenarios to Rules; Import and export Rule bases.

`Attribute`	`Details`
label	This is the name of the resource available for use in the Omnitax platform. The resource can be understood as an entity or module. Some non-exhaustive examples of resource names made available through the Omnitax platform: Whitelabel, Account, Company, Subsidiary, Invoice, Rules Engine.
actions	This is the name of the action allowed on the selected resource. Some non-exhaustive examples of names of actions allowed by resources: Resource: Whitelabel Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token Resource: Account Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token Resource: Company Actions: Register, List, Detail, Edit, Remove Resource: Subsidiary Actions: Register, List, Detail, Edit, Remove Resource: Invoice Actions: Issue, Correct, Cancel, List, Detail, Distribution, Disablement Resource: Rules Engine Actions: Register, List, Detail, Edit or Remove Rule Base; Register, List, Detail, Edit or Remove Rules from a Base; Apply Scenarios to Rules; Import and export Rule bases.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["profiles","resources"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

required, number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

required, number, limited 50 per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

optional, \"asc\" or \"desc\"

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

optional, per \"label\"

\n","type":"text/plain"},"key":"orderBy","value":"label"},{"description":{"content":"

required, per \"whitelabel\", \"account\", \"company\", \"subsidiary\"

\n","type":"text/plain"},"key":"entityType","value":"account"}],"variable":[]}},"response":[{"id":"c8d97868-5e55-4736-8eae-4de04ebd4560","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["profiles","resources"],"query":[{"key":"page","value":"1","description":"required, number"},{"key":"limit","value":"50","description":"required, number, limited 50 per page"},{"key":"sort","value":"asc","description":"optional, \"asc\" or \"desc\""},{"key":"orderBy","value":"label","description":"optional, per \"label\""},{"key":"entityType","value":"account","description":"required, per \"whitelabel\", \"account\", \"company\", \"subsidiary\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"3c413918-b4e3-49a6-9d41-980bb7b678ed","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificateBase64\": \"optional, string\",\n \"certificateFilename\": \"optional, string\",\n \"certificatePassword\": \"optional, string\",\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["profiles","resources"],"query":[{"key":"page","value":"1","description":"required, number"},{"key":"limit","value":"50","description":"required, number, limited 50 per page"},{"key":"sort","value":"asc","description":"optional, \"asc\" or \"desc\""},{"key":"orderBy","value":"label","description":"optional, per \"label\""},{"key":"entityType","value":"account","description":"required, per \"whitelabel\", \"account\", \"company\", \"subsidiary\""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"f16ba286-a165-4d49-a1ce-4b628e39edaf","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"federalDocument\": \"required, string\",\n \"legalRepresentative\": \"required, boolean\",\n \"name\": \"required, string\",\n \"codQualif\": \"required, string\",\n \"crc\": \"optional, string\",\n \"numSeqCrc\": \"optional, string\",\n \"ufCrc\": \"optional, string\",\n \"dtCrc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"cvm\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\",\n \"address\": {\n \"cep\": \"optional, string\",\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"cPais\": \"optional, string\"\n },\n \"certificateBase64\": \"optional, string\",\n \"certificateFilename\": \"optional, string\",\n \"certificatePassword\": \"optional, string\",\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["profiles","resources"],"query":[{"key":"page","value":"1","description":"required, number"},{"key":"limit","value":"50","description":"required, number, limited 50 per page"},{"key":"sort","value":"asc","description":"optional, \"asc\" or \"desc\""},{"key":"orderBy","value":"label","description":"optional, per \"label\""},{"key":"entityType","value":"account","description":"required, per \"whitelabel\", \"account\", \"company\", \"subsidiary\""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"5546a589-cd66-4d8b-ae94-02c355688aef"},{"name":"profiles","id":"82aef9b4-be12-4188-9a9f-ee29be586cf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles","description":"

The second step is to register a custom access profile, entering a name of your choice and defining which resources and actions within those resources your team members with this profile can perform. For example, you can create an access profile called \"operation\" and determine that members with this profile can register, list and detail companies and subsidiaries, but cannot edit or remove them. Perhaps this profile can also list and detail issued invoices, but cannot issue or cancel invoices.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the name of your preferred profile. It is required and must be a string with a maximum length of 60 characters.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
entity	This is the name of the entity where your profile will have powers of action. The Omnitax platform is hierarchically organized into 4 large entities, also known as \"contexts\": 1. Whitelabel 2. Whitelabel.Account 3. Whitelabel.Account.Company 4. Whitelabel.Account.Company.Subsidiary It is mandatory, it is a string and the only valid values are \"WHITELABEL\", \"ACCOUNT\", \"COMPANY\" or \"SUBSIDIARY\"
entities[]	These are the IDs of the entities of the type informed in the \"entity\" field. It is mandatory, it is a string array and must be a valid UUID.
resources[].label	This is the name of the resource available for use in the Omnitax platform. The resource can be understood as an entity or module. Some non-exhaustive examples of resource names made available by the Omnitax platform: Whitelabel, Account, Company, Subsidiary, Invoice, Rules Engine. It is also possible to create a profile that has access to all resources (current and future) made available via the Omnitax Platform by simply entering \"label\": \"ALL\", \"actions\": [ \"*\" ]. In this case, the profile will have absolute powers (all resources, current and future, and their respective actions)
resources[].actions[]	This is the name of the action allowed on the selected resource. Some non-exhaustive examples of names of actions allowed by resources will be listed below. It is also possible to create a profile that has access to all actions (current and future) of a resource made available by the Omnitax Platform, simply by typing, for example, \"label\": \"INVOICE\", \"actions\": [ \"\" ]. In this case, the profile will have absolute powers to execute all actions, current and future, of the invoice resource. Other examples: Resource: Whitelabel Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token Resource: Account Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token Resource: Company Actions: Register, List, Detail, Edit, Remove Resource: Subsidiary Actions: Register, List, Detail, Edit, Remove Resource: Invoice Actions: Issue, Correct, Cancel, List, Detail, Distribution, Disablement Resource: Rules Engine Actions*: Register, List, Detail, Edit or Remove Rule Base; Register, List, Detail, Edit or Remove Rules from a Base; Apply Scenarios to Rules; Import and export Rule bases.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["profiles"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"425009b5-068f-4ee5-893c-d36123fa43e3","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"label\": \"required, string\",\n \"entity\": \"required, string\",\n \"entities\": [\n \"required, string\"\n ],\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Profile registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"48d7349b-d916-4fde-ad9c-215bd4aecda0","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"label\": \"required, string\",\n \"entity\": \"required, string\",\n \"entities\": [\n \"required, string\"\n ],\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"label\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"ec9380da-3725-4071-a945-a5f22db45c99","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"label\": \"required, string\",\n \"entity\": \"required, string\",\n \"entities\": [\n \"required, string\"\n ],\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"aeb17d90-7c92-4f03-91d4-e07f0ee162d0","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"label\": \"required, string\",\n \"entity\": \"required, string\",\n \"entities\": [\n \"required, string\"\n ],\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"aa1d18eb-49b7-4c7b-967e-c7d5be87ddee","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"label\": \"required, string\",\n \"entity\": \"required, string\",\n \"entities\": [\n \"required, string\"\n ],\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"label\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"82aef9b4-be12-4188-9a9f-ee29be586cf2"},{"name":"profiles (list)","id":"e08b3b31-f881-4900-9d89-253d97e3eaf5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles?page=1&limit=50&sort=asc&orderBy=label","urlObject":{"protocol":"{{PROTOCOL}}","path":["profiles"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

required, number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

required, number, limited 50 per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

optional, \"asc\" or \"desc\"

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

optional, per \"id\", \"label\", \"createdAt\", \"updatedAt\"

\n","type":"text/plain"},"key":"orderBy","value":"label"}],"variable":[]}},"response":[{"id":"d777a309-16a4-439b-8891-1bd5b023cda6","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles?page=1&limit=50&sort=asc&orderBy=label","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["profiles"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"label","description":"Order by: id, label, createdAt, updatedAt"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1738862880,\n \"formatted\": \"06/02/2025 - 14:28:00\"\n },\n \"updatedAt\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"label\": \"\",\n \"entity\": \"\",\n \"entities\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"570b061f-71b6-44cd-a0c9-1df9672b8fdb","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles?page=1&limit=50&sort=asc&orderBy=label","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["profiles"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"label","description":"Order by: id, label, createdAt, updatedAt"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"c056736a-cd67-460f-8446-bac446eebe90","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles?page=1&limit=50&sort=asc&orderBy=label","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["profiles"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"label","description":"Order by: id, label, createdAt, updatedAt"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"e08b3b31-f881-4900-9d89-253d97e3eaf5"},{"name":"profiles (detail)","id":"deb3c515-5c73-4c7b-8dd1-c9a7050730aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["profiles","{profileId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"defcbb8b-e54e-4476-9514-98526a6658ae","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1738862880,\n \"formatted\": \"06/02/2025 - 14:28:00\"\n },\n \"updatedAt\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"label\": \"\",\n \"entity\": \"\",\n \"entities\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ]\n }\n}"},{"id":"cd71b97f-ea15-4d3f-8c7a-8a405fdb354b","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"a262d763-cdf1-4b15-a952-85b8f14334a1","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"0b15b23d-98df-4c3f-8e99-43c863bc0c71","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"deb3c515-5c73-4c7b-8dd1-c9a7050730aa"},{"name":"profiles","id":"1e3b7a48-695e-4189-8034-bac65ce906d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the name of your preferred profile. It is required and must be a string with a maximum length of 60 characters.
entity	This is the name of the entity where your profile will have powers of action. The Omnitax platform is hierarchically organized into 4 large entities, also known as \"contexts\": 1. Whitelabel 2. Whitelabel.Account 3. Whitelabel.Account.Company 4. Whitelabel.Account.Company.Subsidiary It is mandatory, it is a string and the only valid values are \"WHITELABEL\", \"ACCOUNT\", \"COMPANY\" or \"SUBSIDIARY\"
entities[]	These are the IDs of the entities of the type informed in the \"entity\" field. It is mandatory, it is a string array and must be a valid UUID.
resources[].label	This is the name of the resource available for use in the Omnitax platform. The resource can be understood as an entity or module. Some non-exhaustive examples of resource names made available by the Omnitax platform: Whitelabel, Account, Company, Subsidiary, Invoice, Rules Engine. It is also possible to create a profile that has access to all resources (current and future) made available via the Omnitax Platform by simply entering \"label\": \"ALL\", \"actions\": [ \"*\" ]. In this case, the profile will have absolute powers (all resources, current and future, and their respective actions)
resources[].actions[]	This is the name of the action allowed on the selected resource. Some non-exhaustive examples of names of actions allowed by resources are listed below. It is also possible to create a profile that has access to all actions (current and future) of a resource made available by the Omnitax Platform, simply by typing, for example, \"label\": \"INVOICE\", \"actions\": [ \"\" ]. In this case, the profile will have absolute powers to execute all actions, current and future, of the invoice resource. Other examples: Resource: Whitelabel Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token Resource: Account Actions: Register, List, Detail, Edit, Remove, Generate Token, Enable Token Resource: Company Actions: Register, List, Detail, Edit, Remove Resource: Subsidiary Actions: Register, List, Detail, Edit, Remove Resource: Invoice Actions: Issue, Correct, Cancel, List, Detail, Distribution, Disablement Resource: Rules Engine Actions*: Register, List, Detail, Edit or Remove Rule Base; Register, List, Detail, Edit or Remove Rules from a Base; Apply Scenarios to Rules; Import and export Rule bases.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["profiles","{profileId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"dbf3f25e-0843-474d-a6a1-1c2f6a8fc5d5","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\": \"optional, string\",\n \"entity\": \"optional, string\",\n \"entities\": [\n \"optional, string\"\n ],\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Profile updated successfully\"\n}"},{"id":"9fdb5f15-cd63-48d2-af1b-bd96e1ecdc25","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\": \"optional, string\",\n \"entity\": \"optional, string\",\n \"entities\": [\n \"optional, string\"\n ],\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"65de93af-4266-4bdb-bb28-b2ca00113756","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\": \"optional, string\",\n \"entity\": \"optional, string\",\n \"entities\": [\n \"optional, string\"\n ],\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"b7613660-62b7-460e-b96e-cb0fa9d2175c","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"label\": \"optional, string\",\n \"entity\": \"optional, string\",\n \"entities\": [\n \"optional, string\"\n ],\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"1e3b7a48-695e-4189-8034-bac65ce906d2"},{"name":"profiles","id":"5b1ddbfb-ba46-46b2-b744-75413e8d368b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["profiles","{profileId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"51a0bcf4-6a1e-43cf-a490-264f0a6c857c","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Profile removed successfully\"\n}"},{"id":"19754b14-f44e-4d51-8951-5fbc3f9577b0","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"ed633fc6-56c9-45d9-961f-07fc246a1e7b","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"4d735a99-56b7-468d-93a9-016db3634f2c","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"5b1ddbfb-ba46-46b2-b744-75413e8d368b"}],"id":"add53fb1-9875-4c04-9e4a-177955d11181","description":"

The purpose of this set of endpoints is to allow the management of customizable access profiles so that team members can be invited with pre-defined access permissions.

\n","_postman_id":"add53fb1-9875-4c04-9e4a-177955d11181"},{"name":"users","item":[{"name":"users/invite","id":"c3f9dd0e-83b8-4c2a-9578-72e6ae389524","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
invites[].emails[]	These are the emails of your team members who will be invited with the access profile informed in the \"profileId\" field. It is mandatory, it is a string array and must be a valid email.
invites[].profileId	This is the registered profile ID that your team member user will have access to. It is required, is a string, and must be a valid UUID.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["users","invite"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"a97a5c9f-0ade-473a-b0ea-c7586f1da104","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invites\": [\n {\n \"emails\": [\n \"required, string\"\n ],\n \"profileId\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"An email was sent with instructions\"\n}"},{"id":"bcdb522d-ce59-433a-816f-368bb35203e8","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invites\": [\n {\n \"emails\": [\n \"required, string\"\n ],\n \"profileId\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"profileId\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"4d5d4264-fbf7-4229-b078-0469cd02ba52","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invites\": [\n {\n \"emails\": [\n \"required, string\"\n ],\n \"profileId\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"d7c3c4c1-7e71-45b7-ba49-a2c7141967d0","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invites\": [\n {\n \"emails\": [\n \"required, string\"\n ],\n \"profileId\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ddafc64d-ad44-445f-9cea-01d73bd6f370","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"invites\": [\n {\n \"emails\": [\n \"required, string\"\n ],\n \"profileId\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"profileId\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"c3f9dd0e-83b8-4c2a-9578-72e6ae389524"},{"name":"users/invite/confirmation","id":"47b5c235-5d7e-49e2-9c71-7adb64515c49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite/confirmation","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
token	This is the token ID emailed to your invited team member user. It is required, is a string, and must be a valid token.
password	This is the preferred password for your guest team member. It is required, is a string, and cannot exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["users","invite","confirmation"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"eb950074-4a6d-4695-8839-6a7645540bad","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite/confirmation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invite confirmation was succeeded\"\n}"},{"id":"640bd095-7724-4347-8d6f-d531e8207137","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite/confirmation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"password\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"b7679908-9ad0-42a4-a4a2-5775df8fa994","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite/confirmation"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"9a9e1a99-58da-414b-bf3e-d11c86adf1d5","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite/confirmation"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"7f7d50b5-ed01-4141-8279-64e0519f9ec0","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite/confirmation"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"token\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"},{"id":"a908d885-b5da-49e5-a0cc-a17626744221","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/invite/confirmation"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"token\",\n \"messages\": [\n \"Confirmation already made\"\n ]\n }\n ]\n}"}],"_postman_id":"47b5c235-5d7e-49e2-9c71-7adb64515c49"},{"name":"users (list)","id":"0ef1b489-0165-4bb5-8274-2a4c122eb83b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users?page=1&limit=50&sort=asc&orderBy=email&accountId=id&companyId=id&subsidiaryId=id","urlObject":{"protocol":"{{PROTOCOL}}","path":["users"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, email, name, document, role, registerSource, createdAt, updatedAt

\n","type":"text/plain"},"key":"orderBy","value":"email"},{"description":{"content":"

Filter by all subsidiaries from account

\n","type":"text/plain"},"key":"accountId","value":"id"},{"description":{"content":"

Filter by all subsidiaries from company

\n","type":"text/plain"},"key":"companyId","value":"id"},{"description":{"content":"

Filter by all subsidiaries from subsidiary

\n","type":"text/plain"},"key":"subsidiaryId","value":"id"}],"variable":[]}},"response":[{"id":"0e335e3c-5979-4688-8d14-45999b50daa7","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/users?page=1&limit=50&sort=asc&orderBy=email&accountId=id&companyId=id&subsidiaryId=id","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["users"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"email","description":"Order by: id, email, name, document, role, registerSource, createdAt, updatedAt"},{"key":"accountId","value":"id","description":"Filter by all subsidiaries from account"},{"key":"companyId","value":"id","description":"Filter by all subsidiaries from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all subsidiaries from subsidiary"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1739304727,\n \"formatted\": \"11/02/2025 - 17:12:07\"\n },\n \"updatedAt\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"name\": \"\",\n \"email\": \"\",\n \"registerSource\": \"\",\n \"enabled\": true,\n \"document\": \"\",\n \"role\": \"\",\n \"pictureUrl\": \"\",\n \"profiles\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1738862880,\n \"formatted\": \"06/02/2025 - 14:28:00\"\n },\n \"updatedAt\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"label\": \"\",\n \"entity\": \"\",\n \"entities\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"lastLogin\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"lastLoginSource\": \"\"\n }\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"e82029bf-9e16-4893-a27e-514cae7d0edd","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/users?page=1&limit=50&sort=asc&orderBy=email&accountId=id&companyId=id&subsidiaryId=id","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["users"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"email","description":"Order by: id, email, name, document, role, registerSource, createdAt, updatedAt"},{"key":"accountId","value":"id","description":"Filter by all subsidiaries from account"},{"key":"companyId","value":"id","description":"Filter by all subsidiaries from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all subsidiaries from subsidiary"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"173c9302-9c44-47f3-9660-79eafad1bf7d","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/users?page=1&limit=50&sort=asc&orderBy=email&accountId=id&companyId=id&subsidiaryId=id","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["users"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"email","description":"Order by: id, email, name, document, role, registerSource, createdAt, updatedAt"},{"key":"accountId","value":"id","description":"Filter by all subsidiaries from account"},{"key":"companyId","value":"id","description":"Filter by all subsidiaries from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all subsidiaries from subsidiary"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"0ef1b489-0165-4bb5-8274-2a4c122eb83b"},{"name":"users (detail)","id":"8672b2e5-30b8-4bdf-9ce6-51f9d2d250e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["users","{userId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"4e47b25a-5984-42c8-8691-c7a2f019130c","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1739304727,\n \"formatted\": \"11/02/2025 - 17:12:07\"\n },\n \"updatedAt\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"name\": \"\",\n \"email\": \"\",\n \"registerSource\": \"\",\n \"enabled\": true,\n \"document\": \"\",\n \"role\": \"\",\n \"pictureUrl\": \"\",\n \"profiles\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1738862880,\n \"formatted\": \"06/02/2025 - 14:28:00\"\n },\n \"updatedAt\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"label\": \"\",\n \"entity\": \"\",\n \"entities\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"lastLogin\": {\n \"epoch\": 1739546072,\n \"formatted\": \"14/02/2025 - 12:14:32\"\n },\n \"lastLoginSource\": \"\"\n }\n ]\n }\n}"},{"id":"c150030c-c9b2-48b2-a7f8-b0e855acae92","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"521ee11d-def9-4f5e-8211-8f5d4fe4fce1","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ae5223da-0117-45a2-afc0-93443dc7e086","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/profiles/{profileId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"8672b2e5-30b8-4bdf-9ce6-51f9d2d250e4"},{"name":"users","id":"4df8bdfa-42ee-450a-ab84-1efa1792ef4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
name	This is the username. It is optional, is a string and cannot exceed 256 characters.
document	This is the user's identification document. It is optional, is a string and cannot exceed 30 characters.
role	This is the role or function that the user performs professionally. It is optional, is a string and cannot exceed 20 characters.
password	This is the user's current preferred password. It is optional, is a string, and cannot exceed 256 characters.
newPassword	This is the user's new preferred password. It is optional, is a string and cannot exceed 256 characters.
pictureBase64	This is the user image. It is optional, it is a string with base64 content.
enabled	This information defines whether resource is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["users","{userId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"da991de5-1c87-472d-ac55-964be5ff7161","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"document\": \"optional, string\",\n \"role\": \"optional, string\",\n \"password\": \"optional, string\",\n \"newPassword\": \"optional, string\",\n \"pictureBase64\": \"optional, string\",\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User updated successfully\"\n}"},{"id":"b4be66bc-73f9-4875-b48e-f07955e1435c","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"document\": \"optional, string\",\n \"role\": \"optional, string\",\n \"password\": \"optional, string\",\n \"newPassword\": \"optional, string\",\n \"pictureBase64\": \"optional, string\",\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"8db0a7b4-376f-4600-8619-f8e17ee55aa9","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"document\": \"optional, string\",\n \"role\": \"optional, string\",\n \"password\": \"optional, string\",\n \"newPassword\": \"optional, string\",\n \"pictureBase64\": \"optional, string\",\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ac19c4d7-a632-4331-8701-11368f7be325","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"optional, string\",\n \"document\": \"optional, string\",\n \"role\": \"optional, string\",\n \"password\": \"optional, string\",\n \"newPassword\": \"optional, string\",\n \"pictureBase64\": \"optional, string\",\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"4df8bdfa-42ee-450a-ab84-1efa1792ef4f"},{"name":"users","id":"3f99a957-3de5-485e-a0ca-4306738ad80a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["users","{userId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"facf5ee4-db2d-4ebc-b152-b876303a82b8","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User removed successfully\"\n}"},{"id":"433b119f-2632-4a23-ba9f-bfc637dd197c","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"82946ff5-876d-4764-bc98-85c47a65d0a0","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ed73f7e6-d84d-4038-a384-c49102e148ae","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"3f99a957-3de5-485e-a0ca-4306738ad80a"},{"name":"users/profiles","id":"f61a18f3-ba4d-4968-ab38-e40e757f84f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}/profiles/{id}","urlObject":{"protocol":"{{PROTOCOL}}","path":["users","{userId}","profiles","{id}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"e7b22e67-ecef-4537-a346-01fbce980e5c","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}/profiles/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"User profile removed successfully\"\n}"},{"id":"4d7f760f-0620-430b-aa8e-38e0f75acf57","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}/profiles/{id}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"6e368606-bb67-4481-b456-5f28b7589a09","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}/profiles/{id}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"812b39a5-88bf-4c35-aef0-768928adafab","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/users/{userId}/profiles/{id}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"f61a18f3-ba4d-4968-ab38-e40e757f84f4"}],"id":"5eeeaa69-2ce9-479d-b510-35cdbc0b931b","description":"

The third step is to invite users by associating them with the previously registered access profile. A user can have multiple access profiles, but can only use one at a time. This means that if the user has multiple profiles, when logging in, the platform will authenticate them with the last profile used and they can choose which profile they want to operate with from then on.

\n","_postman_id":"5eeeaa69-2ce9-479d-b510-35cdbc0b931b"},{"name":"authentication","item":[{"name":"auth/login","id":"03735b87-5a44-40ef-b773-b36d5c50fa37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login","description":"

When inviting a user, you can also define that they can only use the platform if they are authenticated (oAuth), regardless of whether they use the platform via the user's application or directly via the API.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
email	This is the role or function that the user performs professionally. It is optional, it is a string and must be a valid email.
password	This is the preferred password for your guest team member. It is required, is a string, and cannot exceed 256 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["auth","login"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"7147d020-8ecd-4dab-ae90-c8112f8e83da","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"session\": {\n \"id\": \"\",\n \"token\": \"\",\n \"startedAt\": {\n \"epoch\": 1739455315,\n \"formatted\": \"13/02/2025 - 11:01:55\"\n },\n \"expires\": {\n \"epoch\": 1739541715,\n \"formatted\": \"14/02/2025 - 11:01:55\"\n }\n },\n \"user\": {\n \"name\": \"\",\n \"email\": \"\",\n \"enabled\": true,\n \"isMember\": true,\n \"document\": \"\",\n \"role\": null,\n \"pictureUrl\": null,\n \"profiles\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"entity\": \"\",\n \"entities\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"whitelabel\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 1,\n \"usersTotal\": 0\n },\n \"current\": true\n }\n ]\n },\n \"settings\": {\n \"whitelabelId\": \"\",\n \"slug\": \"\",\n \"name\": \"\",\n \"themeColor\": \"\",\n \"lightLogoUrl\": \"\",\n \"darkLogoUrl\": \"\",\n \"lightIconUrl\": \"\",\n \"darkIconUrl\": \"\",\n \"backgroundUrl\": \"\",\n \"linkTitle\": \"\",\n \"linkUrl\": null\n }\n }\n}"},{"id":"03d79c78-2713-4b09-98b7-1124def4c115","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"password\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"908d238f-5f98-4601-aa86-b461e1463417","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"1137cd17-7b63-4e3f-9811-3e813b685953","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"8ff6df39-f9aa-449a-a1dd-928431043885","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"email\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"}],"_postman_id":"03735b87-5a44-40ef-b773-b36d5c50fa37"},{"name":"auth/refresh-token","id":"3cbd24eb-704e-4700-b56a-8af1898cdbdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"profileId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login","description":"

When team member user are authenticated, they can change the current logged profile.

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
profileId	This is the registered profile ID that team member user have access to. It is optional, is a string, and must be a valid UUID.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["auth","login"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"e84f123b-fd1f-4c2d-a4cf-ef3b287fdab1","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"profileId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"session\": {\n \"id\": \"\",\n \"token\": \"\",\n \"startedAt\": {\n \"epoch\": 1739455315,\n \"formatted\": \"13/02/2025 - 11:01:55\"\n },\n \"expires\": {\n \"epoch\": 1739541715,\n \"formatted\": \"14/02/2025 - 11:01:55\"\n }\n },\n \"user\": {\n \"name\": \"\",\n \"email\": \"\",\n \"enabled\": true,\n \"isMember\": true,\n \"document\": \"\",\n \"role\": null,\n \"pictureUrl\": null,\n \"profiles\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"entity\": \"\",\n \"entities\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"whitelabel\": {\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 1,\n \"usersTotal\": 0\n },\n \"current\": true\n }\n ]\n },\n \"settings\": {\n \"whitelabelId\": \"\",\n \"slug\": \"\",\n \"name\": \"\",\n \"themeColor\": \"\",\n \"lightLogoUrl\": \"\",\n \"darkLogoUrl\": \"\",\n \"lightIconUrl\": \"\",\n \"darkIconUrl\": \"\",\n \"backgroundUrl\": \"\",\n \"linkTitle\": \"\",\n \"linkUrl\": null\n }\n }\n}"},{"id":"ce9e786a-cfd3-4484-8e22-74b59f78837e","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"password\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"6cc2229f-971b-46b6-925d-e804355bf95a","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"90b184e4-d888-4c3b-8fd5-43e618f9cc3c","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"5a5a7a45-552f-4dc7-818d-ee04d0452a76","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\",\n \"password\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/login"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"email\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"}],"_postman_id":"3cbd24eb-704e-4700-b56a-8af1898cdbdf"},{"name":"auth/recover-password","id":"d1e1574c-77e1-43b4-8a7f-2e5dca39a265","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
email	This is the user's email address for password recovery. It is required, is a string and must be a valid email address.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["auth","recover-password"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"23cc5ef5-85df-4601-a6fa-8cc5af15b1ee","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"An email was sent with instructions\"\n}"},{"id":"d1ed4773-9633-498a-967c-ff3d01fd3164","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"email\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"6f120c28-da2e-4caa-a731-4d1f298b064b","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"9cc266e1-a3c8-4cd7-9a70-49f472e83b8b","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"d1e1574c-77e1-43b4-8a7f-2e5dca39a265"},{"name":"auth/recover-password/confirmation","id":"9053dd7c-8cc5-45f7-b96b-beae66a5f290","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password/confirmation","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
token	This is the token ID emailed to your invited team member user. It is required, is a string, and must be a valid token.
newPassword	This is the preferred password for your guest team member. It is required, is a string, and cannot exceed 256 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["auth","recover-password","confirmation"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"a923531a-3e05-4ad9-be41-7fb2b09e39e1","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"newPassword\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password/confirmation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"New password registered with success\"\n}"},{"id":"8bd728bf-8e27-4d65-a143-0b5aab494d53","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"newPassword\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password/confirmation"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"newPassword\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"26cb5eae-6294-498c-a72c-eb8ebd10a966","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"newPassword\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password/confirmation"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"a504ce76-b0bc-459e-b717-58a459c6db0f","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"required, string\",\n \"newPassword\": \"required, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/recover-password/confirmation"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"9053dd7c-8cc5-45f7-b96b-beae66a5f290"},{"name":"auth/logout","id":"d142705f-5adf-4767-9a6b-b4d6af3b3759","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/logout","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
email	This is the email address of the user who will log out of the platform. It is mandatory, it is a string and must be a valid email address.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["auth","logout"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"d3065a9a-4074-4279-a337-07a3a249d2aa","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/logout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Ok\"\n}"},{"id":"d3f5776e-5099-4be8-9c7f-4c3a4f222aab","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/logout"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"c675316e-8491-411d-8593-418e6eeb5d88","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/logout"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"19388c27-ec43-4d5d-bd66-42b9b1f92348","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/logout"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not found\"\n}"},{"id":"52956d49-7c2b-41b6-aa20-e2f04dde17d9","name":"410 Gone","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/auth/logout"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"d142705f-5adf-4767-9a6b-b4d6af3b3759"}],"id":"c2cfaeb7-7172-4d4d-b774-ab44a2160013","_postman_id":"c2cfaeb7-7172-4d4d-b774-ab44a2160013","description":""}],"id":"5cd8b884-1a9a-48e5-9af0-6889ac8268e3","description":"

This is the set of endpoints that allows you to manage your team (users, their access profiles and their authentication process on the Omnitax platform).

\n","_postman_id":"5cd8b884-1a9a-48e5-9af0-6889ac8268e3"},{"name":"invoices","item":[{"name":"series","item":[{"name":"series","id":"bf8a8ec3-fc5c-4951-8971-5bd2937b07fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
subsidiaryIds	This is the list of subsidiaries ids that will have the series registered in exactly the same way in each of them. This is a way to batch register the same serie type in more than one subsidiary at the same time. It is mandatory. Must be an string array containing the valid UUID as a string preceded by the literal \"id\".
serieNumber	This is the unique invoice issuance serial number per subsidiary. It is mandatory and must be a string with values in the range 000 to 889 (if the subsidiary has a CNPJ and Model 55 or 65) or 00001 to 49999 (if the subsidiary has a CNPJ and Model 99).
lastUsedNumber	This is the last sequential number used in the series, considering that each series can generate sequential numbers in the range from 0 to 999,999,999 (if it is model 55 or 65) and between 0 and 999,999,999,999,999 (if it is model 99). It is optional, it must be a number with a length of 1 to 9 digits (if it is model 55 or 65) and 1 to 15 digits (if it is model 99) and the content entered cannot have been unused or used in another invoice issuance. The platform will automatically generate, based on the last number entered for the respective series, a document number for each invoice issuance request. Therefore, if the series is new, enter zero as the last number used. If it is not entered, the platform will automatically assign zero.
mod	This is the code of the tax document model that you want to issue in this series, considering the tax document models provided on the platform. It is required, it must be an string with length 2 and the informed content must be \"55\" (NF-e), \"65\" (NFC-e) and \"99\" (NFS-e).
tpEmis	This is the code for the type of issuance allowed in this series, considering the types of issuance available on the platform. It is mandatory, it must be an array of strings with length 1 and the content entered must be \"1\" (normal mode - online), \"6\" or \"7\" (online contingency mode) and \"9\" (offline contingency mode). It is mandatory, it must be a string and the content (1, 6, 7 or 9) must comply with the following rules: 1) It is forbidden to register \"tpEmis\" equal to 9 for \"mod\" equal to 55, as this document model does not allow this type of issuance. 2) It is forbidden to register \"tpEmis\" equal to 6 or 7 for \"mod\" equal to 65, as this document model does not allow this type of issuance. 3) It is forbidden to register \"tpEmis\" equal to 6 or 7 or 9 for \"mod\" equal to 99, as this document model does not allow this type of issuance.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["series"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"a9c3fbb1-0ded-4065-a160-cc6dcd22aae6","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"subsidiaryIds\": [\n \"required, string\"\n ],\n \"serieNumber\": \"required, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"required, string\",\n \"tpEmis\": [\n \"required, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Serie registered with success\",\n \"ids\": [\n \"f398be01-62c1-4248-93db-7d659ab97491\"\n ]\n}"},{"id":"60151ff4-417a-46be-85ce-5fe1204c5d05","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"subsidiaryIds\": [\n \"required, string\"\n ],\n \"serieNumber\": \"required, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"required, string\",\n \"tpEmis\": [\n \"required, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"serieNumber\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"5b146b60-fd17-4277-92e7-3c6de4f6bba1","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"subsidiaryIds\": [\n \"required, string\"\n ],\n \"serieNumber\": \"required, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"required, string\",\n \"tpEmis\": [\n \"required, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"24ed0ad7-11d1-4c5e-9508-7b0397ec5a62","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"subsidiaryIds\": [\n \"required, string\"\n ],\n \"serieNumber\": \"required, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"required, string\",\n \"tpEmis\": [\n \"required, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"00d37c62-f673-414f-85d0-0bfe2fadf4fe","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"subsidiaryIds\": [\n \"required, string\"\n ],\n \"serieNumber\": \"required, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"required, string\",\n \"tpEmis\": [\n \"required, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"companyId\",\n \"messages\": [\n \"Not Found\"\n ]\n }\n ]\n}"},{"id":"181bf4f4-9673-4c65-8281-ae5042df7d00","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"subsidiaryIds\": [\n \"required, string\"\n ],\n \"serieNumber\": \"required, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"required, string\",\n \"tpEmis\": [\n \"required, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"serieNumber\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"bf8a8ec3-fc5c-4951-8971-5bd2937b07fd"},{"name":"series (list)","id":"b4b36fdc-2b37-4416-ab00-c8e3b2b7179b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series?page=1&limit=50&sort=asc&orderBy=createdAt&accountId=id&companyId=id&subsidiaryId=id&serieNumbers=&tpEmis=&mod=&q=","urlObject":{"protocol":"{{PROTOCOL}}","path":["series"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of item per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: createdAt, updatedAt or enabled

\n","type":"text/plain"},"key":"orderBy","value":"createdAt"},{"description":{"content":"

Filter by all series from account

\n","type":"text/plain"},"key":"accountId","value":"id"},{"description":{"content":"

Filter by all series from company

\n","type":"text/plain"},"key":"companyId","value":"id"},{"description":{"content":"

Filter by all series from subsidiary

\n","type":"text/plain"},"key":"subsidiaryId","value":"id"},{"description":{"content":"

Filter by all series from serieNumber list (eg. 1,2,3)

\n","type":"text/plain"},"key":"serieNumbers","value":""},{"description":{"content":"

Filter by all series from tpEmis list (eg. 1,9)

\n","type":"text/plain"},"key":"tpEmis","value":""},{"description":{"content":"

Filter by all series from tpEmis list (eg. 55,65)

\n","type":"text/plain"},"key":"mod","value":""},{"description":{"content":"

Search by: id, remoteId, federalDocument or serieNumber

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"5f51938e-bc25-4f98-b529-e66e31cd7196","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/series?page=1&limit=50&sort=asc&orderBy=createdAt&accountId=id&companyId=id&subsidiaryId=id&serieNumbers=&tpEmis=&mod=&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["series"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: createdAt, updatedAt or enabled"},{"key":"accountId","value":"id","description":"Filter by all series from account"},{"key":"companyId","value":"id","description":"Filter by all series from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all series from subsidiary"},{"key":"serieNumbers","value":"","description":"Filter by all series from serieNumber list (eg. 1,2,3)"},{"key":"tpEmis","value":"","description":"Filter by all series from tpEmis list (eg. 1,9)"},{"key":"mod","value":"","description":"Filter by all series from tpEmis list (eg. 55,65)"},{"key":"q","value":"","description":"Search by: id, remoteId, federalDocument or serieNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"companyId\": \"\",\n \"subsidiaries\": [\n \"\"\n ],\n \"serieNumber\": \"\",\n \"lastUsedNumber\": \"\",\n \"mod\": \"\",\n \"tpEmis\": [\n \"\"\n ],\n \"transactions\": [\n \"\"\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"ed753f5b-29a9-4837-803c-f3ed72d62c4d","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/series?page=1&limit=50&sort=asc&orderBy=createdAt&accountId=id&companyId=id&subsidiaryId=id&serieNumbers=&tpEmis=&mod=&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["series"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: createdAt, updatedAt or enabled"},{"key":"accountId","value":"id","description":"Filter by all series from account"},{"key":"companyId","value":"id","description":"Filter by all series from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all series from subsidiary"},{"key":"serieNumbers","value":"","description":"Filter by all series from serieNumber list (eg. 1,2,3)"},{"key":"tpEmis","value":"","description":"Filter by all series from tpEmis list (eg. 1,9)"},{"key":"mod","value":"","description":"Filter by all series from tpEmis list (eg. 55,65)"},{"key":"q","value":"","description":"Search by: id, remoteId, federalDocument or serieNumber"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"21486355-1177-499a-a0fd-5e4adb2e96bf","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/series?page=1&limit=50&sort=asc&orderBy=createdAt&accountId=id&companyId=id&subsidiaryId=id&serieNumbers=&tpEmis=&mod=&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["series"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: createdAt, updatedAt or enabled"},{"key":"accountId","value":"id","description":"Filter by all series from account"},{"key":"companyId","value":"id","description":"Filter by all series from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all series from subsidiary"},{"key":"serieNumbers","value":"","description":"Filter by all series from serieNumber list (eg. 1,2,3)"},{"key":"tpEmis","value":"","description":"Filter by all series from tpEmis list (eg. 1,9)"},{"key":"mod","value":"","description":"Filter by all series from tpEmis list (eg. 55,65)"},{"key":"q","value":"","description":"Search by: id, remoteId, federalDocument or serieNumber"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"b4b36fdc-2b37-4416-ab00-c8e3b2b7179b"},{"name":"series (detail)","id":"af24a81d-4e4e-48a4-843b-99ed0a957864","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["series","{serieId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"7506a576-2574-4d15-b3a0-e190ab92a232","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"companyId\": \"\",\n \"subsidiaries\": [\n \"\"\n ],\n \"serieNumber\": \"\",\n \"lastUsedNumber\": \"\",\n \"mod\": \"\",\n \"tpEmis\": [\n \"\"\n ],\n \"transactions\": [\n \"\"\n ]\n }\n}"},{"id":"c882a605-c8d4-4d8f-8e70-1cc9961917c9","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"1613e03d-deb3-4400-91ae-0ebb3dc84476","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"a3264b2c-609a-4a91-9ada-28c16d8146bc","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"af24a81d-4e4e-48a4-843b-99ed0a957864"},{"name":"offline contingency","id":"51b70c97-9a65-4fda-89b4-c318dcd12bbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/offline-contingency/{subsidiaryId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["series","offline-contingency","{subsidiaryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"0f29a4c1-06e3-47f6-9b7a-1a529ad36c9f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/offline-contingency/{subsidiaryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"enabled\": true,\n \"companyId\": \"\",\n \"subsidiaries\": [\n \"\"\n ],\n \"serieNumber\": \"\",\n \"lastUsedNumber\": \"\",\n \"mod\": \"\",\n \"tpEmis\": [\n \"\"\n ],\n \"transactions\": [\n \"\"\n ]\n }\n}"},{"id":"d15df804-64ee-474e-b5a9-9735dd0da16a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/offline-contingency/{subsidiaryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"a265f017-ab00-443d-b572-8703fabd07aa","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/offline-contingency/{subsidiaryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"3a59d59d-2e63-4fe0-8a45-9dd43ce84729","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/offline-contingency/{subsidiaryId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"51b70c97-9a65-4fda-89b4-c318dcd12bbd"},{"name":"series","id":"2d8b8658-e4e5-42ec-b2b7-2091bb142ecf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
serieNumber	This is the unique invoice issuance serial number per subsidiary. It is mandatory and must be a string with values in the range 000 to 889 (if the subsidiary has a CNPJ and Model 55 or 65) or 00001 to 49999 (if the subsidiary has a CNPJ and Model 99).
lastUsedNumber	This is the last sequential number used in the series, considering that each series can generate sequential numbers in the range from 0 to 999,999,999 (if it is model 55 or 65) and between 0 and 999,999,999,999,999 (if it is model 99). It is optional, it must be a number with a length of 1 to 9 digits (if it is model 55 or 65) and 1 to 15 digits (if it is model 99) and the content entered cannot have been unused or used in another invoice issuance. The platform will automatically generate, based on the last number entered for the respective series, a document number for each invoice issuance request. Therefore, if the series is new, enter zero as the last number used. If it is not entered, the platform will automatically assign zero.
mod	This is the code of the tax document model that you want to issue in this series, considering the tax document models provided on the platform. It is required, it must be an string with length 2 and the informed content must be \"55\" (NF-e), \"65\" (NFC-e) and \"99\" (NFS-e).
tpEmis	This is the code for the type of issuance allowed in this series, considering the types of issuance available on the platform. It is mandatory, it must be an array of strings with length 1 and the content entered must be \"1\" (normal mode - online), \"6\" or \"7\" (online contingency mode) and \"9\" (offline contingency mode). It is mandatory, it must be a string and the content (1, 6, 7 or 9) must comply with the following rules: 1) It is forbidden to register \"tpEmis\" equal to 9 for \"mod\" equal to 55, as this document model does not allow this type of issuance. 2) It is forbidden to register \"tpEmis\" equal to 6 or 7 for \"mod\" equal to 65, as this document model does not allow this type of issuance. 3) It is forbidden to register \"tpEmis\" equal to 6 or 7 or 9 for \"mod\" equal to 99, as this document model does not allow this type of issuance.
enabled	This information defines whether your series is enabled to receive and process requests. It is optional, must be a boolean and the content provided must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["series","{serieId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"81da840d-b507-403f-b563-e0e1e44b1fcd","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serieNumber\": \"optional, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"optional, string\",\n \"tpEmis\": [\n \"optional, string\"\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Serie updated successfully\"\n}"},{"id":"6c5be0f2-e3df-4b16-b74a-ec7294021f9f","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serieNumber\": \"optional, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"optional, string\",\n \"tpEmis\": [\n \"optional, string\"\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"43e61e60-ebc5-40f2-944c-0b5de9009bf5","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serieNumber\": \"optional, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"optional, string\",\n \"tpEmis\": [\n \"optional, string\"\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"a775c9b1-8ce5-4f15-8b28-4398fea95f63","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"serieNumber\": \"optional, string\",\n \"lastUsedNumber\": \"optional, number\",\n \"mod\": \"optional, string\",\n \"tpEmis\": [\n \"optional, string\"\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"2d8b8658-e4e5-42ec-b2b7-2091bb142ecf"},{"name":"series","id":"7189568f-7beb-4b9f-bc25-312ec41d6849","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["series","{serieId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"4f93e5f3-b779-44e7-81fa-9777259858c9","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Serie removed successfully\"\n}"},{"id":"9dda8f38-7903-4a83-af90-4af298393c89","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"e742c6e1-4561-4824-b473-291fc381593f","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"35e81d19-d1ba-4049-9ad1-7e839e2eee6d","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/series/{serieId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"7189568f-7beb-4b9f-bc25-312ec41d6849"}],"id":"98b1bb02-96d6-4074-a871-d7ac6e282ec2","description":"

A mandatory prerequisite for taxpayers accredited as issuers of electronic tax documents is to control such issuances by \"subsidiary\", by \"series\" and, in some cases, by \"model\" of invoice. Taxpayers who wish to issue an electronic tax document through the application developed by themselves or acquired from companies in the market must use, in each subsidiary with a CNPJ, the series range 000-889 (model 55 or 65) and 00001-49999 (model 99). Each of the series will have the potential to issue sequentially from 1 to 999.999.999 invoices (model 55 or 65) or between 0 and 999.999.999.999.999 invoices (model 99) and must be restarted when this limit is reached. Contabilone's software platform allows its clients to manage document issuance series ranges within a previously selected subsidiary.

\n","_postman_id":"98b1bb02-96d6-4074-a871-d7ac6e282ec2"},{"name":"terminals","item":[{"name":"terminals","id":"316f3c06-2973-4f28-908a-88770c78618e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
subsidiaryId	This is the ID of the subsidiary where the terminal will be registered. It is mandatory, it must be a string containing a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
terminalSerialNumber	This is the manufacturing serial number of the equipment used as a sales terminal. If the equipment does not have a manufacturing series, inform the internal asset control code or some other code that uniquely identifies the equipment in your company. It is mandatory, it must be a string with a length from 1 to 20 characters.
cashierNumber	This is the cashier number of the subsidiary where the equipment is used as a sales terminal. It is mandatory, it must be a string with length 3 and it must be unique per subsidiary.
contingencySerieId	This is the ID of the contingency serie to which the terminal will be linked. It must be a string containing a valid UUID. This serie is used for offline contingency issuance in case of internet connection failure. Without this information, it is not possible to issue an offline contingency. It is optional (but highly recommended) for all sales terminals where offline contingencies are allowed.
ip	This is the \"IP\" address of the equipment used as a sales terminal. It is optional, it must be a string and have a maximum length of 20 characters.
agentPort	This is the port number that the agent will use to launch on the machine it is running on. It is optional, it must be a number.
cStatSwitchable	This list stores the cStat codes for the Agent to do offline contingency switching. It is optional, your items must be of type string.
invoiceTimeoutSeconds	This is the timeout setting for the invoice issuance and tax calculation library (Agent SDK) installed on the sales terminal. The configured value will determine how long the library will wait for an API response before switching to its internal offline fallback process. It is mandatory and must be a number (which will be understood as seconds of minutes) with values between 25 and 60.
publishers[].priority	This is the mechanism to prioritize the type of invoice issuer for the subsidiary's sales terminal. It is conditional and should only be informed together with the \"publishers[].type\" field. The format is numeric, respecting the order of possible publishers (1 and 2). If not informed, the default publishers defined by the platform will be: 1 - NFCE_ONLINE; 2 - NFCE_OFFLINE (only if there is a contingency series linked to the terminal).
publishers[].type	This is the type of invoice issuer for the subsidiary's sales terminal. It is conditional and should only be informed together with the \"publishers[].priority\" field. The format is string, respecting the order of possible publishers (NFCE_ONLINE, NFCE_OFFLINE). If not informed, the default publishers defined by the platform will be: NFCE_ONLINE; NFCE_OFFLINE (only if there is a contingency series linked to the terminal).
settingIgnore	This mechanism allows you to determine whether or not the terminal is subject to scheduled automated updates by settings. If you select \"false\" or do not specify, it means that the terminal is subject to scheduled automated updates by settings. If you select \"true,\" it means that the terminal will not be affected by scheduled automated updates by settings. It is a boolean and optional.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["terminals"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"54d3bc0f-323e-46d5-86c5-6fbe14161d7a","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subsidiaryId\": \"required, string\",\n \"terminalSerialNumber\": \"required, string\",\n \"cashierNumber\": \"required, string\",\n \"contingencySerieId\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"ip\": \"optional, string\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"required, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api-homologation.omnitax.ai/terminals"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Terminal registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"48f93654-d411-4cb8-8e5d-2d31ce7531df","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subsidiaryId\": \"required, string\",\n \"terminalSerialNumber\": \"required, string\",\n \"cashierNumber\": \"required, string\",\n \"contingencySerieId\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"ip\": \"optional, string\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"required, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"cashierNumber\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"c59b615e-aa40-4aa3-91e2-7d7b52a00ed3","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subsidiaryId\": \"required, string\",\n \"terminalSerialNumber\": \"required, string\",\n \"cashierNumber\": \"required, string\",\n \"contingencySerieId\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"ip\": \"optional, string\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"required, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"41c7aaff-5c80-42f8-be6b-3d73253206ce","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subsidiaryId\": \"required, string\",\n \"terminalSerialNumber\": \"required, string\",\n \"cashierNumber\": \"required, string\",\n \"contingencySerieId\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"ip\": \"optional, string\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"required, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"5b95978f-db5b-4090-967f-40354bc4e7b5","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subsidiaryId\": \"required, string\",\n \"terminalSerialNumber\": \"required, string\",\n \"cashierNumber\": \"required, string\",\n \"contingencySerieId\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"ip\": \"optional, string\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"required, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"subsidiaryId\",\n \"messages\": [\n \"Not Found\"\n ]\n }\n ]\n}"},{"id":"2e5c2fde-5c02-4fa1-a2ae-9797e3b0619f","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subsidiaryId\": \"required, string\",\n \"terminalSerialNumber\": \"required, string\",\n \"cashierNumber\": \"required, string\",\n \"contingencySerieId\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"ip\": \"optional, string\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"required, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"terminalSerialNumber\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"316f3c06-2973-4f28-908a-88770c78618e"},{"name":"terminals (list)","id":"8e999e35-2a37-4c7b-9ee4-f175068a8ed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals?page=1&limit=50&sort=asc&orderBy=&accountId=id&companyId=id&subsidiaryId=id&q=","urlObject":{"protocol":"{{PROTOCOL}}","path":["terminals"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of item per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: createdAt, updatedAt or enabled

\n","type":"text/plain"},"key":"orderBy","value":""},{"description":{"content":"

Filter by all terminals from account

\n","type":"text/plain"},"key":"accountId","value":"id"},{"description":{"content":"

Filter by all terminals from company

\n","type":"text/plain"},"key":"companyId","value":"id"},{"description":{"content":"

Filter by all terminals from subsidiary

\n","type":"text/plain"},"key":"subsidiaryId","value":"id"},{"description":{"content":"

Search by: id, remoteId, federalDocument, terminalSerialNumber or cashierNumber

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"9f4697b8-2565-43a1-ae91-7a732353d6f8","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals?page=1&limit=50&sort=asc&orderBy=&accountId=id&companyId=id&subsidiaryId=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["terminals"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"","description":"Order by: createdAt, updatedAt or enabled"},{"key":"accountId","value":"id","description":"Filter by all terminals from account"},{"key":"companyId","value":"id","description":"Filter by all terminals from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all terminals from subsidiary"},{"key":"q","value":"","description":"Search by: id, remoteId, federalDocument, terminalSerialNumber or cashierNumber"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"contingencySerie\": {\n \"id\": \"\",\n \"serieNumber\": \"\",\n \"lastUsedNumber\": 0,\n \"mod\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"tpEmis\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"enabled\": true,\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n }\n },\n \"subsidiary\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"L\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"identification\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\",\n \"openingDate\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"closingDate\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"headquarters\": true\n },\n \"address\": {\n \"cep\": \"25685330\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"cUF\": \"\",\n \"xUF\": \"\",\n \"UF\": \"\",\n \"Pais\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 1,\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 1,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 1,\n \"usersTotal\": 1\n }\n }\n }\n },\n \"terminalSerialNumber\": \"\",\n \"cashierNumber\": \"\",\n \"ip\": \"\",\n \"retryTaskPeriod\": 1,\n \"invoiceTimeoutSeconds\": 1,\n \"invoiceTimeoutMilliseconds\": 1,\n \"agentPort\": 1,\n \"publishers\": [\n {\n \"type\": \"\",\n \"priority\": 1\n }\n ],\n \"cStatSwitchable\": [\n \"\"\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"9583430f-c526-4efb-9c07-9a6f6ceb2265","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals?page=1&limit=50&sort=asc&orderBy=&accountId=id&companyId=id&subsidiaryId=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["terminals"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"","description":"Order by: createdAt, updatedAt or enabled"},{"key":"accountId","value":"id","description":"Filter by all terminals from account"},{"key":"companyId","value":"id","description":"Filter by all terminals from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all terminals from subsidiary"},{"key":"q","value":"","description":"Search by: id, remoteId, federalDocument, terminalSerialNumber or cashierNumber"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"c9e03522-91d5-4625-b445-01004ff52228","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals?page=1&limit=50&sort=asc&orderBy=&accountId=id&companyId=id&subsidiaryId=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["terminals"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"","description":"Order by: createdAt, updatedAt or enabled"},{"key":"accountId","value":"id","description":"Filter by all terminals from account"},{"key":"companyId","value":"id","description":"Filter by all terminals from company"},{"key":"subsidiaryId","value":"id","description":"Filter by all terminals from subsidiary"},{"key":"q","value":"","description":"Search by: id, remoteId, federalDocument, terminalSerialNumber or cashierNumber"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"8e999e35-2a37-4c7b-9ee4-f175068a8ed9"},{"name":"terminals (detail)","id":"21e673bf-3835-4b98-8931-29536f0cc821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["terminals","{terminalId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"7be3d02b-882b-40fc-a24d-40159189e966","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"contingencySerie\": {\n \"id\": \"\",\n \"serieNumber\": \"\",\n \"lastUsedNumber\": 0,\n \"mod\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"tpEmis\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"enabled\": true,\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n }\n },\n \"subsidiary\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"L\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"identification\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": \"\",\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\",\n \"openingDate\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"closingDate\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"headquarters\": true\n },\n \"address\": {\n \"cep\": \"25685330\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"cUF\": \"\",\n \"xUF\": \"\",\n \"UF\": \"\",\n \"Pais\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 1,\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 1,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"updatedAt\": {\n \"epoch\": 1,\n \"formatted\": \"\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 1,\n \"usersTotal\": 1\n }\n }\n }\n },\n \"terminalSerialNumber\": \"\",\n \"cashierNumber\": \"\",\n \"ip\": \"\",\n \"retryTaskPeriod\": 1,\n \"invoiceTimeoutSeconds\": 1,\n \"invoiceTimeoutMilliseconds\": 1,\n \"agentPort\": 1,\n \"publishers\": [\n {\n \"type\": \"\",\n \"priority\": 1\n }\n ],\n \"cStatSwitchable\": [\n \"\"\n ]\n }\n}"},{"id":"ffbb8d30-7575-4ce6-81f4-138ab3fad64a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"4f4c2c81-6cab-4500-8d96-a19f16721022","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ab3214ba-e1aa-4d9c-865a-554b2c733764","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"21e673bf-3835-4b98-8931-29536f0cc821"},{"name":"terminals","id":"1c4b385e-5d16-4b0c-b15a-b107789b7ee5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
terminalSerialNumber	This is the manufacturing serial number of the equipment used as a sales terminal. If the equipment does not have a manufacturing series, inform the internal asset control code or some other code that uniquely identifies the equipment in your company. It is mandatory, it must be a string with a length from 1 to 20 characters.
cashierNumber	This is the cashier number of the subsidiary where the equipment is used as a sales terminal. It is mandatory, it must be a string with length 3 and it must be unique per subsidiary.
contingencySerieId	This is the ID of the contingency serie to which the terminal will be linked. It must be a string containing a valid UUID. This serie is used for offline contingency issuance in case of internet connection failure. Without this information, it is not possible to issue an offline contingency. It is optional (but highly recommended) for all sales terminals where offline contingencies are allowed.
ip	This is the \"IP\" address of the equipment used as a sales terminal. It is optional, it must be a string and have a maximum length of 20 characters.
agentPort	This is the port number that the agent will use to launch on the machine it is running on. It is optional, it must be a number.
cStatSwitchable	This list stores the cStat codes for the Agent to do offline contingency switching. It is optional, your items must be of type string.
invoiceTimeoutSeconds	This is the timeout setting for the invoice issuance and tax calculation library (Agent SDK) installed on the sales terminal. The configured value will determine how long the library will wait for an API response before switching to its internal offline fallback process. It is mandatory and must be a number (which will be understood as seconds of minutes) with values between 25 and 60.
publishers[].priority	This is the mechanism to prioritize the type of invoice issuer for the subsidiary's sales terminal. It is conditional and should only be informed together with the \"publishers[].type\" field. The format is numeric, respecting the order of possible publishers (1 and 2). If not informed, the default publishers defined by the platform will be: 1 - NFCE_ONLINE; 2 - NFCE_OFFLINE (only if there is a contingency series linked to the terminal).
publishers[].type	This is the type of invoice issuer for the subsidiary's sales terminal. It is conditional and should only be informed together with the \"publishers[].priority\" field. The format is string, respecting the order of possible publishers (NFCE_ONLINE, NFCE_OFFLINE). If not informed, the default publishers defined by the platform will be: NFCE_ONLINE; NFCE_OFFLINE (only if there is a contingency series linked to the terminal).
settingIgnore	This mechanism allows you to determine whether or not the terminal is subject to scheduled automated updates by settings. If you select \"false\" or do not specify, it means that the terminal is subject to scheduled automated updates by settings. If you select \"true,\" it means that the terminal will not be affected by scheduled automated updates by settings. It is a boolean and optional.
enabled	This information defines whether your terminal is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["terminals","{terminalId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"b28da8b8-f9c7-4831-a37a-1fdcc41672d2","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"terminalSerialNumber\": \"optional, string\",\n \"cashierNumber\": \"optional, string\",\n \"contingencySerieId\": \"optional, string\",\n \"ip\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"optional, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-homologation.omnitax.ai/terminals/{terminalId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Terminal updated successfully\"\n}"},{"id":"4ac560fa-05ae-493f-ace5-3d58419f7d65","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"terminalSerialNumber\": \"optional, string\",\n \"cashierNumber\": \"optional, string\",\n \"contingencySerieId\": \"optional, string\",\n \"ip\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"optional, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"1aef3478-92b9-43c3-828a-b973b5b2bdee","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"terminalSerialNumber\": \"optional, string\",\n \"cashierNumber\": \"optional, string\",\n \"contingencySerieId\": \"optional, string\",\n \"ip\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"optional, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"496a49ce-cae0-4c6f-b34a-ae4f90719aa1","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"terminalSerialNumber\": \"optional, string\",\n \"cashierNumber\": \"optional, string\",\n \"contingencySerieId\": \"optional, string\",\n \"ip\": \"optional, string\",\n \"settingIgnore\": \"boolean, optional\",\n \"agentPort\": \"optional, string\",\n \"cStatSwitchable\": [\n \"optional, string\"\n ],\n \"invoiceTimeoutSeconds\": \"optional, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFCE_ONLINE\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFCE_OFFLINE\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"1c4b385e-5d16-4b0c-b15a-b107789b7ee5"},{"name":"terminals","id":"a9969625-df62-4bf3-820d-b8bccf92dff3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["terminals","{terminalId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"27442de4-2ab7-408f-8b58-6336333f18be","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Terminal removed successfully\"\n}"},{"id":"140297ca-3581-415d-b36f-83a2079771df","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"0e85c790-962d-402f-b4dd-3a0e360a9c82","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subsidiaryId\": \"required, string\",\n \"terminalSerialNumber\": \"required, string\",\n \"cashierNumber\": \"required, string\",\n \"contingencySerieNumber\": \"optional, string\",\n \"ip\": \"optional, string\",\n \"updateVersion\": \"required, boolean\",\n \"invoiceTimeoutSeconds\": \"required, number\",\n \"publishers\": [\n {\n \"priority\": 1,\n \"type\": \"NFC-e Online\"\n },\n {\n \"priority\": 2,\n \"type\": \"NFC-e Offline\"\n },\n {\n \"priority\": 3,\n \"type\": \"CF-e\"\n }\n ],\n \"devices\": [\n {\n \"deviceSerialNumber\": \"conditional, string\",\n \"ip\": \"optional, string\",\n \"model\": \"conditional, string\",\n \"activationCode\": \"conditional, string\",\n \"cfeLayoutVersion\": \"conditional, string\",\n \"mfeDriverInstallPath\": \"conditional, string\",\n \"signAC\": \"conditional, string\"\n }\n ],\n \"enabled\": \"optional, boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"0f74bbf8-83c3-41bb-9ad0-ed399be07653","name":"410 Gone","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/terminals/{terminalId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"a9969625-df62-4bf3-820d-b8bccf92dff3"}],"id":"d395c879-8ee8-4803-aa2b-9f6b491792e9","description":"

Users will be able to register terminals and sales devices in previously selected branches and their exclusivity will be determined by “cashierNumber”. It is not mandatory to register sales terminals on the platform, but it is only possible to use fully offline tax issuance and calculation mechanisms (Agent SDK) if there are terminals registered on the platform. Although it is not mandatory by the API, all terminals registered in branches must report “contingencySerieId”. This is necessary because offline contingent issuance is allowed in all states and the contingent tax issuance series must be registered on the terminal and be unique.

\n","_postman_id":"d395c879-8ee8-4803-aa2b-9f6b491792e9"},{"name":"invoice events","item":[{"name":"authorization","id":"ff0971fd-9a18-4523-9968-825ddf3cd0d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/event/{tpEvento}","description":"

For \"authorization\" of an invoice you must send event code equal to \"999998\" in this endpoint. The document model must be informed in the body of the request payload.

The invoice models currently supported by the platform have, in all, approximately 350 fields defined by the Brazilian public administration, many of them only necessary to detail specific operations, such as vehicles, medicines, firearms, fuels and foreign trade operations.

In the table below we will only document the fields that correspond to more than 99% of the most common operations carried out by Brazilian subsidiaries, while in the requisition payload model we will present all the fields to facilitate the assembly of your requisition. Even the fields reported in the table below can be configured as a business rule to further reduce the request payload and, consequently, your integration effort.

If you want to know a little more about the Brazilian invoice model, visit https://www.nfe.fazenda.gov.br/portal/principal.aspx and: https://dfe-portal.svrs.rs.gov.

If you still have questions about how to assemble your request payload with minimal integration effort, please contact our support team at suporte@contabilone.com.

`Attribute`	`Details`
accountId	This is the account where the subsidiary that will authorize the invoice is registered. It is mandatory only if you use the whitelabel token instead of the account token in the API call. Must be a string containing a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
NFe.infNFe.ide.mod	This is the code of the tax document template you want to issue an invoice, considering the tax document templates available on the platform. It is mandatory, it must be a string with length 2 and the informed content must be \"55\" (NF-e), \"65\" (NFC-e), \"57\" (CT-e), \"67\" (CT -e OS) and \"99\" (NFS-e).
NFe.infNFe.ide.serie	This is the invoice issue serial number. It is mandatory for the issuance of the invoice to be successful, but it is not mandatory to inform in the payload of the request. If not informed, the platform will use the first series registered in the subsidiary for the tax document model informed in the payload. If informed, the platform will use the series declared in the payload. It must be a serial number previously registered with the subsidiary and must be a string.
NFe.infNFe.ide.natOp	This is the nature of the invoice operation, i.e. if the invoice is documenting a sale, transfer, return, etc. operation. It is required and must be a string. If you use the rules engine to calculate taxes on your invoice, try to inform the nature of the operation in the same way you used it when registering your rules.
NFe.infNFe.ide.tpNF	This attribute indicates whether the invoice represents an Inbound (0 - Inbound) or outbound (1 - Outbound) operation. It is required and must be a string. If you use the rules engine to calculate taxes on your invoice, try to inform the type of operation in the same way you used it when registering your rules.
NFe.infNFe.ide.idDest	This attribute indicates whether the invoice represents an operation within the state of the federation (1 - Internal Operation), operation between two states of the federation (2 - Interstate Operation) or operation between countries (3 - Foreign Trade Operation). It is required and must be a string. If you use the rules engine to calculate taxes on your invoice, try to inform the destination of the operation in the same way you used it when registering your rules.
NFe.infNFe.ide.indFinal	This attribute indicates whether the invoice represents an operation carried out with the recipient as a final consumer (1 - Final Consumer) or not (0 - Normal Consumer). It is required and must be a string. If you use the rules engine to calculate taxes on your invoice, try to inform the type of recipient of the operation in the same way you used it when registering your rules.
NFe.infNFe.emit.CNPJ	This is the only federal document of the subsidiary that intends to issue the invoice. In Brazil, the sole document of a subsidiary is the CNPJ. It is mandatory, it must be from a subsidiary registered on the platform and it must be a string.
NFe.infNFe.emit.IE	This is the registration document as a state taxpayer of the subsidiary that intends to issue the invoice. It is mandatory, it must be from a subsidiary registered on the platform and it must be a string.
NFe.infNFe.dest.CNPJ	This is the recipient's only federal document reported on the invoice, if it is a company. In Brazil, the only document of a company is the CNPJ. It is mandatory only if you are going to issue an invoice with a company as recipient and it must be a string.
NFe.infNFe.dest.CPF	This is the recipient's only federal document reported on the invoice, if he is a person. In Brazil, the only document of a person is the CPF. It is mandatory only if you are going to issue a model 55 invoice with a person as recipient and it must be a string. If the model is 65, informing the obligation to inform the recipient depends on (i) the recipient's desire or (ii) the amount of the invoice, which may change in each state of the federation.
NFe.infNFe.dest.idEstrangeiro	This is the recipient's document informed on the invoice, if he is a foreign person. It is mandatory only if you are going to issue a model 55 invoice with a foreign person as recipient and it must be a string. If the model is 65, informing the obligation to inform the recipient depends on (i) the recipient's desire or (ii) the amount of the invoice, which may change in each state of the federation.
NFe.infNFe.dest.xNome	This is the recipient's name on the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a string. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's desire or (ii) the amount of the invoice, which can change in each state of the federation.
NFe.infNFe.dest.indIEDest	This is the recipient's state taxpayer indicator reported on the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a string. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's desire or (ii) the amount of the invoice, which can change in each state of the federation. Valid values are: \"1\" (recipient is state registered), \"2\" (recipient is Exempt from state registration, and \"9\" (recipient is not a state taxpayer).
NFe.infNFe.dest.enderDest.xLgr	This is the recipient address stated on the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a string with a length between 1 and 60 characters. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's will or (ii) the amount of the invoice, which may vary in each state of the federation.
NFe.infNFe.dest.enderDest.nro	This is the recipient address number given on the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a string with a length between 1 and 60 characters. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's will or (ii) the amount of the invoice, which may vary in each state of the federation.
NFe.infNFe.dest.enderDest.xBairro	This is the neighborhood of the address of the recipient informed in the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a string with a length between 2 and 60 characters. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's will or (ii) the amount of the invoice, which may vary in each state of the federation.
NFe.infNFe.dest.enderDest.cMun	This is the county code for the recipient's address entered on the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a 7-digit string. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's will or (ii) the amount of the invoice, which may vary in each state of the federation.
NFe.infNFe.dest.enderDest.xMun	This is the county name of the recipient's address given on the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a string with a length between 2 and 60 characters. Inform literal \"EXTERIOR\" if the operation is foreign trade. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's will or (ii) the amount of the invoice, which may vary in each state of the federation.
NFe.infNFe.dest.enderDest.UF	This is the abbreviation of the state of the address of the recipient informed on the invoice. It is mandatory only if you are going to issue a model 55 invoice and it must be a 2-character string. Inform literal \"EX\" if the operation is foreign trade. If the model is 65, the obligation to inform the recipient depends on (i) the recipient's will or (ii) the amount of the invoice, which may vary in each state of the federation.
NFe.infNFe.det.prod.finalidadeEmit	This is the origin code of the product declared on the invoice from the point of view of the person issuing an invoice. As an example, it serves to inform whether the declared product was manufactured by the issuer (sale) or acquired from third parties (resale). It's optional, but if declared, it must be a string. If you use the rules engine to calculate taxes on your invoice, try to enter the purpose code in the same way you used it when registering your rules. You can use your own code or use the codes predefined by Contabilone in GET/tax-infos/name?page=1&limit=100&name=finalidade.
NFe.infNFe.det.prod.finalidadeDest	This is the origin code of the product declared on the invoice from the point of view of the recipient of the invoice. As an example, it serves to inform if the declared product was acquired by the recipient for resale, fixed assets, own consumption, etc. It's optional, but if declared, it must be a string. If you use the rules engine to calculate taxes on your invoice, try to enter the purpose code in the same way you used it when registering your rules. You can use your own code or use the codes predefined by Contabilone in GET/tax-infos/name?page=1&limit=100&name=finalidade.
NFe.infNFe.det.prod.cProd	This is the unique identification code of the product declared on the invoice from the point of view of the person issuing the invoice. It is required and must be a string with a length between 1 and 60.
NFe.infNFe.det.prod.xProd	This is the description that uniquely identifies the product declared on the invoice from the point of view of who is issuing the invoice. It is required and must be a string with a length between 1 and 120.
NFe.infNFe.det.prod.NCM	This is the mercosur common nomenclature code applicable to the product declared on the invoice from the point of view of who is issuing the invoice. It is mandatory and must be a string with length of length 2 or 8.
NFe.infNFe.det.prod.cEAN	This is the Global Trade Item Number - GTIN code (formerly EAN code or barcode) of the product declared on the invoice from the point of view of the person issuing the invoice. If there is no GTIN, inform literal “SEM GTIN”. It is mandatory and must be a string in lengths 8, 12, 13 and 14.
NFe.infNFe.det.prod.uCom	This is the acronym of the commercial unit of the product declared in the invoice from the point of view of who is issuing an invoice. It is required and must be a string of length 1 to 6.
NFe.infNFe.det.prod.qCom	This is the commercial quantity of the product declared on the invoice from the point of view of the person issuing the invoice. It is mandatory and must be a string of length from 1 to 11 integers with up to 4 decimals.
NFe.infNFe.det.prod.vUnCom	This is the commercial unit value of the product declared on the invoice from the point of view of the person issuing the invoice. It is mandatory and must be a string of length from 1 to 11 integers with up to 10 decimals.
NFe.infNFe.det.prod.cEANTrib	This is the taxable Global Trade Item Number - GTIN (formerly EAN code or barcode) code of the product declared on the invoice from the point of view of the person issuing an invoice. If there is no GTIN, inform literal “SEM GTIN”. It is mandatory and must be a string in lengths 8, 12, 13 and 14.
NFe.infNFe.det.prod.uTrib	This is the abbreviation of the taxable unit of the product declared in the invoice from the point of view of who is issuing an invoice. It is required and must be a string of length 1 to 6.
NFe.infNFe.det.prod.qTrib	This is the taxable amount of the product declared on the invoice from the point of view of the person issuing the invoice. It is mandatory and must be a string of length from 1 to 11 integers with up to 4 decimals.
NFe.infNFe.det.prod.vUnTrib	This is the taxable unit value of the product declared on the invoice from the point of view of the person issuing the invoice. It is mandatory and must be a string of length from 1 to 11 integers with up to 10 decimals.
NFe.infNFe.det.prod.vProd	It is the total commercial value of the product, resulting from the multiplication of the commercial unit value (vUnCom) by the commercial quantity (qCom). It is mandatory and must be a string of length from 1 to 13 integers with up to 2 decimals.
NFe.infNFe.det.prod.vFrete	It is the total value of the freight applicable to the commercialization of the product. It is mandatory and must be a string of length from 1 to 13 integers with up to 2 decimals.
NFe.infNFe.det.prod.vSeg	It is the total value of the insurance applicable to the commercialization of the product. It is mandatory and must be a string of length from 1 to 13 integers with up to 2 decimals.
NFe.infNFe.det.prod.vDesc	It is the total value of the unconditional discount applicable to the sale of the product. It is mandatory and must be a string of length from 1 to 13 integers with up to 2 decimals.
NFe.infNFe.det.prod.vOutro	It is the total value of other expenses, whatever they may be, applicable to the marketing of the product. It is mandatory and must be a string of length from 1 to 13 integers with up to 2 decimals.
NFe.infNFe.det.imposto.ICMS.orig	This is the code that defines the origin of the product, whether national or imported. It is required and must be a string of length 1. Search for possible values in GET/tax-infos/name?page=1&limit=100&name=orig
NFe.infNFe.transp.modFrete	This is the freight mode code (CIF or FOB) applicable to the invoice as a whole. It is required and must be a string of length 1. Search for possible values in GET/tax-infos/name?page=1&limit=100&name=modFrete
NFe.infNFe.pag.detPag.tPag	This is the payment type code (cash, card, etc.) applicable to the invoice as a whole. It is required and must be a string of length 2. Search for possible values in GET/tax-infos/name?page=1&limit=100&name=tPag
NFe.infNFe.pag.detPag.vPag	This is the payment amount applicable to the invoice as a whole. It is mandatory and must be a string of length from 1 to 13 integers with up to 2 decimals.
NFe.infNFe.pag.detPag.dPag	This is the effective payment date. It is optional and must be a string in the format YYYY-MM-DD.
NFe.infNFe.pag.detPag.CNPJPag	This is the document of the subsidiary where the payment was made when the payment occurs in a subsidiary other than the one that issued the invoice. It is optional and must be a string of length 14.
NFe.infNFe.pag.detPag.UFPag	This is the acronym of the federation unit of the subsidiary where the payment was made when the payment occurs in a subsidiary other than the one that issued the invoice. It is optional and must be a string of length 2.
NFe.infNFe.pag.detPag.card.tpIntegra	This is the payment integration type code applicable to the invoice as a whole. It is mandatory when the payment type is equal to \"03\" or \"04\" (card). It must be a string and the entered value must be \"1\" (TEF) or \"2\" (POS).
NFe.infNFe.pag.detPag.card.CNPJ	This is the sole identification document (CNPJ) of the acquirer that authorized the payment via card. It is mandatory when the type of payment is the same (card). It must be a string and the entered value must be 14 digits long.
NFe.infNFe.pag.detPag.card.tBand	This is the credit card brand code. It is mandatory when the type of payment is the same (card). It must be a string and the entered value must be 2 digits long. Search in GET/tax-infos/name?page=1&limit=100&name=tBand
NFe.infNFe.pag.detPag.card.cAut	This is the payment authorization code generated by the acquirer that authorized the payment via card. It is mandatory when the type of payment is the same (card). It must be a string and the entered value must have a length of 1 to 20 characters.
NFe.infNFe.pag.detPag.card.CNPJReceb	This is a document from the subsidiary beneficiary of the payment. It is optional and must be a string of length 14.
NFe.infNFe.pag.detPag.card.idTermPag	This is the unique identifier of the terminal where the payment was made. It is optional and must be a string of length 1-40.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["invoices","event","{tpEvento}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"3a2f37a0-3532-4a06-9553-2dfd0fa2625c","name":"202 Accepted","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"accountId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"NFe\": {\n \"infNFe\": {\n \"_attr_Id\": \"required; string; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It uniquely identifies the NF-e by its 44-character access key, embedded as an XML attribute.\",\n \"_attr_versao\": \"required; string; It specifies the NF-e schema version used in the document.\",\n \"ide\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"cNF\": \"required; string; size 8; It carries an 8-digit random numeric code used as part of the NF-e access key composition.\",\n \"natOp\": \"required; string; size 1..60; It informs the nature of the operation in free text (e.g., 'Venda de mercadoria', 'Devolução').\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\",\n \"dhEmi\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the NF-e was issued.\",\n \"dhSaiEnt\": \"optional; string; YYYY-MM-DDThh:mm:ssTZD; It indicates the date and time of goods departure (outbound) or receipt (inbound).\",\n \"dPrevEntrega\": \"optional; string; YYYY-MM-DD; It informs the expected delivery date of the goods to the recipient.\",\n \"dCompet\": \"optional; string; YYYY-MM-DD; It provides the date of competence of the operation for service operations (NFS-e).\",\n \"tpNF\": \"required; string; size 1; values: 0 (inbound/entrada), 1 (outbound/saída); It indicates the direction of the operation.\",\n \"idDest\": \"required; string; size 1; values: 1 (within the same state), 2 (interstate), 3 (international); It classifies the geographic scope of the operation.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cMunFGIBS\": \"optional; string; size 7; It identifies the municipality of the IBS taxable event when different from cMunFG, using the IBGE code.\",\n \"tpImp\": \"required; string; size 1; values: 0 (no DANFE), 1 (portrait), 2 (landscape), 3 (simplified), 4 (NFC-e), 5 (NFC-e electronic message); It specifies the DANFE print format.\",\n \"tpEmis\": \"required; string; size 1; values: 1 (normal), 2 (FS contingency), 3 (SVC-AN), 4 (SVC-RS), 5 (FS-DA contingency), 6 (SVC-AN alt), 7 (SVC-RS alt), 9 (NFC-e offline); It identifies the emission mode, distinguishing normal from contingency.\",\n \"cDV\": \"required; string; size 1; It is the check digit of the 44-character NF-e access key, calculated using modulo 11.\",\n \"tpAmb\": \"required; string; size 1; values: 1 (production), 2 (homologation/testing); It indicates the environment in which the NF-e is being issued.\",\n \"finNFe\": \"required; string; size 1; values: 1 (normal NF-e), 2 (complementary), 3 (adjustment), 4 (return/devolution); It defines the fiscal purpose of the document.\",\n \"tpNFDebito\": \"optional; string; It classifies the debit NF-e type as defined by the tax authority.\",\n \"tpNFCredito\": \"optional; string; It classifies the credit NF-e type as defined by the tax authority.\",\n \"indFinal\": \"required; string; size 1; values: 0 (not a final consumer), 1 (final consumer); It indicates whether the recipient is the end consumer of the goods.\",\n \"indPres\": \"required; string; size 1; values: 0 (not applicable), 1 (in-person), 2 (internet), 3 (telephone service), 4 (NFC-e home delivery), 5 (in-person outside the establishment), 9 (other); It indicates whether the buyer was physically present at the point of sale.\",\n \"indIntermed\": \"optional; string; size 1; values: 0 (no intermediary), 1 (with intermediary/marketplace); It flags whether the operation was conducted through a digital marketplace or platform.\",\n \"cIndOp\": \"optional; string; size 1..6; It carries the operation indicator code as defined by the issuer's internal or industry classification.\",\n \"procEmi\": \"required; string; size 1; values: 0 (taxpayer application), 1 (standalone by Fisco), 2 (SCAN/DPEC standalone), 3 (taxpayer app provided by Fisco); It identifies which process and software were used to generate the NF-e.\",\n \"verProc\": \"required; string; size 1..20; It records the version of the application or process used to emit the NF-e.\",\n \"dhCont\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the contingency mode was activated.\",\n \"xJust\": \"required; string; size 15..256; It provides the mandatory justification text explaining why contingency emission was used.\",\n \"tpEmit\": \"required; string; size 1; values: 1 (service provider/prestador), 2 (service taker/tomador), 3 (intermediary/intermediário); It identifies who is issuing the DPS/NFS-e.\",\n \"cMotivoEmisTI\": \"optional; string; size 1; values: 1 (service import), 2 (taker/intermediary required by municipal law), 3 (taker/intermediary issuing due to provider refusal), 4 (taker/intermediary rejecting provider's NFS-e); It indicates the reason why the taker or intermediary is issuing the DPS instead of the service provider.\",\n \"chNFSeRej\": \"optional; string; size 1..50; It carries the access key of the NFS-e previously rejected by the taker or intermediary, referenced when cMotivoEmisTI=4.\",\n \"cLocEmi\": \"required; string; size 7; It carries the 7-digit IBGE code of the municipality that authorized the issuance of this NFS-e.\",\n \"subst\": {\n \"chSubstda\": \"required; string; size 1..50; It carries the access key of the NFS-e being substituted.\",\n \"cMotivo\": \"required; string; size 1; values: 1 (opt-out of Simples Nacional), 2 (opt-in to Simples Nacional), 3 (retroactive inclusion of immunity/exemption), 4 (retroactive exclusion of immunity/exemption), 5 (rejection by taker or intermediary), 99 (other); It indicates the reason for substituting the NFS-e.\",\n \"xMotivo\": \"optional; string; size 15..255; It provides a free-text description of the substitution reason when cMotivo=99.\"\n },\n \"NFref\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\",\n \"refNFeSig\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e (simplified model) by its access key.\",\n \"refNF\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refNFP\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refCTe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a CT-e (transport document) related to this NF-e by its access key.\",\n \"refECF\": {\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"nECF\": \"required; string; size 3; It identifies the ECF (electronic cash register) equipment number.\",\n \"nCOO\": \"required; string; size 6; It carries the Counter of Fiscal Operations (COO) from the referenced ECF receipt.\"\n }\n }\n ],\n \"gCompraGov\": {\n \"tpEnteGov\": \"required; string; size 1; values: 1 (Union/Federal), 2 (State), 3 (Federal District), 4 (Municipality), 5 (Public Consortium), 6 (IBS Management Committee); It identifies the type of government entity involved in the purchase.\",\n \"pRedutor\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the IBS/CBS rate reduction percentage applicable to government purchases.\",\n \"tpOperGov\": \"required; string; size 1; values: 1 (supply with later payment), 2 (payment received, supply already done), 3 (supply with payment already made), 4 (payment received, supply pending); It identifies the operational sequence of a government purchase.\",\n \"refDFeAnt\": \"optional; string; size 44; repeatable 0..99; pattern [0-9]{6}[A-Z0-9]{12}[0-9]{26}; It references previous fiscal documents for tpOperGov 2 or 3.\"\n },\n \"gPagAntecipado\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\"\n }\n ]\n },\n \"emit\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"xFant\": \"optional; string; size 1..60; It provides the trade name or fantasy name used by the issuer commercially.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"IEST\": \"optional; string; size 2..14; It carries the state tax registration for ICMS tax substitution in a state different from the issuer's.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"CNAE\": \"optional; string; size 7; It identifies the issuer's primary economic activity using the CNAE classification code.\",\n \"CRT\": \"required; string; size 1; values: 1 (Simples Nacional), 2 (Simples Nacional — excess revenue), 3 (Normal Regime), 4 (Simples Nacional SIMEI); It identifies the tax regime of the issuer.\",\n \"ISUFEmit\": \"optional; string; size 8..9; It carries the issuer's SUFRAMA registration number for operations in incentive zones (ZFM/ALC).\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the issuer when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the issuer.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the issuer.\",\n \"enderEmit\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the issuer's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the issuer's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the issuer (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the issuer's address.\",\n \"cMun\": \"required; string; size 7; It identifies the issuer's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the issuer's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the issuer's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"required; string; size 8; It carries the issuer's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the issuer's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the issuer's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the issuer's contact phone number.\"\n }\n },\n \"avulsa\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xOrgao\": \"required; string; size 1..60; It names the tax authority that issued the standalone NF-e.\",\n \"matr\": \"required; string; size 1..60; It carries the registration number of the tax agent who authorized the avulsa NF-e.\",\n \"xAgente\": \"required; string; size 1..60; It provides the full name of the tax agent responsible for the avulsa NF-e.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\",\n \"nDAR\": \"optional; string; size 1..60; It carries the DAR (tax collection document) number related to the avulsa emission.\",\n \"dEmi\": \"optional; string; YYYY-MM-DD; It records the issuance date of the DAR.\",\n \"vDAR\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary value of the DAR payment.\",\n \"repEmi\": \"required; string; size 1..60; It identifies the Fisco representative who signed the avulsa document.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\"\n },\n \"dest\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"idEstrangeiro\": \"optional; string; size 2..20; It identifies a foreign recipient who does not hold a Brazilian CNPJ or CPF.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"indIEDest\": \"required; string; size 1; values: 1 (ICMS taxpayer), 2 (ICMS-exempt taxpayer), 9 (non-taxpayer); It classifies the recipient's ICMS tax registration status.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"ISUF\": \"optional; string; size 8..9; It carries the recipient's SUFRAMA registration number for incentive zone operations.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the recipient when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the recipient.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the recipient.\",\n \"enderDest\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the recipient's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the recipient's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the recipient (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the recipient's address.\",\n \"cMun\": \"required; string; size 7; It identifies the recipient's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the recipient's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the recipient's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the recipient's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the recipient's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the recipient's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the recipient's contact phone number.\"\n }\n },\n \"retirada\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"entrega\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"autXML\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\"\n },\n \"det\": [\n {\n \"nItem\": \"required; integer; range 1..990; It is the sequential line-item number within the NF-e.\",\n \"vItem\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total value of this line item.\",\n \"prod\": {\n \"cProd\": \"required; string; size 1..60; It carries the issuer's internal product or service code.\",\n \"cEAN\": \"required; string; It carries the product's GTIN barcode; use the literal 'SEM GTIN' when not applicable.\",\n \"cBarra\": \"optional; string; size 3..30; It carries an additional non-GTIN barcode for the product.\",\n \"xProd\": \"required; string; size 1..120; It describes the product or service in free text.\",\n \"NCM\": \"required; string; size 2..8; It classifies the product under the Mercosur Common Nomenclature (NCM/SH).\",\n \"NVE\": [\n \"optional; string; size 6; It carries the NVE (Nomenclatura de Valor Aduaneiro e Estatística) code for the product; repeatable 0..8 entries.\"\n ],\n \"CEST\": \"optional; string; size 7; It carries the CEST code identifying products subject to ICMS tax substitution.\",\n \"indEscala\": \"optional; string; size 1; values: S (relevant scale), N (not at relevant scale); It indicates whether the product is manufactured at commercially relevant scale.\",\n \"CNPJFab\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the manufacturer's CNPJ; required when indEscala=N.\",\n \"cBenef\": \"optional; string; size 8..10; It carries the fiscal benefit code (state or federal) applicable to the product.\",\n \"gCred\": {\n \"cCredPresumido\": \"required; string; It carries the classification code for the presumed credit applicable to this product.\",\n \"pCredPresumido\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the presumed credit rate as a percentage.\",\n \"vCredPresumido\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the calculated presumed credit monetary value.\"\n },\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"EXTIPI\": \"optional; string; size 2..3; It carries the TIPI exception code for the product when different from the base NCM.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"uCom\": \"required; string; size 1..6; It specifies the unit of measure used in the commercial transaction (e.g., UN, KG, CX).\",\n \"qCom\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity sold or transferred in commercial units.\",\n \"vUnCom\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price in the commercial transaction.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"cEANTrib\": \"required; string; It carries the taxable GTIN barcode; use 'SEM GTIN' when not applicable.\",\n \"cBarraTrib\": \"optional; string; size 3..30; It carries an additional non-GTIN taxable barcode.\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vUnTrib\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price for tax calculation purposes.\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"indTot\": \"required; string; size 1; values: 0 (not included in vProd total), 1 (included in vProd total); It controls whether the item value is summed into the document total.\",\n \"indBemMovelUsado\": \"optional; string; It flags the item as a used movable asset subject to specific ICMS rules.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"nItemPed\": \"optional; string; size 1..6; It identifies the specific line number within the buyer's purchase order.\",\n \"nFCI\": \"optional; string; size 36; It carries the GUID of the Import Content Form (FCI) for products with imported inputs.\",\n \"nRECOPI\": \"optional; string; size 20; It carries the RECOPI registration number for paper products subject to control.\",\n \"DI\": [\n {\n \"nDI\": \"required; string; size 1..12; It carries the import declaration number (DI, DSI, DA, or DIRE).\",\n \"dDI\": \"required; string; YYYY-MM-DD; It records the date the import declaration was registered at Receita Federal.\",\n \"xLocDesemb\": \"required; string; size 1..60; It describes the customs clearance location.\",\n \"UFDesemb\": \"required; string; size 2; It identifies the state where customs clearance took place.\",\n \"dDesemb\": \"required; string; YYYY-MM-DD; It records the date goods were cleared through customs.\",\n \"tpViaTransp\": \"required; string; size 2; values: 1 (maritime), 2 (river), 3 (lake), 4 (air), 5 (postal), 6 (rail), 7 (road), 8 (pipeline), 9 (own means), 10 (fictitious), 11 (courier), 12 (handcarry); It identifies the transport modality used to bring goods into Brazil.\",\n \"vAFRMM\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the AFRMM (marine freight renewal fee) amount.\",\n \"tpIntermedio\": \"required; string; size 1; values: 1 (own account import), 2 (import on behalf of third party), 3 (import by order); It identifies the legal relationship between the importer and the purchaser.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"UFTerceiro\": \"optional; string; size 2; It identifies the state of the acquiring or ordering party in a third-party import.\",\n \"cExportador\": \"required; string; size 1..60; It carries the exporter's identification code as registered in the import declaration.\",\n \"adi\": [\n {\n \"nAdicao\": \"optional; string; size 1..3; It identifies the addition number within the import declaration.\",\n \"nSeqAdic\": \"required; string; size 1..3; It carries the sequential number of this item within the DI addition.\",\n \"cFabricante\": \"required; string; size 1..60; It identifies the manufacturer as declared in the import addition.\",\n \"vDescDI\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount applied at the DI addition level.\",\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\"\n }\n ]\n }\n ],\n \"detExport\": {\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\",\n \"exportInd\": [\n {\n \"nRE\": \"required; string; size 12; It carries the Export Registry (Registro de Exportação) number.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e referencing the export.\",\n \"qExport\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity effectively exported.\"\n }\n ]\n },\n \"rastro\": [\n {\n \"nLote\": \"required; string; size 1..20; It carries the batch or lot number for product traceability.\",\n \"qLote\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity contained in the batch.\",\n \"dFab\": \"required; string; YYYY-MM-DD; It records the product's manufacturing date.\",\n \"dVal\": \"required; string; YYYY-MM-DD; It records the product's expiration or best-before date.\",\n \"cAgreg\": \"optional; string; size 1..20; It carries an aggregation code linking related batches or units.\"\n }\n ],\n \"infProdNFF\": {\n \"cProdFisco\": \"required; string; size 1..60; It carries the fiscal product code as defined by the tax authority for NFF documents.\",\n \"cOperNFF\": \"required; string; size 1..12; It carries the operation code used in NFF (Nota Fiscal Fácil) emission.\"\n },\n \"infProdEmb\": {\n \"xEmb\": \"required; string; size 1..8; It identifies the packaging type for the product.\",\n \"qVolEmb\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity of items per packaging unit.\",\n \"uEmb\": \"required; string; size 1..8; It specifies the unit of measure for the packaging.\"\n },\n \"veicProd\": {\n \"tpOp\": \"required; string; size 1; values: 1 (dealership sale), 2 (direct manufacturer/importer), 3 (rural sale), 4 (other); It identifies the vehicle sale channel.\",\n \"chassi\": \"required; string; size 17; It carries the vehicle chassis number (VIN).\",\n \"cCor\": \"required; string; size 1..4; It carries the manufacturer's color code for the vehicle.\",\n \"xCor\": \"required; string; size 1..40; It describes the vehicle color in free text.\",\n \"pot\": \"required; string; size 1..4; It states the engine power in CV (horsepower).\",\n \"cilin\": \"required; string; size 1..4; It states the engine displacement in cubic centimeters.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"tpComb\": \"required; string; size 2; It identifies the fuel type using the RENAVAM classification code.\",\n \"nMotor\": \"required; string; size 1..21; It carries the engine number of the vehicle.\",\n \"CMT\": \"required; string; size 1..9; It states the maximum towing capacity (CMT) in kg.\",\n \"dist\": \"required; string; size 1..4; It states the wheelbase distance in millimeters.\",\n \"anoMod\": \"required; string; size 4; It states the vehicle model year.\",\n \"anoFab\": \"required; string; size 4; It states the vehicle manufacturing year.\",\n \"tpPint\": \"required; string; size 1; It identifies the paint type using the RENAVAM code.\",\n \"tpVeic\": \"required; string; size 1..2; It classifies the vehicle type using the RENAVAM code.\",\n \"espVeic\": \"required; string; size 1; It identifies the vehicle species using the RENAVAM code.\",\n \"VIN\": \"required; string; size 1; values: R (restamped VIN), N (normal VIN); It indicates whether the vehicle identification number was restamped.\",\n \"condVeic\": \"required; string; size 1; values: 1 (complete), 2 (incomplete), 3 (semi-complete); It describes the vehicle's completion status at the time of sale.\",\n \"cMod\": \"required; string; size 4; It carries the vehicle model code as registered with DENATRAN/SENATRAN.\",\n \"cCorDENATRAN\": \"required; string; size 2; It carries the DENATRAN color code for the vehicle.\",\n \"lota\": \"required; string; size 1..3; It states the maximum passenger capacity (lotação) of the vehicle.\",\n \"tpRest\": \"required; string; size 1; values: 0 (none), 1 (chattel mortgage), 2 (leasing), 3 (reservation of title), 4 (vehicle lien), 9 (other); It identifies any legal restriction registered on the vehicle.\"\n },\n \"med\": {\n \"cProdANVISA\": \"required; string; size 13 or 'ISENTO'; It carries the ANVISA product registration number for medicines, or the literal 'ISENTO' for exempt products.\",\n \"xMotivoIsencao\": \"optional; string; size 1..255; It provides the legal justification for ANVISA registration exemption.\",\n \"vPMC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Maximum Consumer Price (PMC) as set by CMED.\"\n },\n \"arma\": [\n {\n \"tpArma\": \"required; string; size 1; values: 0 (permitted use), 1 (restricted use); It classifies the firearm by its permitted use category.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"nCano\": \"required; string; size 1..15; It carries the barrel number of the firearm.\",\n \"descr\": \"required; string; size 1..256; It describes the firearm characteristics in free text.\"\n }\n ],\n \"comb\": {\n \"cProdANP\": \"required; string; size 9; It carries the ANP product code identifying the fuel type.\",\n \"descANP\": \"required; string; size 2..95; It provides the fuel description as registered with ANP.\",\n \"pGLP\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of LPG (GLP) in the fuel mixture.\",\n \"pGNn\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of non-compressed natural gas (GNn) in the mixture.\",\n \"pGNi\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of imported natural gas (GNi) in the mixture.\",\n \"vPart\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the reference value per fuel unit for ICMS split calculation.\",\n \"CODIF\": \"optional; string; size 1..21; It carries the CODIF authorization code for interstate fuel operations.\",\n \"qTemp\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the fuel quantity at reference temperature (20°C).\",\n \"UFCons\": \"required; string; size 2; It identifies the state (UF) where the fuel will be consumed, for ICMS apportionment.\",\n \"pBio\": \"optional; decimal; max 100; It states the biodiesel percentage in the fuel.\",\n \"CIDE\": {\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCIDE\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total CIDE (fuel intervention contribution) amount.\"\n },\n \"encerrante\": {\n \"nBico\": \"required; string; size 1..3; It identifies the fuel pump nozzle number.\",\n \"nBomba\": \"optional; string; size 1..3; It identifies the pump number associated with the nozzle.\",\n \"nTanque\": \"required; string; size 1..3; It identifies the fuel storage tank number.\",\n \"vEncIni\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the start of the operation.\",\n \"vEncFin\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the end of the operation.\"\n },\n \"origComb\": [\n {\n \"indImport\": \"required; string; size 1; values: 0 (domestic), 1 (imported); It classifies the fuel origin for ICMS apportionment purposes.\",\n \"cUFOrig\": \"required; string; size 2; It identifies the state of origin of the fuel using the IBGE code.\",\n \"pOrig\": \"required; decimal; max 100; It states the percentage of fuel from this origin in the mixture.\"\n }\n ]\n }\n },\n \"serv\": {\n \"locPrest\": {\n \"cLocPrestacao\": \"required; string; size 7; It carries the 7-digit code of the municipality, maritime waters area (0000000), or road concession segment where the service was provided.\",\n \"cPaisPrestacao\": \"required; string; size 2; It carries the ISO country code of the country where the service was rendered (for cross-border services).\"\n },\n \"cServ\": {\n \"cTribNac\": \"required; string; size 6; It carries the national ISSQN taxation code under LC 116/2003, as defined in the national service list (Annex III of the NFS-e contributor guide).\",\n \"cTribMun\": \"optional; string; size 3; It carries the municipal ISSQN taxation code assigned by the municipality of tax incidence.\",\n \"xDescServ\": \"required; string; size 1..1000; It provides a complete free-text description of the service rendered.\",\n \"cNBS\": \"optional; string; size 9; It carries the Brazilian Nomenclature of Services (NBS 2.0) code corresponding to the service rendered.\",\n \"cIntContrib\": \"optional; string; size 1..20; It carries the issuer's internal code for identifying the DPS in their own system.\"\n },\n \"comExt\": {\n \"mdPrestacao\": \"required; string; size 1; values: 0 (unknown/not informed in source document), 1 (cross-border), 2 (consumption in Brazil), 3 (temporary movement of individuals), 4 (consumption abroad); It identifies the mode of provision for cross-border service transactions.\",\n \"vincPrest\": \"required; string; size 1; values: 0 (no relationship), 1 (controlled), 2 (controlling), 3 (affiliated), 4 (parent), 5 (branch/subsidiary), 6 (other relationship), 9 (unknown); It indicates the legal or economic relationship between the service provider and the taker.\",\n \"tpMoeda\": \"required; string; size 3; It carries the ISO currency code of the foreign currency used in the commercial transaction.\",\n \"vServMoeda\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the service value expressed in the foreign currency identified by tpMoeda.\",\n \"mecAFComexP\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 (ACC), 03 (ACE), 04 (BNDES-Exim post-shipment), 05 (BNDES-Exim pre-shipment), 06 (FGE), 07 (PROEX equalization), 08 (PROEX financing); It identifies the trade finance mechanism used by the service provider.\",\n \"mecAFComexT\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 to 26 (various mechanisms per MDIC table); It identifies the trade finance or exemption mechanism used by the service taker.\",\n \"movTempBens\": \"required; string; size 1; values: 0 (unknown), 1 (not linked), 2 (linked to import declaration), 3 (linked to export declaration); It indicates whether the service is linked to a temporary movement of goods.\",\n \"nDI\": \"optional; string; size 1..12; It carries the number of the import declaration (DI/DSI/DA/DRI-E) related to the service.\",\n \"nRE\": \"optional; string; size 12; It carries the number of the export registration (Registro de Exportação) related to the service.\",\n \"mdic\": \"required; string; size 1; values: 0 (do not send to MDIC), 1 (send to MDIC); It indicates whether this NFS-e should be made available to the Ministry of Trade (MDIC).\"\n },\n \"lsadppu\": {\n \"categ\": \"required; string; It carries the category code for the public lighting or special public utility service.\",\n \"objeto\": \"required; string; It describes the object or purpose of the public utility service.\",\n \"extensao\": \"optional; string; It states the physical extension or length of the public utility installation.\",\n \"nPostes\": \"optional; string; It states the number of lighting poles related to the public utility service.\"\n },\n \"obra\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the construction site or for IPTU collection.\",\n \"cObra\": \"required; string; size 1..30; It carries the construction site identification number — either the CNO (National Construction Registry) or the CEI (INSS Specific Registry).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the construction site address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the construction site address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the construction site is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the construction site is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the construction site address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the construction site address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the construction site.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the construction site address.\"\n }\n },\n \"atvEvento\": {\n \"xNome\": \"required; string; size 1..255; It provides the name of the artistic, cultural, or sports event.\",\n \"dtIni\": \"required; string; YYYY-MM-DD; It records the start date of the event activity.\",\n \"dtFim\": \"required; string; YYYY-MM-DD; It records the end date of the event activity.\",\n \"idAtvEvt\": \"required; string; size 1..30; It carries the event activity identifier assigned by the municipal tax authority.\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the event venue address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the event venue in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the event is held.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the event is held.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the event venue address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the event venue address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the event venue.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the event venue address.\"\n }\n },\n \"explRod\": {\n \"categVeic\": \"required; string; It identifies the vehicle category for road toll calculation purposes.\",\n \"nEixos\": \"required; string; It states the number of axles of the vehicle for toll classification.\",\n \"rodagem\": \"required; string; It identifies the wheel configuration (single or dual) of the vehicle.\",\n \"sentido\": \"required; string; It indicates the direction of travel on the road concession (e.g., northbound, southbound).\",\n \"placa\": \"required; string; It carries the vehicle license plate number for road toll identification.\",\n \"codAcessoPed\": \"optional; string; It carries the toll access code associated with this road exploitation service.\",\n \"codContrato\": \"optional; string; It carries the contract number governing the road concession exploitation.\"\n },\n \"imovel\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the real estate or for IPTU collection.\",\n \"cCIB\": \"required; string; size 8; It carries the Brazilian Real Estate Registry code (Cadastro Imobiliário Brasileiro — CIB).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the property address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the property address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the property is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the property is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the property address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the property address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the property.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the property address.\"\n }\n },\n \"infoCompl\": {\n \"idDocTec\": \"optional; string; size 1..40; It carries the identifier of the technical responsibility document (ART, RRT, DRT, or other) associated with this service.\",\n \"docRef\": \"optional; string; size 1..255; It carries the key, number, or contract identifier of a document issued by the service provider that supports the issuance of this NFS-e by the taker or intermediary.\",\n \"xInfComp\": \"optional; string; size 1..2000; It provides free-text complementary information about the service, available to all service codes.\"\n },\n \"valores\": {\n \"vServPrest\": {\n \"vReceb\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monetary amount received by the service intermediary (R$).\",\n \"vServ\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total monetary value of the service rendered (R$).\"\n },\n \"vDescCondIncond\": {\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount (R$) granted to the service taker.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount (R$) dependent on specific conditions agreed between the parties.\"\n },\n \"vDedRed\": {\n \"pDR\": \"required; decimal; 3 integer + 2 decimal; It carries the percentage rate applied to the service value to calculate the ISSQN base reduction.\",\n \"vDR\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary amount used as a standard deduction or reduction of the service value for ISSQN base calculation purposes (R$).\",\n \"documentos\": {\n \"docDedRed\": [\n {\n \"chNFSe\": \"required; string; size 1..50; It carries the access key of the NFS-e (national standard) used as a deduction or reduction document in the ISSQN base calculation.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e used as a deduction or reduction document in the ISSQN base calculation.\"\n }\n ]\n }\n }\n }\n },\n \"imposto\": {\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\",\n \"ICMS\": {\n \"ICMS00\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\"\n },\n \"ICMS02\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\"\n },\n \"ICMS10\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS15\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemICMSReten\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate subject to withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"pRedAdRem\": \"optional; decimal; max 100; 3 integer + 2 decimal; It states the ad rem rate reduction percentage.\",\n \"motRedAdRem\": \"optional; string; It carries the reason code for the ad rem rate reduction.\"\n },\n \"ICMS20\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS30\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS40\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS51\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\"\n },\n \"ICMS53\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMonoOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSMonoDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred monophase ICMS amount.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoDif\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the deferred taxable quantity in the monophase regime.\",\n \"adRemICMSDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the deferred ad rem ICMS rate.\"\n },\n \"ICMS60\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMS61\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate previously retained.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\"\n },\n \"ICMS70\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS90\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMSPart\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pBCOp\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS base allocated to the operation state.\",\n \"UFST\": \"required; string; size 2; It identifies the destination state (UF) for ICMS-ST split.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMSST\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"vBCSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST base in the destination state.\",\n \"vICMSSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount in the destination state.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN101\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN102\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\"\n },\n \"ICMSSN201\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN202\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\"\n },\n \"ICMSSN500\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN900\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n }\n },\n \"ICMSUFDest\": {\n \"vBCUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS calculation base in the destination state (EC 87/2015).\",\n \"vBCFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base in the destination state.\",\n \"pFCPUFDest\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP rate in the destination state.\",\n \"pICMSUFDest\": \"required; decimal; 3 integer + 2..4 decimal; It states the internal ICMS rate of the destination state.\",\n \"pICMSInter\": \"required; string; size 4; values: 4.00 or 12.00; It states the interstate ICMS rate applicable to the operation (4% or 12%).\",\n \"pICMSInterPart\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS differential allocated to the destination state.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\"\n },\n \"IPI\": {\n \"CNPJProd\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the producer's CNPJ when different from the document issuer, for IPI purposes.\",\n \"cSelo\": \"optional; string; size 1..60; It carries the IPI control stamp code.\",\n \"qSelo\": \"optional; string; size 1..6; It states the quantity of IPI control stamps applied.\",\n \"cEnq\": \"required; string; size 3; It carries the IPI classification/framework code.\",\n \"IPITrib\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pIPI\": \"optional; decimal; 3 integer + 2..4 decimal; It states the IPI rate as a percentage.\",\n \"qUnid\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity in the IPI taxable unit.\",\n \"vUnid\": \"optional; decimal; 15 digits: 11 integer + 4 decimal; It states the IPI specific rate per taxable unit.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\"\n },\n \"IPINT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n }\n },\n \"II\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vDespAdu\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the customs handling fees (despesas aduaneiras) amount.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIOF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IOF (financial operations tax) amount levied on the import.\"\n },\n \"ISSQN\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vAliq\": \"required; decimal; 3 integer + 2..4 decimal; It states the ISS/ISSQN rate as a percentage.\",\n \"vISSQN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount due.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cListServ\": \"required; string; size 1..5; It identifies the service under the LC 116/2003 national service list.\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"indISS\": \"required; string; size 1; values: 1 (due), 2 (non-incidence), 3 (exempt), 4 (export), 5 (immunity), 6 (suspended by court order), 7 (suspended by administrative process); It classifies the ISS applicability status for this service.\",\n \"cServico\": \"optional; string; It carries the municipality's internal service classification code.\",\n \"cMun\": \"optional; string; size 7; It identifies the municipality where the service is provided, using the IBGE code.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for exported services.\",\n \"nProcesso\": \"optional; string; size 1..30; It carries the administrative or judicial process number related to ISS suspension.\",\n \"indIncentivo\": \"required; string; size 1; values: 1 (yes), 2 (no); It indicates whether the service benefits from a municipal ISS fiscal incentive.\"\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"PISOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n }\n },\n \"PISST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"indSomaPISST\": \"optional; string; size 1; It indicates whether the PIS-ST amount should be added to the item total.\"\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"COFINSOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n }\n },\n \"COFINSST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"indSomaCOFINSST\": \"optional; string; size 1; It indicates whether the COFINS-ST amount should be added to the item total.\"\n },\n \"IS\": {\n \"CSTIS\": \"required; string; size 3; pattern [0-9]{3}; Tax situation code for the Selective Tax (IS).\",\n \"cClassTribIS\": \"required; string; size 6; pattern [0-9]{6}; Tax classification code for IS.\",\n \"vBCIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; IS tax calculation base amount.\",\n \"pIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS rate as a percentage.\",\n \"adRemIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS specific rate (ad rem, per unit).\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Calculated IS amount.\"\n },\n \"IBSCBS\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"cClassTrib\": \"required; string; size 6; pattern [0-9]{6}; IBS/CBS tax classification code.\",\n \"indDoacao\": \"optional; string; size 1; fixed value 1; Indicates the operation is a donation.\",\n \"indDest\": \"required; string; size 1; values: 0 (the recipient is the same person as the taker identified in the NFS-e), 1 (the recipient is a different person or a different establishment from the taker); It indicates whether the service recipient is the same party as the acquiring taker.\",\n \"gIBSCBS\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"gIBSUF\": {\n \"pIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate as a percentage.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage (LC 214/25 art. 118).\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount (cashback on the invoice).\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate as a percentage.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gCBS\": {\n \"pCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate as a percentage.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n },\n \"gALCZFMCBS\": {\n \"_comment\": \"optional — ZFM/ALC incentive area CBS zero-rate group (NF-e variant)\",\n \"tpALCZFMCBS\": \"required; string; size 1; values: 1 (with Suframa-approved process), 2 (without approved process); Type of CBS zero-rate application in incentive areas.\",\n \"nProcSuframa\": \"optional; string; size 8..12; Suframa process number for the commercialized item.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; Reference CBS effective rate outside the incentive area.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value calculated outside the incentive area.\"\n }\n },\n \"gTribRegular\": {\n \"CSTReg\": \"required; string; size 3; CST that would apply without the condition.\",\n \"cClassTribReg\": \"required; string; size 6; cClassTrib that would apply without the condition.\",\n \"pAliqEfetRegIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state effective rate without condition.\",\n \"vTribRegIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value without condition.\",\n \"pAliqEfetRegIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal effective rate without condition.\",\n \"vTribRegIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value without condition.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS effective rate without condition.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value without condition.\"\n },\n \"gTribCompraGov\": {\n \"pAliqIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate before Art. 473 LC 214/2025 reduction.\",\n \"vTribIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value before Art. 473 reduction.\",\n \"pAliqIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate before Art. 473 reduction.\",\n \"vTribIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value before Art. 473 reduction.\",\n \"pAliqCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate before Art. 473 reduction.\",\n \"vTribCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value before Art. 473 reduction.\"\n }\n },\n \"gIBSCBSMono\": {\n \"gMonoPadrao\": {\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate.\",\n \"adRemCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate.\",\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase IBS amount.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase CBS amount.\"\n },\n \"gMonoReten\": {\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemIBSReten\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate subject to withholding.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS amount subject to withholding.\",\n \"adRemCBSReten\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount subject to withholding.\"\n },\n \"gMonoRet\": {\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemIBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld IBS ad rem rate.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld IBS amount.\",\n \"adRemCBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld CBS ad rem rate.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld CBS amount.\"\n },\n \"gMonoDif\": {\n \"pDifIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS deferral percentage.\",\n \"vIBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred IBS monophase amount.\",\n \"pDifCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS deferral percentage.\",\n \"vCBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred CBS monophase amount.\"\n },\n \"vTotIBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS for the item.\",\n \"vTotCBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS for the item.\"\n },\n \"gTransfCred\": {\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be transferred.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be transferred.\"\n },\n \"gAjusteCompet\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS adjustment amount.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS adjustment amount.\"\n }\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be reversed.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be reversed.\"\n },\n \"gCredPresOper\": {\n \"vBCCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit calculation base.\",\n \"cCredPres\": \"required; string; size 2; pattern [0-9]{2}; Presumed credit classification code.\",\n \"gIBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n },\n \"gCBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n }\n },\n \"gCredPresIBSZFM\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"vCredPresIBSZFM\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit amount calculated on the net debit balance.\"\n }\n },\n \"impostoDevol\": {\n \"pDevol\": \"required; decimal; max 100; 3 integer + 2 decimal; It states the percentage of IPI being returned in a product return operation.\",\n \"IPI\": {\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\"\n }\n },\n \"infAdProd\": \"optional; string; size 1..500; It provides free-text additional information about the product, which is printed on the DANFE.\",\n \"obsItem\": {\n \"obsCont\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n },\n \"obsFisco\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n },\n \"DFeReferenciado\": {\n \"chaveAcesso\": \"required; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}\",\n \"nItem\": \"optional; string; size 1..3\"\n }\n }\n ],\n \"total\": {\n \"ICMSTot\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"vST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total ICMS-ST amount.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\",\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vNF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total document value (net amount due).\",\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\"\n },\n \"ISSQNtot\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vISS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total ISSQN amount for the document.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"dCompet\": \"required; string; YYYY-MM-DD; It indicates the ISS competence date (month of service provision).\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"cRegTrib\": \"optional; string; size 1; values: 1 (Simples Nacional), 2 (estimate), 3 (professional partnership), 4 (cooperative), 5 (ME/EPP Simples Nacional), 6 (ME/EPP Simples Nacional excess); It identifies the ISS tax regime of the service provider.\"\n },\n \"retTrib\": {\n \"vRetPIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount withheld at source.\",\n \"vRetCOFINS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount withheld at source.\",\n \"vRetCSLL\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the CSLL amount withheld at source.\",\n \"vBCIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF (income tax at source) calculation base.\",\n \"vIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF amount withheld at source.\",\n \"vBCRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security withholding (INSS) calculation base.\",\n \"vRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security (INSS) amount withheld at source.\"\n },\n \"ISTot\": {\n \"vIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total Selective Tax (IS) amount for the document.\"\n },\n \"IBSCBSTot\": {\n \"vBCIBSCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS/CBS calculation base.\",\n \"gIBS\": {\n \"gIBSUF\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred state IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS tax refunds.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS amount.\"\n },\n \"gIBSMun\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred municipal IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS tax refunds.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS amount.\"\n },\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit under suspensive condition.\"\n },\n \"gCBS\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred CBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS tax refunds.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS amount.\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit under suspensive condition.\"\n },\n \"gMono\": {\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS subject to withholding.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase IBS.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase CBS.\"\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed IBS credit.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed CBS credit.\"\n }\n },\n \"vNFTot\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the grand total document value including IBS, CBS, and IS amounts.\"\n },\n \"transp\": {\n \"modFrete\": \"required; string; size 1; values: 0 (issuer's account CIF), 1 (recipient's account FOB), 2 (third-party account), 3 (issuer's own transport), 4 (recipient's own transport), 9 (no freight); It specifies who is responsible for the freight costs.\",\n \"transporta\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"xEnder\": \"optional; string; size 1..60; It provides the carrier's address in free text.\",\n \"xMun\": \"optional; string; size 2..60; It provides the carrier's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\"\n },\n \"retTransp\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBCRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport calculation base.\",\n \"pICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-transport withholding rate as a percentage.\",\n \"vICMSRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport withheld amount.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\"\n },\n \"veicTransp\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\"\n },\n \"reboque\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\",\n \"vagao\": \"optional; string; size 1..20; It carries the rail wagon identification for rail transport.\",\n \"balsa\": \"optional; string; size 1..20; It carries the barge identification for river transport.\"\n },\n \"vol\": [\n {\n \"qVol\": \"optional; string; size 1..15; It states the number of packages/volumes.\",\n \"esp\": \"optional; string; size 1..60; It describes the type of package/volume (e.g., caixa, fardo).\",\n \"marca\": \"optional; string; size 1..60; It carries the brand or mark of the packages.\",\n \"nVol\": \"optional; string; size 1..60; It carries the volume numbering or identification.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"lacres\": [\n {\n \"nLacre\": \"required; string; size 1..60; It carries the seal (lacre) number applied to the cargo.\"\n }\n ]\n }\n ]\n },\n \"cobr\": {\n \"fat\": {\n \"nFat\": \"optional; string; size 1..60; It carries the invoice (fatura) number for billing control.\",\n \"vOrig\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the original invoice amount before any discounts.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vLiq\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the net invoice amount after discounts.\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional; string; size 1..60; It identifies the installment (duplicata) number within the invoice.\",\n \"dVenc\": \"optional; string; YYYY-MM-DD; It records the due date for this installment.\",\n \"vDup\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the face value of this installment.\"\n }\n ]\n },\n \"pag\": {\n \"detPag\": [\n {\n \"indPag\": \"optional; string; size 1; values: 0 (cash/à vista), 1 (installment/à prazo); It indicates the payment timing condition.\",\n \"tPag\": \"required; string; size 2; values: 01 (cash), 02 (cheque), 03 (credit card), 04 (debit card), 05 (store credit), 10 (meal voucher), 11 (food voucher), 12 (gift card), 13 (fuel voucher), 14 (trade bill/duplicata), 15 (bank slip/boleto), 16 (bank deposit), 17 (PIX), 18 (wire transfer), 19 (cashback), 90 (no payment), 99 (other); It identifies the payment method used.\",\n \"xPag\": \"optional; string; size 2..60; It provides a description when tPag=99 (other payment method).\",\n \"vPag\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the amount paid using this payment method.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\",\n \"CNPJPag\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the bank or payment institution processing this payment.\",\n \"UFPag\": \"optional; string; size 2; It identifies the state (UF) of the payment institution.\",\n \"card\": {\n \"tpIntegra\": \"required; string; size 1; values: 1 (integrated TEF), 2 (non-integrated); It indicates whether the card payment was processed through an integrated electronic payment terminal.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"tBand\": \"optional; string; size 2; values: 01 (Visa), 02 (Mastercard), 03 (Amex), 04 (Sorocred), 05 (Diners), 06 (Elo), 07 (Hipercard), 08 (Aura), 09 (Cabal), 99 (other); It identifies the card network/brand.\",\n \"cAut\": \"optional; string; size 1..20; It carries the card transaction authorization code.\",\n \"CNPJReceb\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the payment recipient's CNPJ, which may differ from the document issuer.\",\n \"idTermPag\": \"optional; string; size 1..40; It carries the payment terminal identifier.\"\n }\n }\n ],\n \"vTroco\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the change amount returned to the customer (NFC-e).\"\n },\n \"infIntermed\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"idCadIntTran\": \"required; string; size 2..60; It carries the intermediary's registration ID on the digital platform.\"\n },\n \"infAdic\": {\n \"infAdFisco\": \"optional; string; size 1..2000; It contains additional fiscal information required by the tax authority, printed on the DANFE.\",\n \"infCpl\": \"optional; string; size 1..5000; It contains complementary information added by the issuer, printed on the DANFE.\",\n \"obsCont\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"obsFisco\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"required; string; size 1..60; It carries the administrative or judicial process number referenced.\",\n \"indProc\": \"required; string; size 1; values: 0 (SEFAZ), 1 (Federal Court), 2 (State Court), 3 (SECEX/RFB), 9 (other); It identifies the type of process or authority issuing the referenced act.\",\n \"tpAto\": \"optional; string; size 2; values: 08 (summons), 10 (decision), 12 (sentence), 15 (court ruling/acórdão); It classifies the type of legal act referenced.\"\n }\n ]\n },\n \"exporta\": {\n \"UFSaidaPais\": \"required; string; size 2; It identifies the Brazilian state through which the exported goods will exit the country.\",\n \"xLocExporta\": \"required; string; size 1..60; It describes the export customs clearance location in free text.\",\n \"xLocDespacho\": \"optional; string; size 1..60; It describes the goods dispatch location for export purposes.\"\n },\n \"compra\": {\n \"xNEmp\": \"optional; string; size 1..17; It carries the purchase order or budget note number from the buyer.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"xCont\": \"optional; string; size 1..60; It carries the contract number associated with this purchase.\"\n },\n \"cana\": {\n \"safra\": \"required; string; size 4..9; It identifies the sugarcane harvest (safra) reference period.\",\n \"ref\": \"required; string; size 7; format AAMM; It indicates the year-month reference for the sugarcane supply.\",\n \"forDia\": [\n {\n \"dia\": \"required; string; size 1..2; It identifies the calendar day within the supply month.\",\n \"qtde\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the sugarcane quantity supplied on this day.\"\n }\n ],\n \"qTotMes\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied in the current month.\",\n \"qTotAnt\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the cumulative sugarcane quantity supplied in prior months of this harvest.\",\n \"qTotGer\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied across the entire harvest period.\",\n \"deduc\": [\n {\n \"xDed\": \"required; string; size 1..60; It describes the deduction type applied to the sugarcane supply value.\",\n \"vDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the deduction amount.\"\n }\n ],\n \"vFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross supply value before deductions.\",\n \"vTotDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total deductions applied.\",\n \"vLiqFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the net supply value after all deductions.\"\n },\n \"infRespTec\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xContato\": \"required; string; size 2..60; It provides the name of the technical contact person at the responsible company.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"idCSRT\": \"optional; string; size 2; It carries the two-digit identifier of the CSRT security token.\",\n \"hashCSRT\": \"optional; string; size 28; It carries the SHA-1 hash of the CSRT token concatenated with the NF-e access key, encoded in base64.\"\n },\n \"infSolicNFF\": {\n \"xSolic\": \"required; string; size 2..1000; It carries the NFF request information in free text.\"\n },\n \"agropecuario\": {\n \"defensivo\": [\n {\n \"nReceituario\": \"required; string; size 1..20; It carries the prescription number issued by the agronomist for the pesticide.\",\n \"CPFRespTec\": \"required; string; size 11; pattern [0-9]{11}; It identifies the agronomist or technician who prescribed the pesticide by their CPF.\"\n }\n ],\n \"guiaTransito\": {\n \"tpGuia\": \"required; string; size 2; values: 01 (animal transit), 02 (plant transit); It classifies the transit permit type for agricultural products.\",\n \"UFGuia\": \"required; string; size 2; It identifies the state that issued the transit permit.\",\n \"serieGuia\": \"optional; string; size 1..9; It carries the series number of the transit permit.\",\n \"nGuia\": \"required; string; size 1..20; It carries the transit permit number.\"\n }\n },\n \"infPAA\": {\n \"CNPJPAA\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the Signature and Authorization Provider (PAA) by their CNPJ.\",\n \"PAASignature\": {\n \"SignatureValue\": \"required; string; base64-encoded binary; It carries the PAA's digital signature value.\",\n \"RSAKeyValue\": \"required; object; It contains the RSA public key (Modulus and Exponent) used to verify the PAA signature.\"\n }\n }\n },\n \"infNFeSupl\": {\n \"qrCode\": \"required; string; size 1..1000; It carries the QR Code URL string for NFC-e consumer verification.\",\n \"urlChave\": \"required; string; size 1..85; It carries the URL for NFC-e access key consultation.\"\n },\n \"Signature\": \"required; object; It contains the XML-DSig digital signature of the NF-e, ensuring document integrity and authenticity.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/event/{tpEvento}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invoice authorization event was started\",\n \"requestId\": \"0197c1fa-e355-73f8-bb6f-9a7841c74207\"\n}"},{"id":"7f8e9614-0eed-46ff-a23b-f41ab260f53d","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"accountId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"NFe\": {\n \"infNFe\": {\n \"_attr_Id\": \"required; string; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It uniquely identifies the NF-e by its 44-character access key, embedded as an XML attribute.\",\n \"_attr_versao\": \"required; string; It specifies the NF-e schema version used in the document.\",\n \"ide\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"cNF\": \"required; string; size 8; It carries an 8-digit random numeric code used as part of the NF-e access key composition.\",\n \"natOp\": \"required; string; size 1..60; It informs the nature of the operation in free text (e.g., 'Venda de mercadoria', 'Devolução').\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\",\n \"dhEmi\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the NF-e was issued.\",\n \"dhSaiEnt\": \"optional; string; YYYY-MM-DDThh:mm:ssTZD; It indicates the date and time of goods departure (outbound) or receipt (inbound).\",\n \"dPrevEntrega\": \"optional; string; YYYY-MM-DD; It informs the expected delivery date of the goods to the recipient.\",\n \"dCompet\": \"optional; string; YYYY-MM-DD; It provides the date of competence of the operation for service operations (NFS-e).\",\n \"tpNF\": \"required; string; size 1; values: 0 (inbound/entrada), 1 (outbound/saída); It indicates the direction of the operation.\",\n \"idDest\": \"required; string; size 1; values: 1 (within the same state), 2 (interstate), 3 (international); It classifies the geographic scope of the operation.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cMunFGIBS\": \"optional; string; size 7; It identifies the municipality of the IBS taxable event when different from cMunFG, using the IBGE code.\",\n \"tpImp\": \"required; string; size 1; values: 0 (no DANFE), 1 (portrait), 2 (landscape), 3 (simplified), 4 (NFC-e), 5 (NFC-e electronic message); It specifies the DANFE print format.\",\n \"tpEmis\": \"required; string; size 1; values: 1 (normal), 2 (FS contingency), 3 (SVC-AN), 4 (SVC-RS), 5 (FS-DA contingency), 6 (SVC-AN alt), 7 (SVC-RS alt), 9 (NFC-e offline); It identifies the emission mode, distinguishing normal from contingency.\",\n \"cDV\": \"required; string; size 1; It is the check digit of the 44-character NF-e access key, calculated using modulo 11.\",\n \"tpAmb\": \"required; string; size 1; values: 1 (production), 2 (homologation/testing); It indicates the environment in which the NF-e is being issued.\",\n \"finNFe\": \"required; string; size 1; values: 1 (normal NF-e), 2 (complementary), 3 (adjustment), 4 (return/devolution); It defines the fiscal purpose of the document.\",\n \"tpNFDebito\": \"optional; string; It classifies the debit NF-e type as defined by the tax authority.\",\n \"tpNFCredito\": \"optional; string; It classifies the credit NF-e type as defined by the tax authority.\",\n \"indFinal\": \"required; string; size 1; values: 0 (not a final consumer), 1 (final consumer); It indicates whether the recipient is the end consumer of the goods.\",\n \"indPres\": \"required; string; size 1; values: 0 (not applicable), 1 (in-person), 2 (internet), 3 (telephone service), 4 (NFC-e home delivery), 5 (in-person outside the establishment), 9 (other); It indicates whether the buyer was physically present at the point of sale.\",\n \"indIntermed\": \"optional; string; size 1; values: 0 (no intermediary), 1 (with intermediary/marketplace); It flags whether the operation was conducted through a digital marketplace or platform.\",\n \"cIndOp\": \"optional; string; size 1..6; It carries the operation indicator code as defined by the issuer's internal or industry classification.\",\n \"procEmi\": \"required; string; size 1; values: 0 (taxpayer application), 1 (standalone by Fisco), 2 (SCAN/DPEC standalone), 3 (taxpayer app provided by Fisco); It identifies which process and software were used to generate the NF-e.\",\n \"verProc\": \"required; string; size 1..20; It records the version of the application or process used to emit the NF-e.\",\n \"dhCont\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the contingency mode was activated.\",\n \"xJust\": \"required; string; size 15..256; It provides the mandatory justification text explaining why contingency emission was used.\",\n \"tpEmit\": \"required; string; size 1; values: 1 (service provider/prestador), 2 (service taker/tomador), 3 (intermediary/intermediário); It identifies who is issuing the DPS/NFS-e.\",\n \"cMotivoEmisTI\": \"optional; string; size 1; values: 1 (service import), 2 (taker/intermediary required by municipal law), 3 (taker/intermediary issuing due to provider refusal), 4 (taker/intermediary rejecting provider's NFS-e); It indicates the reason why the taker or intermediary is issuing the DPS instead of the service provider.\",\n \"chNFSeRej\": \"optional; string; size 1..50; It carries the access key of the NFS-e previously rejected by the taker or intermediary, referenced when cMotivoEmisTI=4.\",\n \"cLocEmi\": \"required; string; size 7; It carries the 7-digit IBGE code of the municipality that authorized the issuance of this NFS-e.\",\n \"subst\": {\n \"chSubstda\": \"required; string; size 1..50; It carries the access key of the NFS-e being substituted.\",\n \"cMotivo\": \"required; string; size 1; values: 1 (opt-out of Simples Nacional), 2 (opt-in to Simples Nacional), 3 (retroactive inclusion of immunity/exemption), 4 (retroactive exclusion of immunity/exemption), 5 (rejection by taker or intermediary), 99 (other); It indicates the reason for substituting the NFS-e.\",\n \"xMotivo\": \"optional; string; size 15..255; It provides a free-text description of the substitution reason when cMotivo=99.\"\n },\n \"NFref\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\",\n \"refNFeSig\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e (simplified model) by its access key.\",\n \"refNF\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refNFP\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refCTe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a CT-e (transport document) related to this NF-e by its access key.\",\n \"refECF\": {\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"nECF\": \"required; string; size 3; It identifies the ECF (electronic cash register) equipment number.\",\n \"nCOO\": \"required; string; size 6; It carries the Counter of Fiscal Operations (COO) from the referenced ECF receipt.\"\n }\n }\n ],\n \"gCompraGov\": {\n \"tpEnteGov\": \"required; string; size 1; values: 1 (Union/Federal), 2 (State), 3 (Federal District), 4 (Municipality), 5 (Public Consortium), 6 (IBS Management Committee); It identifies the type of government entity involved in the purchase.\",\n \"pRedutor\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the IBS/CBS rate reduction percentage applicable to government purchases.\",\n \"tpOperGov\": \"required; string; size 1; values: 1 (supply with later payment), 2 (payment received, supply already done), 3 (supply with payment already made), 4 (payment received, supply pending); It identifies the operational sequence of a government purchase.\",\n \"refDFeAnt\": \"optional; string; size 44; repeatable 0..99; pattern [0-9]{6}[A-Z0-9]{12}[0-9]{26}; It references previous fiscal documents for tpOperGov 2 or 3.\"\n },\n \"gPagAntecipado\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\"\n }\n ]\n },\n \"emit\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"xFant\": \"optional; string; size 1..60; It provides the trade name or fantasy name used by the issuer commercially.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"IEST\": \"optional; string; size 2..14; It carries the state tax registration for ICMS tax substitution in a state different from the issuer's.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"CNAE\": \"optional; string; size 7; It identifies the issuer's primary economic activity using the CNAE classification code.\",\n \"CRT\": \"required; string; size 1; values: 1 (Simples Nacional), 2 (Simples Nacional — excess revenue), 3 (Normal Regime), 4 (Simples Nacional SIMEI); It identifies the tax regime of the issuer.\",\n \"ISUFEmit\": \"optional; string; size 8..9; It carries the issuer's SUFRAMA registration number for operations in incentive zones (ZFM/ALC).\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the issuer when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the issuer.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the issuer.\",\n \"enderEmit\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the issuer's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the issuer's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the issuer (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the issuer's address.\",\n \"cMun\": \"required; string; size 7; It identifies the issuer's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the issuer's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the issuer's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"required; string; size 8; It carries the issuer's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the issuer's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the issuer's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the issuer's contact phone number.\"\n }\n },\n \"avulsa\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xOrgao\": \"required; string; size 1..60; It names the tax authority that issued the standalone NF-e.\",\n \"matr\": \"required; string; size 1..60; It carries the registration number of the tax agent who authorized the avulsa NF-e.\",\n \"xAgente\": \"required; string; size 1..60; It provides the full name of the tax agent responsible for the avulsa NF-e.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\",\n \"nDAR\": \"optional; string; size 1..60; It carries the DAR (tax collection document) number related to the avulsa emission.\",\n \"dEmi\": \"optional; string; YYYY-MM-DD; It records the issuance date of the DAR.\",\n \"vDAR\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary value of the DAR payment.\",\n \"repEmi\": \"required; string; size 1..60; It identifies the Fisco representative who signed the avulsa document.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\"\n },\n \"dest\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"idEstrangeiro\": \"optional; string; size 2..20; It identifies a foreign recipient who does not hold a Brazilian CNPJ or CPF.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"indIEDest\": \"required; string; size 1; values: 1 (ICMS taxpayer), 2 (ICMS-exempt taxpayer), 9 (non-taxpayer); It classifies the recipient's ICMS tax registration status.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"ISUF\": \"optional; string; size 8..9; It carries the recipient's SUFRAMA registration number for incentive zone operations.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the recipient when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the recipient.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the recipient.\",\n \"enderDest\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the recipient's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the recipient's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the recipient (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the recipient's address.\",\n \"cMun\": \"required; string; size 7; It identifies the recipient's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the recipient's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the recipient's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the recipient's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the recipient's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the recipient's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the recipient's contact phone number.\"\n }\n },\n \"retirada\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"entrega\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"autXML\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\"\n },\n \"det\": [\n {\n \"nItem\": \"required; integer; range 1..990; It is the sequential line-item number within the NF-e.\",\n \"vItem\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total value of this line item.\",\n \"prod\": {\n \"cProd\": \"required; string; size 1..60; It carries the issuer's internal product or service code.\",\n \"cEAN\": \"required; string; It carries the product's GTIN barcode; use the literal 'SEM GTIN' when not applicable.\",\n \"cBarra\": \"optional; string; size 3..30; It carries an additional non-GTIN barcode for the product.\",\n \"xProd\": \"required; string; size 1..120; It describes the product or service in free text.\",\n \"NCM\": \"required; string; size 2..8; It classifies the product under the Mercosur Common Nomenclature (NCM/SH).\",\n \"NVE\": [\n \"optional; string; size 6; It carries the NVE (Nomenclatura de Valor Aduaneiro e Estatística) code for the product; repeatable 0..8 entries.\"\n ],\n \"CEST\": \"optional; string; size 7; It carries the CEST code identifying products subject to ICMS tax substitution.\",\n \"indEscala\": \"optional; string; size 1; values: S (relevant scale), N (not at relevant scale); It indicates whether the product is manufactured at commercially relevant scale.\",\n \"CNPJFab\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the manufacturer's CNPJ; required when indEscala=N.\",\n \"cBenef\": \"optional; string; size 8..10; It carries the fiscal benefit code (state or federal) applicable to the product.\",\n \"gCred\": {\n \"cCredPresumido\": \"required; string; It carries the classification code for the presumed credit applicable to this product.\",\n \"pCredPresumido\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the presumed credit rate as a percentage.\",\n \"vCredPresumido\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the calculated presumed credit monetary value.\"\n },\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"EXTIPI\": \"optional; string; size 2..3; It carries the TIPI exception code for the product when different from the base NCM.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"uCom\": \"required; string; size 1..6; It specifies the unit of measure used in the commercial transaction (e.g., UN, KG, CX).\",\n \"qCom\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity sold or transferred in commercial units.\",\n \"vUnCom\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price in the commercial transaction.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"cEANTrib\": \"required; string; It carries the taxable GTIN barcode; use 'SEM GTIN' when not applicable.\",\n \"cBarraTrib\": \"optional; string; size 3..30; It carries an additional non-GTIN taxable barcode.\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vUnTrib\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price for tax calculation purposes.\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"indTot\": \"required; string; size 1; values: 0 (not included in vProd total), 1 (included in vProd total); It controls whether the item value is summed into the document total.\",\n \"indBemMovelUsado\": \"optional; string; It flags the item as a used movable asset subject to specific ICMS rules.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"nItemPed\": \"optional; string; size 1..6; It identifies the specific line number within the buyer's purchase order.\",\n \"nFCI\": \"optional; string; size 36; It carries the GUID of the Import Content Form (FCI) for products with imported inputs.\",\n \"nRECOPI\": \"optional; string; size 20; It carries the RECOPI registration number for paper products subject to control.\",\n \"DI\": [\n {\n \"nDI\": \"required; string; size 1..12; It carries the import declaration number (DI, DSI, DA, or DIRE).\",\n \"dDI\": \"required; string; YYYY-MM-DD; It records the date the import declaration was registered at Receita Federal.\",\n \"xLocDesemb\": \"required; string; size 1..60; It describes the customs clearance location.\",\n \"UFDesemb\": \"required; string; size 2; It identifies the state where customs clearance took place.\",\n \"dDesemb\": \"required; string; YYYY-MM-DD; It records the date goods were cleared through customs.\",\n \"tpViaTransp\": \"required; string; size 2; values: 1 (maritime), 2 (river), 3 (lake), 4 (air), 5 (postal), 6 (rail), 7 (road), 8 (pipeline), 9 (own means), 10 (fictitious), 11 (courier), 12 (handcarry); It identifies the transport modality used to bring goods into Brazil.\",\n \"vAFRMM\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the AFRMM (marine freight renewal fee) amount.\",\n \"tpIntermedio\": \"required; string; size 1; values: 1 (own account import), 2 (import on behalf of third party), 3 (import by order); It identifies the legal relationship between the importer and the purchaser.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"UFTerceiro\": \"optional; string; size 2; It identifies the state of the acquiring or ordering party in a third-party import.\",\n \"cExportador\": \"required; string; size 1..60; It carries the exporter's identification code as registered in the import declaration.\",\n \"adi\": [\n {\n \"nAdicao\": \"optional; string; size 1..3; It identifies the addition number within the import declaration.\",\n \"nSeqAdic\": \"required; string; size 1..3; It carries the sequential number of this item within the DI addition.\",\n \"cFabricante\": \"required; string; size 1..60; It identifies the manufacturer as declared in the import addition.\",\n \"vDescDI\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount applied at the DI addition level.\",\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\"\n }\n ]\n }\n ],\n \"detExport\": {\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\",\n \"exportInd\": [\n {\n \"nRE\": \"required; string; size 12; It carries the Export Registry (Registro de Exportação) number.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e referencing the export.\",\n \"qExport\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity effectively exported.\"\n }\n ]\n },\n \"rastro\": [\n {\n \"nLote\": \"required; string; size 1..20; It carries the batch or lot number for product traceability.\",\n \"qLote\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity contained in the batch.\",\n \"dFab\": \"required; string; YYYY-MM-DD; It records the product's manufacturing date.\",\n \"dVal\": \"required; string; YYYY-MM-DD; It records the product's expiration or best-before date.\",\n \"cAgreg\": \"optional; string; size 1..20; It carries an aggregation code linking related batches or units.\"\n }\n ],\n \"infProdNFF\": {\n \"cProdFisco\": \"required; string; size 1..60; It carries the fiscal product code as defined by the tax authority for NFF documents.\",\n \"cOperNFF\": \"required; string; size 1..12; It carries the operation code used in NFF (Nota Fiscal Fácil) emission.\"\n },\n \"infProdEmb\": {\n \"xEmb\": \"required; string; size 1..8; It identifies the packaging type for the product.\",\n \"qVolEmb\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity of items per packaging unit.\",\n \"uEmb\": \"required; string; size 1..8; It specifies the unit of measure for the packaging.\"\n },\n \"veicProd\": {\n \"tpOp\": \"required; string; size 1; values: 1 (dealership sale), 2 (direct manufacturer/importer), 3 (rural sale), 4 (other); It identifies the vehicle sale channel.\",\n \"chassi\": \"required; string; size 17; It carries the vehicle chassis number (VIN).\",\n \"cCor\": \"required; string; size 1..4; It carries the manufacturer's color code for the vehicle.\",\n \"xCor\": \"required; string; size 1..40; It describes the vehicle color in free text.\",\n \"pot\": \"required; string; size 1..4; It states the engine power in CV (horsepower).\",\n \"cilin\": \"required; string; size 1..4; It states the engine displacement in cubic centimeters.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"tpComb\": \"required; string; size 2; It identifies the fuel type using the RENAVAM classification code.\",\n \"nMotor\": \"required; string; size 1..21; It carries the engine number of the vehicle.\",\n \"CMT\": \"required; string; size 1..9; It states the maximum towing capacity (CMT) in kg.\",\n \"dist\": \"required; string; size 1..4; It states the wheelbase distance in millimeters.\",\n \"anoMod\": \"required; string; size 4; It states the vehicle model year.\",\n \"anoFab\": \"required; string; size 4; It states the vehicle manufacturing year.\",\n \"tpPint\": \"required; string; size 1; It identifies the paint type using the RENAVAM code.\",\n \"tpVeic\": \"required; string; size 1..2; It classifies the vehicle type using the RENAVAM code.\",\n \"espVeic\": \"required; string; size 1; It identifies the vehicle species using the RENAVAM code.\",\n \"VIN\": \"required; string; size 1; values: R (restamped VIN), N (normal VIN); It indicates whether the vehicle identification number was restamped.\",\n \"condVeic\": \"required; string; size 1; values: 1 (complete), 2 (incomplete), 3 (semi-complete); It describes the vehicle's completion status at the time of sale.\",\n \"cMod\": \"required; string; size 4; It carries the vehicle model code as registered with DENATRAN/SENATRAN.\",\n \"cCorDENATRAN\": \"required; string; size 2; It carries the DENATRAN color code for the vehicle.\",\n \"lota\": \"required; string; size 1..3; It states the maximum passenger capacity (lotação) of the vehicle.\",\n \"tpRest\": \"required; string; size 1; values: 0 (none), 1 (chattel mortgage), 2 (leasing), 3 (reservation of title), 4 (vehicle lien), 9 (other); It identifies any legal restriction registered on the vehicle.\"\n },\n \"med\": {\n \"cProdANVISA\": \"required; string; size 13 or 'ISENTO'; It carries the ANVISA product registration number for medicines, or the literal 'ISENTO' for exempt products.\",\n \"xMotivoIsencao\": \"optional; string; size 1..255; It provides the legal justification for ANVISA registration exemption.\",\n \"vPMC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Maximum Consumer Price (PMC) as set by CMED.\"\n },\n \"arma\": [\n {\n \"tpArma\": \"required; string; size 1; values: 0 (permitted use), 1 (restricted use); It classifies the firearm by its permitted use category.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"nCano\": \"required; string; size 1..15; It carries the barrel number of the firearm.\",\n \"descr\": \"required; string; size 1..256; It describes the firearm characteristics in free text.\"\n }\n ],\n \"comb\": {\n \"cProdANP\": \"required; string; size 9; It carries the ANP product code identifying the fuel type.\",\n \"descANP\": \"required; string; size 2..95; It provides the fuel description as registered with ANP.\",\n \"pGLP\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of LPG (GLP) in the fuel mixture.\",\n \"pGNn\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of non-compressed natural gas (GNn) in the mixture.\",\n \"pGNi\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of imported natural gas (GNi) in the mixture.\",\n \"vPart\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the reference value per fuel unit for ICMS split calculation.\",\n \"CODIF\": \"optional; string; size 1..21; It carries the CODIF authorization code for interstate fuel operations.\",\n \"qTemp\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the fuel quantity at reference temperature (20°C).\",\n \"UFCons\": \"required; string; size 2; It identifies the state (UF) where the fuel will be consumed, for ICMS apportionment.\",\n \"pBio\": \"optional; decimal; max 100; It states the biodiesel percentage in the fuel.\",\n \"CIDE\": {\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCIDE\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total CIDE (fuel intervention contribution) amount.\"\n },\n \"encerrante\": {\n \"nBico\": \"required; string; size 1..3; It identifies the fuel pump nozzle number.\",\n \"nBomba\": \"optional; string; size 1..3; It identifies the pump number associated with the nozzle.\",\n \"nTanque\": \"required; string; size 1..3; It identifies the fuel storage tank number.\",\n \"vEncIni\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the start of the operation.\",\n \"vEncFin\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the end of the operation.\"\n },\n \"origComb\": [\n {\n \"indImport\": \"required; string; size 1; values: 0 (domestic), 1 (imported); It classifies the fuel origin for ICMS apportionment purposes.\",\n \"cUFOrig\": \"required; string; size 2; It identifies the state of origin of the fuel using the IBGE code.\",\n \"pOrig\": \"required; decimal; max 100; It states the percentage of fuel from this origin in the mixture.\"\n }\n ]\n }\n },\n \"serv\": {\n \"locPrest\": {\n \"cLocPrestacao\": \"required; string; size 7; It carries the 7-digit code of the municipality, maritime waters area (0000000), or road concession segment where the service was provided.\",\n \"cPaisPrestacao\": \"required; string; size 2; It carries the ISO country code of the country where the service was rendered (for cross-border services).\"\n },\n \"cServ\": {\n \"cTribNac\": \"required; string; size 6; It carries the national ISSQN taxation code under LC 116/2003, as defined in the national service list (Annex III of the NFS-e contributor guide).\",\n \"cTribMun\": \"optional; string; size 3; It carries the municipal ISSQN taxation code assigned by the municipality of tax incidence.\",\n \"xDescServ\": \"required; string; size 1..1000; It provides a complete free-text description of the service rendered.\",\n \"cNBS\": \"optional; string; size 9; It carries the Brazilian Nomenclature of Services (NBS 2.0) code corresponding to the service rendered.\",\n \"cIntContrib\": \"optional; string; size 1..20; It carries the issuer's internal code for identifying the DPS in their own system.\"\n },\n \"comExt\": {\n \"mdPrestacao\": \"required; string; size 1; values: 0 (unknown/not informed in source document), 1 (cross-border), 2 (consumption in Brazil), 3 (temporary movement of individuals), 4 (consumption abroad); It identifies the mode of provision for cross-border service transactions.\",\n \"vincPrest\": \"required; string; size 1; values: 0 (no relationship), 1 (controlled), 2 (controlling), 3 (affiliated), 4 (parent), 5 (branch/subsidiary), 6 (other relationship), 9 (unknown); It indicates the legal or economic relationship between the service provider and the taker.\",\n \"tpMoeda\": \"required; string; size 3; It carries the ISO currency code of the foreign currency used in the commercial transaction.\",\n \"vServMoeda\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the service value expressed in the foreign currency identified by tpMoeda.\",\n \"mecAFComexP\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 (ACC), 03 (ACE), 04 (BNDES-Exim post-shipment), 05 (BNDES-Exim pre-shipment), 06 (FGE), 07 (PROEX equalization), 08 (PROEX financing); It identifies the trade finance mechanism used by the service provider.\",\n \"mecAFComexT\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 to 26 (various mechanisms per MDIC table); It identifies the trade finance or exemption mechanism used by the service taker.\",\n \"movTempBens\": \"required; string; size 1; values: 0 (unknown), 1 (not linked), 2 (linked to import declaration), 3 (linked to export declaration); It indicates whether the service is linked to a temporary movement of goods.\",\n \"nDI\": \"optional; string; size 1..12; It carries the number of the import declaration (DI/DSI/DA/DRI-E) related to the service.\",\n \"nRE\": \"optional; string; size 12; It carries the number of the export registration (Registro de Exportação) related to the service.\",\n \"mdic\": \"required; string; size 1; values: 0 (do not send to MDIC), 1 (send to MDIC); It indicates whether this NFS-e should be made available to the Ministry of Trade (MDIC).\"\n },\n \"lsadppu\": {\n \"categ\": \"required; string; It carries the category code for the public lighting or special public utility service.\",\n \"objeto\": \"required; string; It describes the object or purpose of the public utility service.\",\n \"extensao\": \"optional; string; It states the physical extension or length of the public utility installation.\",\n \"nPostes\": \"optional; string; It states the number of lighting poles related to the public utility service.\"\n },\n \"obra\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the construction site or for IPTU collection.\",\n \"cObra\": \"required; string; size 1..30; It carries the construction site identification number — either the CNO (National Construction Registry) or the CEI (INSS Specific Registry).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the construction site address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the construction site address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the construction site is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the construction site is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the construction site address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the construction site address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the construction site.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the construction site address.\"\n }\n },\n \"atvEvento\": {\n \"xNome\": \"required; string; size 1..255; It provides the name of the artistic, cultural, or sports event.\",\n \"dtIni\": \"required; string; YYYY-MM-DD; It records the start date of the event activity.\",\n \"dtFim\": \"required; string; YYYY-MM-DD; It records the end date of the event activity.\",\n \"idAtvEvt\": \"required; string; size 1..30; It carries the event activity identifier assigned by the municipal tax authority.\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the event venue address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the event venue in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the event is held.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the event is held.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the event venue address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the event venue address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the event venue.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the event venue address.\"\n }\n },\n \"explRod\": {\n \"categVeic\": \"required; string; It identifies the vehicle category for road toll calculation purposes.\",\n \"nEixos\": \"required; string; It states the number of axles of the vehicle for toll classification.\",\n \"rodagem\": \"required; string; It identifies the wheel configuration (single or dual) of the vehicle.\",\n \"sentido\": \"required; string; It indicates the direction of travel on the road concession (e.g., northbound, southbound).\",\n \"placa\": \"required; string; It carries the vehicle license plate number for road toll identification.\",\n \"codAcessoPed\": \"optional; string; It carries the toll access code associated with this road exploitation service.\",\n \"codContrato\": \"optional; string; It carries the contract number governing the road concession exploitation.\"\n },\n \"imovel\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the real estate or for IPTU collection.\",\n \"cCIB\": \"required; string; size 8; It carries the Brazilian Real Estate Registry code (Cadastro Imobiliário Brasileiro — CIB).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the property address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the property address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the property is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the property is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the property address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the property address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the property.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the property address.\"\n }\n },\n \"infoCompl\": {\n \"idDocTec\": \"optional; string; size 1..40; It carries the identifier of the technical responsibility document (ART, RRT, DRT, or other) associated with this service.\",\n \"docRef\": \"optional; string; size 1..255; It carries the key, number, or contract identifier of a document issued by the service provider that supports the issuance of this NFS-e by the taker or intermediary.\",\n \"xInfComp\": \"optional; string; size 1..2000; It provides free-text complementary information about the service, available to all service codes.\"\n },\n \"valores\": {\n \"vServPrest\": {\n \"vReceb\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monetary amount received by the service intermediary (R$).\",\n \"vServ\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total monetary value of the service rendered (R$).\"\n },\n \"vDescCondIncond\": {\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount (R$) granted to the service taker.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount (R$) dependent on specific conditions agreed between the parties.\"\n },\n \"vDedRed\": {\n \"pDR\": \"required; decimal; 3 integer + 2 decimal; It carries the percentage rate applied to the service value to calculate the ISSQN base reduction.\",\n \"vDR\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary amount used as a standard deduction or reduction of the service value for ISSQN base calculation purposes (R$).\",\n \"documentos\": {\n \"docDedRed\": [\n {\n \"chNFSe\": \"required; string; size 1..50; It carries the access key of the NFS-e (national standard) used as a deduction or reduction document in the ISSQN base calculation.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e used as a deduction or reduction document in the ISSQN base calculation.\"\n }\n ]\n }\n }\n }\n },\n \"imposto\": {\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\",\n \"ICMS\": {\n \"ICMS00\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\"\n },\n \"ICMS02\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\"\n },\n \"ICMS10\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS15\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemICMSReten\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate subject to withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"pRedAdRem\": \"optional; decimal; max 100; 3 integer + 2 decimal; It states the ad rem rate reduction percentage.\",\n \"motRedAdRem\": \"optional; string; It carries the reason code for the ad rem rate reduction.\"\n },\n \"ICMS20\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS30\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS40\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS51\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\"\n },\n \"ICMS53\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMonoOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSMonoDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred monophase ICMS amount.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoDif\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the deferred taxable quantity in the monophase regime.\",\n \"adRemICMSDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the deferred ad rem ICMS rate.\"\n },\n \"ICMS60\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMS61\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate previously retained.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\"\n },\n \"ICMS70\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS90\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMSPart\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pBCOp\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS base allocated to the operation state.\",\n \"UFST\": \"required; string; size 2; It identifies the destination state (UF) for ICMS-ST split.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMSST\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"vBCSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST base in the destination state.\",\n \"vICMSSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount in the destination state.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN101\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN102\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\"\n },\n \"ICMSSN201\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN202\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\"\n },\n \"ICMSSN500\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN900\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n }\n },\n \"ICMSUFDest\": {\n \"vBCUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS calculation base in the destination state (EC 87/2015).\",\n \"vBCFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base in the destination state.\",\n \"pFCPUFDest\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP rate in the destination state.\",\n \"pICMSUFDest\": \"required; decimal; 3 integer + 2..4 decimal; It states the internal ICMS rate of the destination state.\",\n \"pICMSInter\": \"required; string; size 4; values: 4.00 or 12.00; It states the interstate ICMS rate applicable to the operation (4% or 12%).\",\n \"pICMSInterPart\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS differential allocated to the destination state.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\"\n },\n \"IPI\": {\n \"CNPJProd\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the producer's CNPJ when different from the document issuer, for IPI purposes.\",\n \"cSelo\": \"optional; string; size 1..60; It carries the IPI control stamp code.\",\n \"qSelo\": \"optional; string; size 1..6; It states the quantity of IPI control stamps applied.\",\n \"cEnq\": \"required; string; size 3; It carries the IPI classification/framework code.\",\n \"IPITrib\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pIPI\": \"optional; decimal; 3 integer + 2..4 decimal; It states the IPI rate as a percentage.\",\n \"qUnid\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity in the IPI taxable unit.\",\n \"vUnid\": \"optional; decimal; 15 digits: 11 integer + 4 decimal; It states the IPI specific rate per taxable unit.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\"\n },\n \"IPINT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n }\n },\n \"II\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vDespAdu\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the customs handling fees (despesas aduaneiras) amount.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIOF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IOF (financial operations tax) amount levied on the import.\"\n },\n \"ISSQN\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vAliq\": \"required; decimal; 3 integer + 2..4 decimal; It states the ISS/ISSQN rate as a percentage.\",\n \"vISSQN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount due.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cListServ\": \"required; string; size 1..5; It identifies the service under the LC 116/2003 national service list.\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"indISS\": \"required; string; size 1; values: 1 (due), 2 (non-incidence), 3 (exempt), 4 (export), 5 (immunity), 6 (suspended by court order), 7 (suspended by administrative process); It classifies the ISS applicability status for this service.\",\n \"cServico\": \"optional; string; It carries the municipality's internal service classification code.\",\n \"cMun\": \"optional; string; size 7; It identifies the municipality where the service is provided, using the IBGE code.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for exported services.\",\n \"nProcesso\": \"optional; string; size 1..30; It carries the administrative or judicial process number related to ISS suspension.\",\n \"indIncentivo\": \"required; string; size 1; values: 1 (yes), 2 (no); It indicates whether the service benefits from a municipal ISS fiscal incentive.\"\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"PISOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n }\n },\n \"PISST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"indSomaPISST\": \"optional; string; size 1; It indicates whether the PIS-ST amount should be added to the item total.\"\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"COFINSOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n }\n },\n \"COFINSST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"indSomaCOFINSST\": \"optional; string; size 1; It indicates whether the COFINS-ST amount should be added to the item total.\"\n },\n \"IS\": {\n \"CSTIS\": \"required; string; size 3; pattern [0-9]{3}; Tax situation code for the Selective Tax (IS).\",\n \"cClassTribIS\": \"required; string; size 6; pattern [0-9]{6}; Tax classification code for IS.\",\n \"vBCIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; IS tax calculation base amount.\",\n \"pIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS rate as a percentage.\",\n \"adRemIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS specific rate (ad rem, per unit).\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Calculated IS amount.\"\n },\n \"IBSCBS\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"cClassTrib\": \"required; string; size 6; pattern [0-9]{6}; IBS/CBS tax classification code.\",\n \"indDoacao\": \"optional; string; size 1; fixed value 1; Indicates the operation is a donation.\",\n \"indDest\": \"required; string; size 1; values: 0 (the recipient is the same person as the taker identified in the NFS-e), 1 (the recipient is a different person or a different establishment from the taker); It indicates whether the service recipient is the same party as the acquiring taker.\",\n \"gIBSCBS\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"gIBSUF\": {\n \"pIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate as a percentage.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage (LC 214/25 art. 118).\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount (cashback on the invoice).\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate as a percentage.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gCBS\": {\n \"pCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate as a percentage.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n },\n \"gALCZFMCBS\": {\n \"_comment\": \"optional — ZFM/ALC incentive area CBS zero-rate group (NF-e variant)\",\n \"tpALCZFMCBS\": \"required; string; size 1; values: 1 (with Suframa-approved process), 2 (without approved process); Type of CBS zero-rate application in incentive areas.\",\n \"nProcSuframa\": \"optional; string; size 8..12; Suframa process number for the commercialized item.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; Reference CBS effective rate outside the incentive area.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value calculated outside the incentive area.\"\n }\n },\n \"gTribRegular\": {\n \"CSTReg\": \"required; string; size 3; CST that would apply without the condition.\",\n \"cClassTribReg\": \"required; string; size 6; cClassTrib that would apply without the condition.\",\n \"pAliqEfetRegIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state effective rate without condition.\",\n \"vTribRegIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value without condition.\",\n \"pAliqEfetRegIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal effective rate without condition.\",\n \"vTribRegIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value without condition.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS effective rate without condition.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value without condition.\"\n },\n \"gTribCompraGov\": {\n \"pAliqIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate before Art. 473 LC 214/2025 reduction.\",\n \"vTribIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value before Art. 473 reduction.\",\n \"pAliqIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate before Art. 473 reduction.\",\n \"vTribIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value before Art. 473 reduction.\",\n \"pAliqCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate before Art. 473 reduction.\",\n \"vTribCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value before Art. 473 reduction.\"\n }\n },\n \"gIBSCBSMono\": {\n \"gMonoPadrao\": {\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate.\",\n \"adRemCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate.\",\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase IBS amount.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase CBS amount.\"\n },\n \"gMonoReten\": {\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemIBSReten\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate subject to withholding.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS amount subject to withholding.\",\n \"adRemCBSReten\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount subject to withholding.\"\n },\n \"gMonoRet\": {\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemIBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld IBS ad rem rate.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld IBS amount.\",\n \"adRemCBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld CBS ad rem rate.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld CBS amount.\"\n },\n \"gMonoDif\": {\n \"pDifIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS deferral percentage.\",\n \"vIBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred IBS monophase amount.\",\n \"pDifCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS deferral percentage.\",\n \"vCBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred CBS monophase amount.\"\n },\n \"vTotIBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS for the item.\",\n \"vTotCBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS for the item.\"\n },\n \"gTransfCred\": {\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be transferred.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be transferred.\"\n },\n \"gAjusteCompet\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS adjustment amount.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS adjustment amount.\"\n }\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be reversed.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be reversed.\"\n },\n \"gCredPresOper\": {\n \"vBCCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit calculation base.\",\n \"cCredPres\": \"required; string; size 2; pattern [0-9]{2}; Presumed credit classification code.\",\n \"gIBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n },\n \"gCBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n }\n },\n \"gCredPresIBSZFM\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"vCredPresIBSZFM\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit amount calculated on the net debit balance.\"\n }\n },\n \"impostoDevol\": {\n \"pDevol\": \"required; decimal; max 100; 3 integer + 2 decimal; It states the percentage of IPI being returned in a product return operation.\",\n \"IPI\": {\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\"\n }\n },\n \"infAdProd\": \"optional; string; size 1..500; It provides free-text additional information about the product, which is printed on the DANFE.\",\n \"obsItem\": {\n \"obsCont\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n },\n \"obsFisco\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n },\n \"DFeReferenciado\": {\n \"chaveAcesso\": \"required; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}\",\n \"nItem\": \"optional; string; size 1..3\"\n }\n }\n ],\n \"total\": {\n \"ICMSTot\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"vST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total ICMS-ST amount.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\",\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vNF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total document value (net amount due).\",\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\"\n },\n \"ISSQNtot\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vISS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total ISSQN amount for the document.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"dCompet\": \"required; string; YYYY-MM-DD; It indicates the ISS competence date (month of service provision).\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"cRegTrib\": \"optional; string; size 1; values: 1 (Simples Nacional), 2 (estimate), 3 (professional partnership), 4 (cooperative), 5 (ME/EPP Simples Nacional), 6 (ME/EPP Simples Nacional excess); It identifies the ISS tax regime of the service provider.\"\n },\n \"retTrib\": {\n \"vRetPIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount withheld at source.\",\n \"vRetCOFINS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount withheld at source.\",\n \"vRetCSLL\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the CSLL amount withheld at source.\",\n \"vBCIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF (income tax at source) calculation base.\",\n \"vIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF amount withheld at source.\",\n \"vBCRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security withholding (INSS) calculation base.\",\n \"vRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security (INSS) amount withheld at source.\"\n },\n \"ISTot\": {\n \"vIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total Selective Tax (IS) amount for the document.\"\n },\n \"IBSCBSTot\": {\n \"vBCIBSCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS/CBS calculation base.\",\n \"gIBS\": {\n \"gIBSUF\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred state IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS tax refunds.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS amount.\"\n },\n \"gIBSMun\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred municipal IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS tax refunds.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS amount.\"\n },\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit under suspensive condition.\"\n },\n \"gCBS\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred CBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS tax refunds.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS amount.\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit under suspensive condition.\"\n },\n \"gMono\": {\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS subject to withholding.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase IBS.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase CBS.\"\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed IBS credit.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed CBS credit.\"\n }\n },\n \"vNFTot\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the grand total document value including IBS, CBS, and IS amounts.\"\n },\n \"transp\": {\n \"modFrete\": \"required; string; size 1; values: 0 (issuer's account CIF), 1 (recipient's account FOB), 2 (third-party account), 3 (issuer's own transport), 4 (recipient's own transport), 9 (no freight); It specifies who is responsible for the freight costs.\",\n \"transporta\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"xEnder\": \"optional; string; size 1..60; It provides the carrier's address in free text.\",\n \"xMun\": \"optional; string; size 2..60; It provides the carrier's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\"\n },\n \"retTransp\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBCRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport calculation base.\",\n \"pICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-transport withholding rate as a percentage.\",\n \"vICMSRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport withheld amount.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\"\n },\n \"veicTransp\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\"\n },\n \"reboque\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\",\n \"vagao\": \"optional; string; size 1..20; It carries the rail wagon identification for rail transport.\",\n \"balsa\": \"optional; string; size 1..20; It carries the barge identification for river transport.\"\n },\n \"vol\": [\n {\n \"qVol\": \"optional; string; size 1..15; It states the number of packages/volumes.\",\n \"esp\": \"optional; string; size 1..60; It describes the type of package/volume (e.g., caixa, fardo).\",\n \"marca\": \"optional; string; size 1..60; It carries the brand or mark of the packages.\",\n \"nVol\": \"optional; string; size 1..60; It carries the volume numbering or identification.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"lacres\": [\n {\n \"nLacre\": \"required; string; size 1..60; It carries the seal (lacre) number applied to the cargo.\"\n }\n ]\n }\n ]\n },\n \"cobr\": {\n \"fat\": {\n \"nFat\": \"optional; string; size 1..60; It carries the invoice (fatura) number for billing control.\",\n \"vOrig\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the original invoice amount before any discounts.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vLiq\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the net invoice amount after discounts.\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional; string; size 1..60; It identifies the installment (duplicata) number within the invoice.\",\n \"dVenc\": \"optional; string; YYYY-MM-DD; It records the due date for this installment.\",\n \"vDup\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the face value of this installment.\"\n }\n ]\n },\n \"pag\": {\n \"detPag\": [\n {\n \"indPag\": \"optional; string; size 1; values: 0 (cash/à vista), 1 (installment/à prazo); It indicates the payment timing condition.\",\n \"tPag\": \"required; string; size 2; values: 01 (cash), 02 (cheque), 03 (credit card), 04 (debit card), 05 (store credit), 10 (meal voucher), 11 (food voucher), 12 (gift card), 13 (fuel voucher), 14 (trade bill/duplicata), 15 (bank slip/boleto), 16 (bank deposit), 17 (PIX), 18 (wire transfer), 19 (cashback), 90 (no payment), 99 (other); It identifies the payment method used.\",\n \"xPag\": \"optional; string; size 2..60; It provides a description when tPag=99 (other payment method).\",\n \"vPag\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the amount paid using this payment method.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\",\n \"CNPJPag\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the bank or payment institution processing this payment.\",\n \"UFPag\": \"optional; string; size 2; It identifies the state (UF) of the payment institution.\",\n \"card\": {\n \"tpIntegra\": \"required; string; size 1; values: 1 (integrated TEF), 2 (non-integrated); It indicates whether the card payment was processed through an integrated electronic payment terminal.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"tBand\": \"optional; string; size 2; values: 01 (Visa), 02 (Mastercard), 03 (Amex), 04 (Sorocred), 05 (Diners), 06 (Elo), 07 (Hipercard), 08 (Aura), 09 (Cabal), 99 (other); It identifies the card network/brand.\",\n \"cAut\": \"optional; string; size 1..20; It carries the card transaction authorization code.\",\n \"CNPJReceb\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the payment recipient's CNPJ, which may differ from the document issuer.\",\n \"idTermPag\": \"optional; string; size 1..40; It carries the payment terminal identifier.\"\n }\n }\n ],\n \"vTroco\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the change amount returned to the customer (NFC-e).\"\n },\n \"infIntermed\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"idCadIntTran\": \"required; string; size 2..60; It carries the intermediary's registration ID on the digital platform.\"\n },\n \"infAdic\": {\n \"infAdFisco\": \"optional; string; size 1..2000; It contains additional fiscal information required by the tax authority, printed on the DANFE.\",\n \"infCpl\": \"optional; string; size 1..5000; It contains complementary information added by the issuer, printed on the DANFE.\",\n \"obsCont\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"obsFisco\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"required; string; size 1..60; It carries the administrative or judicial process number referenced.\",\n \"indProc\": \"required; string; size 1; values: 0 (SEFAZ), 1 (Federal Court), 2 (State Court), 3 (SECEX/RFB), 9 (other); It identifies the type of process or authority issuing the referenced act.\",\n \"tpAto\": \"optional; string; size 2; values: 08 (summons), 10 (decision), 12 (sentence), 15 (court ruling/acórdão); It classifies the type of legal act referenced.\"\n }\n ]\n },\n \"exporta\": {\n \"UFSaidaPais\": \"required; string; size 2; It identifies the Brazilian state through which the exported goods will exit the country.\",\n \"xLocExporta\": \"required; string; size 1..60; It describes the export customs clearance location in free text.\",\n \"xLocDespacho\": \"optional; string; size 1..60; It describes the goods dispatch location for export purposes.\"\n },\n \"compra\": {\n \"xNEmp\": \"optional; string; size 1..17; It carries the purchase order or budget note number from the buyer.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"xCont\": \"optional; string; size 1..60; It carries the contract number associated with this purchase.\"\n },\n \"cana\": {\n \"safra\": \"required; string; size 4..9; It identifies the sugarcane harvest (safra) reference period.\",\n \"ref\": \"required; string; size 7; format AAMM; It indicates the year-month reference for the sugarcane supply.\",\n \"forDia\": [\n {\n \"dia\": \"required; string; size 1..2; It identifies the calendar day within the supply month.\",\n \"qtde\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the sugarcane quantity supplied on this day.\"\n }\n ],\n \"qTotMes\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied in the current month.\",\n \"qTotAnt\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the cumulative sugarcane quantity supplied in prior months of this harvest.\",\n \"qTotGer\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied across the entire harvest period.\",\n \"deduc\": [\n {\n \"xDed\": \"required; string; size 1..60; It describes the deduction type applied to the sugarcane supply value.\",\n \"vDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the deduction amount.\"\n }\n ],\n \"vFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross supply value before deductions.\",\n \"vTotDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total deductions applied.\",\n \"vLiqFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the net supply value after all deductions.\"\n },\n \"infRespTec\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xContato\": \"required; string; size 2..60; It provides the name of the technical contact person at the responsible company.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"idCSRT\": \"optional; string; size 2; It carries the two-digit identifier of the CSRT security token.\",\n \"hashCSRT\": \"optional; string; size 28; It carries the SHA-1 hash of the CSRT token concatenated with the NF-e access key, encoded in base64.\"\n },\n \"infSolicNFF\": {\n \"xSolic\": \"required; string; size 2..1000; It carries the NFF request information in free text.\"\n },\n \"agropecuario\": {\n \"defensivo\": [\n {\n \"nReceituario\": \"required; string; size 1..20; It carries the prescription number issued by the agronomist for the pesticide.\",\n \"CPFRespTec\": \"required; string; size 11; pattern [0-9]{11}; It identifies the agronomist or technician who prescribed the pesticide by their CPF.\"\n }\n ],\n \"guiaTransito\": {\n \"tpGuia\": \"required; string; size 2; values: 01 (animal transit), 02 (plant transit); It classifies the transit permit type for agricultural products.\",\n \"UFGuia\": \"required; string; size 2; It identifies the state that issued the transit permit.\",\n \"serieGuia\": \"optional; string; size 1..9; It carries the series number of the transit permit.\",\n \"nGuia\": \"required; string; size 1..20; It carries the transit permit number.\"\n }\n },\n \"infPAA\": {\n \"CNPJPAA\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the Signature and Authorization Provider (PAA) by their CNPJ.\",\n \"PAASignature\": {\n \"SignatureValue\": \"required; string; base64-encoded binary; It carries the PAA's digital signature value.\",\n \"RSAKeyValue\": \"required; object; It contains the RSA public key (Modulus and Exponent) used to verify the PAA signature.\"\n }\n }\n },\n \"infNFeSupl\": {\n \"qrCode\": \"required; string; size 1..1000; It carries the QR Code URL string for NFC-e consumer verification.\",\n \"urlChave\": \"required; string; size 1..85; It carries the URL for NFC-e access key consultation.\"\n },\n \"Signature\": \"required; object; It contains the XML-DSig digital signature of the NF-e, ensuring document integrity and authenticity.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/event/{tpEvento}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"payload.NFe.infNFe.ide.mod\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"2c0b29a4-21bc-450b-9f7c-cfcdb312b43c","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"accountId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"NFe\": {\n \"infNFe\": {\n \"_attr_Id\": \"required; string; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It uniquely identifies the NF-e by its 44-character access key, embedded as an XML attribute.\",\n \"_attr_versao\": \"required; string; It specifies the NF-e schema version used in the document.\",\n \"ide\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"cNF\": \"required; string; size 8; It carries an 8-digit random numeric code used as part of the NF-e access key composition.\",\n \"natOp\": \"required; string; size 1..60; It informs the nature of the operation in free text (e.g., 'Venda de mercadoria', 'Devolução').\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\",\n \"dhEmi\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the NF-e was issued.\",\n \"dhSaiEnt\": \"optional; string; YYYY-MM-DDThh:mm:ssTZD; It indicates the date and time of goods departure (outbound) or receipt (inbound).\",\n \"dPrevEntrega\": \"optional; string; YYYY-MM-DD; It informs the expected delivery date of the goods to the recipient.\",\n \"dCompet\": \"optional; string; YYYY-MM-DD; It provides the date of competence of the operation for service operations (NFS-e).\",\n \"tpNF\": \"required; string; size 1; values: 0 (inbound/entrada), 1 (outbound/saída); It indicates the direction of the operation.\",\n \"idDest\": \"required; string; size 1; values: 1 (within the same state), 2 (interstate), 3 (international); It classifies the geographic scope of the operation.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cMunFGIBS\": \"optional; string; size 7; It identifies the municipality of the IBS taxable event when different from cMunFG, using the IBGE code.\",\n \"tpImp\": \"required; string; size 1; values: 0 (no DANFE), 1 (portrait), 2 (landscape), 3 (simplified), 4 (NFC-e), 5 (NFC-e electronic message); It specifies the DANFE print format.\",\n \"tpEmis\": \"required; string; size 1; values: 1 (normal), 2 (FS contingency), 3 (SVC-AN), 4 (SVC-RS), 5 (FS-DA contingency), 6 (SVC-AN alt), 7 (SVC-RS alt), 9 (NFC-e offline); It identifies the emission mode, distinguishing normal from contingency.\",\n \"cDV\": \"required; string; size 1; It is the check digit of the 44-character NF-e access key, calculated using modulo 11.\",\n \"tpAmb\": \"required; string; size 1; values: 1 (production), 2 (homologation/testing); It indicates the environment in which the NF-e is being issued.\",\n \"finNFe\": \"required; string; size 1; values: 1 (normal NF-e), 2 (complementary), 3 (adjustment), 4 (return/devolution); It defines the fiscal purpose of the document.\",\n \"tpNFDebito\": \"optional; string; It classifies the debit NF-e type as defined by the tax authority.\",\n \"tpNFCredito\": \"optional; string; It classifies the credit NF-e type as defined by the tax authority.\",\n \"indFinal\": \"required; string; size 1; values: 0 (not a final consumer), 1 (final consumer); It indicates whether the recipient is the end consumer of the goods.\",\n \"indPres\": \"required; string; size 1; values: 0 (not applicable), 1 (in-person), 2 (internet), 3 (telephone service), 4 (NFC-e home delivery), 5 (in-person outside the establishment), 9 (other); It indicates whether the buyer was physically present at the point of sale.\",\n \"indIntermed\": \"optional; string; size 1; values: 0 (no intermediary), 1 (with intermediary/marketplace); It flags whether the operation was conducted through a digital marketplace or platform.\",\n \"cIndOp\": \"optional; string; size 1..6; It carries the operation indicator code as defined by the issuer's internal or industry classification.\",\n \"procEmi\": \"required; string; size 1; values: 0 (taxpayer application), 1 (standalone by Fisco), 2 (SCAN/DPEC standalone), 3 (taxpayer app provided by Fisco); It identifies which process and software were used to generate the NF-e.\",\n \"verProc\": \"required; string; size 1..20; It records the version of the application or process used to emit the NF-e.\",\n \"dhCont\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the contingency mode was activated.\",\n \"xJust\": \"required; string; size 15..256; It provides the mandatory justification text explaining why contingency emission was used.\",\n \"tpEmit\": \"required; string; size 1; values: 1 (service provider/prestador), 2 (service taker/tomador), 3 (intermediary/intermediário); It identifies who is issuing the DPS/NFS-e.\",\n \"cMotivoEmisTI\": \"optional; string; size 1; values: 1 (service import), 2 (taker/intermediary required by municipal law), 3 (taker/intermediary issuing due to provider refusal), 4 (taker/intermediary rejecting provider's NFS-e); It indicates the reason why the taker or intermediary is issuing the DPS instead of the service provider.\",\n \"chNFSeRej\": \"optional; string; size 1..50; It carries the access key of the NFS-e previously rejected by the taker or intermediary, referenced when cMotivoEmisTI=4.\",\n \"cLocEmi\": \"required; string; size 7; It carries the 7-digit IBGE code of the municipality that authorized the issuance of this NFS-e.\",\n \"subst\": {\n \"chSubstda\": \"required; string; size 1..50; It carries the access key of the NFS-e being substituted.\",\n \"cMotivo\": \"required; string; size 1; values: 1 (opt-out of Simples Nacional), 2 (opt-in to Simples Nacional), 3 (retroactive inclusion of immunity/exemption), 4 (retroactive exclusion of immunity/exemption), 5 (rejection by taker or intermediary), 99 (other); It indicates the reason for substituting the NFS-e.\",\n \"xMotivo\": \"optional; string; size 15..255; It provides a free-text description of the substitution reason when cMotivo=99.\"\n },\n \"NFref\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\",\n \"refNFeSig\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e (simplified model) by its access key.\",\n \"refNF\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refNFP\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refCTe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a CT-e (transport document) related to this NF-e by its access key.\",\n \"refECF\": {\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"nECF\": \"required; string; size 3; It identifies the ECF (electronic cash register) equipment number.\",\n \"nCOO\": \"required; string; size 6; It carries the Counter of Fiscal Operations (COO) from the referenced ECF receipt.\"\n }\n }\n ],\n \"gCompraGov\": {\n \"tpEnteGov\": \"required; string; size 1; values: 1 (Union/Federal), 2 (State), 3 (Federal District), 4 (Municipality), 5 (Public Consortium), 6 (IBS Management Committee); It identifies the type of government entity involved in the purchase.\",\n \"pRedutor\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the IBS/CBS rate reduction percentage applicable to government purchases.\",\n \"tpOperGov\": \"required; string; size 1; values: 1 (supply with later payment), 2 (payment received, supply already done), 3 (supply with payment already made), 4 (payment received, supply pending); It identifies the operational sequence of a government purchase.\",\n \"refDFeAnt\": \"optional; string; size 44; repeatable 0..99; pattern [0-9]{6}[A-Z0-9]{12}[0-9]{26}; It references previous fiscal documents for tpOperGov 2 or 3.\"\n },\n \"gPagAntecipado\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\"\n }\n ]\n },\n \"emit\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"xFant\": \"optional; string; size 1..60; It provides the trade name or fantasy name used by the issuer commercially.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"IEST\": \"optional; string; size 2..14; It carries the state tax registration for ICMS tax substitution in a state different from the issuer's.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"CNAE\": \"optional; string; size 7; It identifies the issuer's primary economic activity using the CNAE classification code.\",\n \"CRT\": \"required; string; size 1; values: 1 (Simples Nacional), 2 (Simples Nacional — excess revenue), 3 (Normal Regime), 4 (Simples Nacional SIMEI); It identifies the tax regime of the issuer.\",\n \"ISUFEmit\": \"optional; string; size 8..9; It carries the issuer's SUFRAMA registration number for operations in incentive zones (ZFM/ALC).\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the issuer when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the issuer.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the issuer.\",\n \"enderEmit\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the issuer's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the issuer's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the issuer (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the issuer's address.\",\n \"cMun\": \"required; string; size 7; It identifies the issuer's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the issuer's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the issuer's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"required; string; size 8; It carries the issuer's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the issuer's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the issuer's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the issuer's contact phone number.\"\n }\n },\n \"avulsa\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xOrgao\": \"required; string; size 1..60; It names the tax authority that issued the standalone NF-e.\",\n \"matr\": \"required; string; size 1..60; It carries the registration number of the tax agent who authorized the avulsa NF-e.\",\n \"xAgente\": \"required; string; size 1..60; It provides the full name of the tax agent responsible for the avulsa NF-e.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\",\n \"nDAR\": \"optional; string; size 1..60; It carries the DAR (tax collection document) number related to the avulsa emission.\",\n \"dEmi\": \"optional; string; YYYY-MM-DD; It records the issuance date of the DAR.\",\n \"vDAR\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary value of the DAR payment.\",\n \"repEmi\": \"required; string; size 1..60; It identifies the Fisco representative who signed the avulsa document.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\"\n },\n \"dest\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"idEstrangeiro\": \"optional; string; size 2..20; It identifies a foreign recipient who does not hold a Brazilian CNPJ or CPF.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"indIEDest\": \"required; string; size 1; values: 1 (ICMS taxpayer), 2 (ICMS-exempt taxpayer), 9 (non-taxpayer); It classifies the recipient's ICMS tax registration status.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"ISUF\": \"optional; string; size 8..9; It carries the recipient's SUFRAMA registration number for incentive zone operations.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the recipient when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the recipient.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the recipient.\",\n \"enderDest\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the recipient's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the recipient's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the recipient (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the recipient's address.\",\n \"cMun\": \"required; string; size 7; It identifies the recipient's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the recipient's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the recipient's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the recipient's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the recipient's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the recipient's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the recipient's contact phone number.\"\n }\n },\n \"retirada\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"entrega\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"autXML\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\"\n },\n \"det\": [\n {\n \"nItem\": \"required; integer; range 1..990; It is the sequential line-item number within the NF-e.\",\n \"vItem\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total value of this line item.\",\n \"prod\": {\n \"cProd\": \"required; string; size 1..60; It carries the issuer's internal product or service code.\",\n \"cEAN\": \"required; string; It carries the product's GTIN barcode; use the literal 'SEM GTIN' when not applicable.\",\n \"cBarra\": \"optional; string; size 3..30; It carries an additional non-GTIN barcode for the product.\",\n \"xProd\": \"required; string; size 1..120; It describes the product or service in free text.\",\n \"NCM\": \"required; string; size 2..8; It classifies the product under the Mercosur Common Nomenclature (NCM/SH).\",\n \"NVE\": [\n \"optional; string; size 6; It carries the NVE (Nomenclatura de Valor Aduaneiro e Estatística) code for the product; repeatable 0..8 entries.\"\n ],\n \"CEST\": \"optional; string; size 7; It carries the CEST code identifying products subject to ICMS tax substitution.\",\n \"indEscala\": \"optional; string; size 1; values: S (relevant scale), N (not at relevant scale); It indicates whether the product is manufactured at commercially relevant scale.\",\n \"CNPJFab\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the manufacturer's CNPJ; required when indEscala=N.\",\n \"cBenef\": \"optional; string; size 8..10; It carries the fiscal benefit code (state or federal) applicable to the product.\",\n \"gCred\": {\n \"cCredPresumido\": \"required; string; It carries the classification code for the presumed credit applicable to this product.\",\n \"pCredPresumido\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the presumed credit rate as a percentage.\",\n \"vCredPresumido\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the calculated presumed credit monetary value.\"\n },\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"EXTIPI\": \"optional; string; size 2..3; It carries the TIPI exception code for the product when different from the base NCM.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"uCom\": \"required; string; size 1..6; It specifies the unit of measure used in the commercial transaction (e.g., UN, KG, CX).\",\n \"qCom\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity sold or transferred in commercial units.\",\n \"vUnCom\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price in the commercial transaction.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"cEANTrib\": \"required; string; It carries the taxable GTIN barcode; use 'SEM GTIN' when not applicable.\",\n \"cBarraTrib\": \"optional; string; size 3..30; It carries an additional non-GTIN taxable barcode.\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vUnTrib\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price for tax calculation purposes.\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"indTot\": \"required; string; size 1; values: 0 (not included in vProd total), 1 (included in vProd total); It controls whether the item value is summed into the document total.\",\n \"indBemMovelUsado\": \"optional; string; It flags the item as a used movable asset subject to specific ICMS rules.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"nItemPed\": \"optional; string; size 1..6; It identifies the specific line number within the buyer's purchase order.\",\n \"nFCI\": \"optional; string; size 36; It carries the GUID of the Import Content Form (FCI) for products with imported inputs.\",\n \"nRECOPI\": \"optional; string; size 20; It carries the RECOPI registration number for paper products subject to control.\",\n \"DI\": [\n {\n \"nDI\": \"required; string; size 1..12; It carries the import declaration number (DI, DSI, DA, or DIRE).\",\n \"dDI\": \"required; string; YYYY-MM-DD; It records the date the import declaration was registered at Receita Federal.\",\n \"xLocDesemb\": \"required; string; size 1..60; It describes the customs clearance location.\",\n \"UFDesemb\": \"required; string; size 2; It identifies the state where customs clearance took place.\",\n \"dDesemb\": \"required; string; YYYY-MM-DD; It records the date goods were cleared through customs.\",\n \"tpViaTransp\": \"required; string; size 2; values: 1 (maritime), 2 (river), 3 (lake), 4 (air), 5 (postal), 6 (rail), 7 (road), 8 (pipeline), 9 (own means), 10 (fictitious), 11 (courier), 12 (handcarry); It identifies the transport modality used to bring goods into Brazil.\",\n \"vAFRMM\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the AFRMM (marine freight renewal fee) amount.\",\n \"tpIntermedio\": \"required; string; size 1; values: 1 (own account import), 2 (import on behalf of third party), 3 (import by order); It identifies the legal relationship between the importer and the purchaser.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"UFTerceiro\": \"optional; string; size 2; It identifies the state of the acquiring or ordering party in a third-party import.\",\n \"cExportador\": \"required; string; size 1..60; It carries the exporter's identification code as registered in the import declaration.\",\n \"adi\": [\n {\n \"nAdicao\": \"optional; string; size 1..3; It identifies the addition number within the import declaration.\",\n \"nSeqAdic\": \"required; string; size 1..3; It carries the sequential number of this item within the DI addition.\",\n \"cFabricante\": \"required; string; size 1..60; It identifies the manufacturer as declared in the import addition.\",\n \"vDescDI\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount applied at the DI addition level.\",\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\"\n }\n ]\n }\n ],\n \"detExport\": {\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\",\n \"exportInd\": [\n {\n \"nRE\": \"required; string; size 12; It carries the Export Registry (Registro de Exportação) number.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e referencing the export.\",\n \"qExport\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity effectively exported.\"\n }\n ]\n },\n \"rastro\": [\n {\n \"nLote\": \"required; string; size 1..20; It carries the batch or lot number for product traceability.\",\n \"qLote\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity contained in the batch.\",\n \"dFab\": \"required; string; YYYY-MM-DD; It records the product's manufacturing date.\",\n \"dVal\": \"required; string; YYYY-MM-DD; It records the product's expiration or best-before date.\",\n \"cAgreg\": \"optional; string; size 1..20; It carries an aggregation code linking related batches or units.\"\n }\n ],\n \"infProdNFF\": {\n \"cProdFisco\": \"required; string; size 1..60; It carries the fiscal product code as defined by the tax authority for NFF documents.\",\n \"cOperNFF\": \"required; string; size 1..12; It carries the operation code used in NFF (Nota Fiscal Fácil) emission.\"\n },\n \"infProdEmb\": {\n \"xEmb\": \"required; string; size 1..8; It identifies the packaging type for the product.\",\n \"qVolEmb\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity of items per packaging unit.\",\n \"uEmb\": \"required; string; size 1..8; It specifies the unit of measure for the packaging.\"\n },\n \"veicProd\": {\n \"tpOp\": \"required; string; size 1; values: 1 (dealership sale), 2 (direct manufacturer/importer), 3 (rural sale), 4 (other); It identifies the vehicle sale channel.\",\n \"chassi\": \"required; string; size 17; It carries the vehicle chassis number (VIN).\",\n \"cCor\": \"required; string; size 1..4; It carries the manufacturer's color code for the vehicle.\",\n \"xCor\": \"required; string; size 1..40; It describes the vehicle color in free text.\",\n \"pot\": \"required; string; size 1..4; It states the engine power in CV (horsepower).\",\n \"cilin\": \"required; string; size 1..4; It states the engine displacement in cubic centimeters.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"tpComb\": \"required; string; size 2; It identifies the fuel type using the RENAVAM classification code.\",\n \"nMotor\": \"required; string; size 1..21; It carries the engine number of the vehicle.\",\n \"CMT\": \"required; string; size 1..9; It states the maximum towing capacity (CMT) in kg.\",\n \"dist\": \"required; string; size 1..4; It states the wheelbase distance in millimeters.\",\n \"anoMod\": \"required; string; size 4; It states the vehicle model year.\",\n \"anoFab\": \"required; string; size 4; It states the vehicle manufacturing year.\",\n \"tpPint\": \"required; string; size 1; It identifies the paint type using the RENAVAM code.\",\n \"tpVeic\": \"required; string; size 1..2; It classifies the vehicle type using the RENAVAM code.\",\n \"espVeic\": \"required; string; size 1; It identifies the vehicle species using the RENAVAM code.\",\n \"VIN\": \"required; string; size 1; values: R (restamped VIN), N (normal VIN); It indicates whether the vehicle identification number was restamped.\",\n \"condVeic\": \"required; string; size 1; values: 1 (complete), 2 (incomplete), 3 (semi-complete); It describes the vehicle's completion status at the time of sale.\",\n \"cMod\": \"required; string; size 4; It carries the vehicle model code as registered with DENATRAN/SENATRAN.\",\n \"cCorDENATRAN\": \"required; string; size 2; It carries the DENATRAN color code for the vehicle.\",\n \"lota\": \"required; string; size 1..3; It states the maximum passenger capacity (lotação) of the vehicle.\",\n \"tpRest\": \"required; string; size 1; values: 0 (none), 1 (chattel mortgage), 2 (leasing), 3 (reservation of title), 4 (vehicle lien), 9 (other); It identifies any legal restriction registered on the vehicle.\"\n },\n \"med\": {\n \"cProdANVISA\": \"required; string; size 13 or 'ISENTO'; It carries the ANVISA product registration number for medicines, or the literal 'ISENTO' for exempt products.\",\n \"xMotivoIsencao\": \"optional; string; size 1..255; It provides the legal justification for ANVISA registration exemption.\",\n \"vPMC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Maximum Consumer Price (PMC) as set by CMED.\"\n },\n \"arma\": [\n {\n \"tpArma\": \"required; string; size 1; values: 0 (permitted use), 1 (restricted use); It classifies the firearm by its permitted use category.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"nCano\": \"required; string; size 1..15; It carries the barrel number of the firearm.\",\n \"descr\": \"required; string; size 1..256; It describes the firearm characteristics in free text.\"\n }\n ],\n \"comb\": {\n \"cProdANP\": \"required; string; size 9; It carries the ANP product code identifying the fuel type.\",\n \"descANP\": \"required; string; size 2..95; It provides the fuel description as registered with ANP.\",\n \"pGLP\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of LPG (GLP) in the fuel mixture.\",\n \"pGNn\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of non-compressed natural gas (GNn) in the mixture.\",\n \"pGNi\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of imported natural gas (GNi) in the mixture.\",\n \"vPart\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the reference value per fuel unit for ICMS split calculation.\",\n \"CODIF\": \"optional; string; size 1..21; It carries the CODIF authorization code for interstate fuel operations.\",\n \"qTemp\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the fuel quantity at reference temperature (20°C).\",\n \"UFCons\": \"required; string; size 2; It identifies the state (UF) where the fuel will be consumed, for ICMS apportionment.\",\n \"pBio\": \"optional; decimal; max 100; It states the biodiesel percentage in the fuel.\",\n \"CIDE\": {\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCIDE\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total CIDE (fuel intervention contribution) amount.\"\n },\n \"encerrante\": {\n \"nBico\": \"required; string; size 1..3; It identifies the fuel pump nozzle number.\",\n \"nBomba\": \"optional; string; size 1..3; It identifies the pump number associated with the nozzle.\",\n \"nTanque\": \"required; string; size 1..3; It identifies the fuel storage tank number.\",\n \"vEncIni\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the start of the operation.\",\n \"vEncFin\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the end of the operation.\"\n },\n \"origComb\": [\n {\n \"indImport\": \"required; string; size 1; values: 0 (domestic), 1 (imported); It classifies the fuel origin for ICMS apportionment purposes.\",\n \"cUFOrig\": \"required; string; size 2; It identifies the state of origin of the fuel using the IBGE code.\",\n \"pOrig\": \"required; decimal; max 100; It states the percentage of fuel from this origin in the mixture.\"\n }\n ]\n }\n },\n \"serv\": {\n \"locPrest\": {\n \"cLocPrestacao\": \"required; string; size 7; It carries the 7-digit code of the municipality, maritime waters area (0000000), or road concession segment where the service was provided.\",\n \"cPaisPrestacao\": \"required; string; size 2; It carries the ISO country code of the country where the service was rendered (for cross-border services).\"\n },\n \"cServ\": {\n \"cTribNac\": \"required; string; size 6; It carries the national ISSQN taxation code under LC 116/2003, as defined in the national service list (Annex III of the NFS-e contributor guide).\",\n \"cTribMun\": \"optional; string; size 3; It carries the municipal ISSQN taxation code assigned by the municipality of tax incidence.\",\n \"xDescServ\": \"required; string; size 1..1000; It provides a complete free-text description of the service rendered.\",\n \"cNBS\": \"optional; string; size 9; It carries the Brazilian Nomenclature of Services (NBS 2.0) code corresponding to the service rendered.\",\n \"cIntContrib\": \"optional; string; size 1..20; It carries the issuer's internal code for identifying the DPS in their own system.\"\n },\n \"comExt\": {\n \"mdPrestacao\": \"required; string; size 1; values: 0 (unknown/not informed in source document), 1 (cross-border), 2 (consumption in Brazil), 3 (temporary movement of individuals), 4 (consumption abroad); It identifies the mode of provision for cross-border service transactions.\",\n \"vincPrest\": \"required; string; size 1; values: 0 (no relationship), 1 (controlled), 2 (controlling), 3 (affiliated), 4 (parent), 5 (branch/subsidiary), 6 (other relationship), 9 (unknown); It indicates the legal or economic relationship between the service provider and the taker.\",\n \"tpMoeda\": \"required; string; size 3; It carries the ISO currency code of the foreign currency used in the commercial transaction.\",\n \"vServMoeda\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the service value expressed in the foreign currency identified by tpMoeda.\",\n \"mecAFComexP\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 (ACC), 03 (ACE), 04 (BNDES-Exim post-shipment), 05 (BNDES-Exim pre-shipment), 06 (FGE), 07 (PROEX equalization), 08 (PROEX financing); It identifies the trade finance mechanism used by the service provider.\",\n \"mecAFComexT\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 to 26 (various mechanisms per MDIC table); It identifies the trade finance or exemption mechanism used by the service taker.\",\n \"movTempBens\": \"required; string; size 1; values: 0 (unknown), 1 (not linked), 2 (linked to import declaration), 3 (linked to export declaration); It indicates whether the service is linked to a temporary movement of goods.\",\n \"nDI\": \"optional; string; size 1..12; It carries the number of the import declaration (DI/DSI/DA/DRI-E) related to the service.\",\n \"nRE\": \"optional; string; size 12; It carries the number of the export registration (Registro de Exportação) related to the service.\",\n \"mdic\": \"required; string; size 1; values: 0 (do not send to MDIC), 1 (send to MDIC); It indicates whether this NFS-e should be made available to the Ministry of Trade (MDIC).\"\n },\n \"lsadppu\": {\n \"categ\": \"required; string; It carries the category code for the public lighting or special public utility service.\",\n \"objeto\": \"required; string; It describes the object or purpose of the public utility service.\",\n \"extensao\": \"optional; string; It states the physical extension or length of the public utility installation.\",\n \"nPostes\": \"optional; string; It states the number of lighting poles related to the public utility service.\"\n },\n \"obra\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the construction site or for IPTU collection.\",\n \"cObra\": \"required; string; size 1..30; It carries the construction site identification number — either the CNO (National Construction Registry) or the CEI (INSS Specific Registry).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the construction site address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the construction site address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the construction site is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the construction site is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the construction site address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the construction site address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the construction site.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the construction site address.\"\n }\n },\n \"atvEvento\": {\n \"xNome\": \"required; string; size 1..255; It provides the name of the artistic, cultural, or sports event.\",\n \"dtIni\": \"required; string; YYYY-MM-DD; It records the start date of the event activity.\",\n \"dtFim\": \"required; string; YYYY-MM-DD; It records the end date of the event activity.\",\n \"idAtvEvt\": \"required; string; size 1..30; It carries the event activity identifier assigned by the municipal tax authority.\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the event venue address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the event venue in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the event is held.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the event is held.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the event venue address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the event venue address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the event venue.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the event venue address.\"\n }\n },\n \"explRod\": {\n \"categVeic\": \"required; string; It identifies the vehicle category for road toll calculation purposes.\",\n \"nEixos\": \"required; string; It states the number of axles of the vehicle for toll classification.\",\n \"rodagem\": \"required; string; It identifies the wheel configuration (single or dual) of the vehicle.\",\n \"sentido\": \"required; string; It indicates the direction of travel on the road concession (e.g., northbound, southbound).\",\n \"placa\": \"required; string; It carries the vehicle license plate number for road toll identification.\",\n \"codAcessoPed\": \"optional; string; It carries the toll access code associated with this road exploitation service.\",\n \"codContrato\": \"optional; string; It carries the contract number governing the road concession exploitation.\"\n },\n \"imovel\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the real estate or for IPTU collection.\",\n \"cCIB\": \"required; string; size 8; It carries the Brazilian Real Estate Registry code (Cadastro Imobiliário Brasileiro — CIB).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the property address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the property address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the property is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the property is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the property address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the property address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the property.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the property address.\"\n }\n },\n \"infoCompl\": {\n \"idDocTec\": \"optional; string; size 1..40; It carries the identifier of the technical responsibility document (ART, RRT, DRT, or other) associated with this service.\",\n \"docRef\": \"optional; string; size 1..255; It carries the key, number, or contract identifier of a document issued by the service provider that supports the issuance of this NFS-e by the taker or intermediary.\",\n \"xInfComp\": \"optional; string; size 1..2000; It provides free-text complementary information about the service, available to all service codes.\"\n },\n \"valores\": {\n \"vServPrest\": {\n \"vReceb\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monetary amount received by the service intermediary (R$).\",\n \"vServ\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total monetary value of the service rendered (R$).\"\n },\n \"vDescCondIncond\": {\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount (R$) granted to the service taker.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount (R$) dependent on specific conditions agreed between the parties.\"\n },\n \"vDedRed\": {\n \"pDR\": \"required; decimal; 3 integer + 2 decimal; It carries the percentage rate applied to the service value to calculate the ISSQN base reduction.\",\n \"vDR\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary amount used as a standard deduction or reduction of the service value for ISSQN base calculation purposes (R$).\",\n \"documentos\": {\n \"docDedRed\": [\n {\n \"chNFSe\": \"required; string; size 1..50; It carries the access key of the NFS-e (national standard) used as a deduction or reduction document in the ISSQN base calculation.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e used as a deduction or reduction document in the ISSQN base calculation.\"\n }\n ]\n }\n }\n }\n },\n \"imposto\": {\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\",\n \"ICMS\": {\n \"ICMS00\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\"\n },\n \"ICMS02\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\"\n },\n \"ICMS10\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS15\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemICMSReten\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate subject to withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"pRedAdRem\": \"optional; decimal; max 100; 3 integer + 2 decimal; It states the ad rem rate reduction percentage.\",\n \"motRedAdRem\": \"optional; string; It carries the reason code for the ad rem rate reduction.\"\n },\n \"ICMS20\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS30\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS40\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS51\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\"\n },\n \"ICMS53\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMonoOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSMonoDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred monophase ICMS amount.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoDif\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the deferred taxable quantity in the monophase regime.\",\n \"adRemICMSDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the deferred ad rem ICMS rate.\"\n },\n \"ICMS60\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMS61\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate previously retained.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\"\n },\n \"ICMS70\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS90\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMSPart\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pBCOp\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS base allocated to the operation state.\",\n \"UFST\": \"required; string; size 2; It identifies the destination state (UF) for ICMS-ST split.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMSST\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"vBCSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST base in the destination state.\",\n \"vICMSSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount in the destination state.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN101\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN102\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\"\n },\n \"ICMSSN201\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN202\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\"\n },\n \"ICMSSN500\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN900\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n }\n },\n \"ICMSUFDest\": {\n \"vBCUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS calculation base in the destination state (EC 87/2015).\",\n \"vBCFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base in the destination state.\",\n \"pFCPUFDest\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP rate in the destination state.\",\n \"pICMSUFDest\": \"required; decimal; 3 integer + 2..4 decimal; It states the internal ICMS rate of the destination state.\",\n \"pICMSInter\": \"required; string; size 4; values: 4.00 or 12.00; It states the interstate ICMS rate applicable to the operation (4% or 12%).\",\n \"pICMSInterPart\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS differential allocated to the destination state.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\"\n },\n \"IPI\": {\n \"CNPJProd\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the producer's CNPJ when different from the document issuer, for IPI purposes.\",\n \"cSelo\": \"optional; string; size 1..60; It carries the IPI control stamp code.\",\n \"qSelo\": \"optional; string; size 1..6; It states the quantity of IPI control stamps applied.\",\n \"cEnq\": \"required; string; size 3; It carries the IPI classification/framework code.\",\n \"IPITrib\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pIPI\": \"optional; decimal; 3 integer + 2..4 decimal; It states the IPI rate as a percentage.\",\n \"qUnid\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity in the IPI taxable unit.\",\n \"vUnid\": \"optional; decimal; 15 digits: 11 integer + 4 decimal; It states the IPI specific rate per taxable unit.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\"\n },\n \"IPINT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n }\n },\n \"II\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vDespAdu\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the customs handling fees (despesas aduaneiras) amount.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIOF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IOF (financial operations tax) amount levied on the import.\"\n },\n \"ISSQN\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vAliq\": \"required; decimal; 3 integer + 2..4 decimal; It states the ISS/ISSQN rate as a percentage.\",\n \"vISSQN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount due.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cListServ\": \"required; string; size 1..5; It identifies the service under the LC 116/2003 national service list.\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"indISS\": \"required; string; size 1; values: 1 (due), 2 (non-incidence), 3 (exempt), 4 (export), 5 (immunity), 6 (suspended by court order), 7 (suspended by administrative process); It classifies the ISS applicability status for this service.\",\n \"cServico\": \"optional; string; It carries the municipality's internal service classification code.\",\n \"cMun\": \"optional; string; size 7; It identifies the municipality where the service is provided, using the IBGE code.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for exported services.\",\n \"nProcesso\": \"optional; string; size 1..30; It carries the administrative or judicial process number related to ISS suspension.\",\n \"indIncentivo\": \"required; string; size 1; values: 1 (yes), 2 (no); It indicates whether the service benefits from a municipal ISS fiscal incentive.\"\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"PISOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n }\n },\n \"PISST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"indSomaPISST\": \"optional; string; size 1; It indicates whether the PIS-ST amount should be added to the item total.\"\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"COFINSOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n }\n },\n \"COFINSST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"indSomaCOFINSST\": \"optional; string; size 1; It indicates whether the COFINS-ST amount should be added to the item total.\"\n },\n \"IS\": {\n \"CSTIS\": \"required; string; size 3; pattern [0-9]{3}; Tax situation code for the Selective Tax (IS).\",\n \"cClassTribIS\": \"required; string; size 6; pattern [0-9]{6}; Tax classification code for IS.\",\n \"vBCIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; IS tax calculation base amount.\",\n \"pIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS rate as a percentage.\",\n \"adRemIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS specific rate (ad rem, per unit).\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Calculated IS amount.\"\n },\n \"IBSCBS\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"cClassTrib\": \"required; string; size 6; pattern [0-9]{6}; IBS/CBS tax classification code.\",\n \"indDoacao\": \"optional; string; size 1; fixed value 1; Indicates the operation is a donation.\",\n \"indDest\": \"required; string; size 1; values: 0 (the recipient is the same person as the taker identified in the NFS-e), 1 (the recipient is a different person or a different establishment from the taker); It indicates whether the service recipient is the same party as the acquiring taker.\",\n \"gIBSCBS\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"gIBSUF\": {\n \"pIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate as a percentage.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage (LC 214/25 art. 118).\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount (cashback on the invoice).\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate as a percentage.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gCBS\": {\n \"pCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate as a percentage.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n },\n \"gALCZFMCBS\": {\n \"_comment\": \"optional — ZFM/ALC incentive area CBS zero-rate group (NF-e variant)\",\n \"tpALCZFMCBS\": \"required; string; size 1; values: 1 (with Suframa-approved process), 2 (without approved process); Type of CBS zero-rate application in incentive areas.\",\n \"nProcSuframa\": \"optional; string; size 8..12; Suframa process number for the commercialized item.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; Reference CBS effective rate outside the incentive area.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value calculated outside the incentive area.\"\n }\n },\n \"gTribRegular\": {\n \"CSTReg\": \"required; string; size 3; CST that would apply without the condition.\",\n \"cClassTribReg\": \"required; string; size 6; cClassTrib that would apply without the condition.\",\n \"pAliqEfetRegIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state effective rate without condition.\",\n \"vTribRegIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value without condition.\",\n \"pAliqEfetRegIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal effective rate without condition.\",\n \"vTribRegIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value without condition.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS effective rate without condition.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value without condition.\"\n },\n \"gTribCompraGov\": {\n \"pAliqIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate before Art. 473 LC 214/2025 reduction.\",\n \"vTribIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value before Art. 473 reduction.\",\n \"pAliqIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate before Art. 473 reduction.\",\n \"vTribIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value before Art. 473 reduction.\",\n \"pAliqCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate before Art. 473 reduction.\",\n \"vTribCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value before Art. 473 reduction.\"\n }\n },\n \"gIBSCBSMono\": {\n \"gMonoPadrao\": {\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate.\",\n \"adRemCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate.\",\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase IBS amount.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase CBS amount.\"\n },\n \"gMonoReten\": {\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemIBSReten\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate subject to withholding.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS amount subject to withholding.\",\n \"adRemCBSReten\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount subject to withholding.\"\n },\n \"gMonoRet\": {\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemIBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld IBS ad rem rate.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld IBS amount.\",\n \"adRemCBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld CBS ad rem rate.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld CBS amount.\"\n },\n \"gMonoDif\": {\n \"pDifIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS deferral percentage.\",\n \"vIBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred IBS monophase amount.\",\n \"pDifCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS deferral percentage.\",\n \"vCBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred CBS monophase amount.\"\n },\n \"vTotIBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS for the item.\",\n \"vTotCBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS for the item.\"\n },\n \"gTransfCred\": {\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be transferred.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be transferred.\"\n },\n \"gAjusteCompet\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS adjustment amount.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS adjustment amount.\"\n }\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be reversed.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be reversed.\"\n },\n \"gCredPresOper\": {\n \"vBCCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit calculation base.\",\n \"cCredPres\": \"required; string; size 2; pattern [0-9]{2}; Presumed credit classification code.\",\n \"gIBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n },\n \"gCBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n }\n },\n \"gCredPresIBSZFM\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"vCredPresIBSZFM\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit amount calculated on the net debit balance.\"\n }\n },\n \"impostoDevol\": {\n \"pDevol\": \"required; decimal; max 100; 3 integer + 2 decimal; It states the percentage of IPI being returned in a product return operation.\",\n \"IPI\": {\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\"\n }\n },\n \"infAdProd\": \"optional; string; size 1..500; It provides free-text additional information about the product, which is printed on the DANFE.\",\n \"obsItem\": {\n \"obsCont\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n },\n \"obsFisco\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n },\n \"DFeReferenciado\": {\n \"chaveAcesso\": \"required; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}\",\n \"nItem\": \"optional; string; size 1..3\"\n }\n }\n ],\n \"total\": {\n \"ICMSTot\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"vST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total ICMS-ST amount.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\",\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vNF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total document value (net amount due).\",\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\"\n },\n \"ISSQNtot\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vISS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total ISSQN amount for the document.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"dCompet\": \"required; string; YYYY-MM-DD; It indicates the ISS competence date (month of service provision).\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"cRegTrib\": \"optional; string; size 1; values: 1 (Simples Nacional), 2 (estimate), 3 (professional partnership), 4 (cooperative), 5 (ME/EPP Simples Nacional), 6 (ME/EPP Simples Nacional excess); It identifies the ISS tax regime of the service provider.\"\n },\n \"retTrib\": {\n \"vRetPIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount withheld at source.\",\n \"vRetCOFINS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount withheld at source.\",\n \"vRetCSLL\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the CSLL amount withheld at source.\",\n \"vBCIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF (income tax at source) calculation base.\",\n \"vIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF amount withheld at source.\",\n \"vBCRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security withholding (INSS) calculation base.\",\n \"vRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security (INSS) amount withheld at source.\"\n },\n \"ISTot\": {\n \"vIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total Selective Tax (IS) amount for the document.\"\n },\n \"IBSCBSTot\": {\n \"vBCIBSCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS/CBS calculation base.\",\n \"gIBS\": {\n \"gIBSUF\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred state IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS tax refunds.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS amount.\"\n },\n \"gIBSMun\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred municipal IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS tax refunds.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS amount.\"\n },\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit under suspensive condition.\"\n },\n \"gCBS\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred CBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS tax refunds.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS amount.\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit under suspensive condition.\"\n },\n \"gMono\": {\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS subject to withholding.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase IBS.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase CBS.\"\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed IBS credit.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed CBS credit.\"\n }\n },\n \"vNFTot\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the grand total document value including IBS, CBS, and IS amounts.\"\n },\n \"transp\": {\n \"modFrete\": \"required; string; size 1; values: 0 (issuer's account CIF), 1 (recipient's account FOB), 2 (third-party account), 3 (issuer's own transport), 4 (recipient's own transport), 9 (no freight); It specifies who is responsible for the freight costs.\",\n \"transporta\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"xEnder\": \"optional; string; size 1..60; It provides the carrier's address in free text.\",\n \"xMun\": \"optional; string; size 2..60; It provides the carrier's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\"\n },\n \"retTransp\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBCRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport calculation base.\",\n \"pICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-transport withholding rate as a percentage.\",\n \"vICMSRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport withheld amount.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\"\n },\n \"veicTransp\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\"\n },\n \"reboque\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\",\n \"vagao\": \"optional; string; size 1..20; It carries the rail wagon identification for rail transport.\",\n \"balsa\": \"optional; string; size 1..20; It carries the barge identification for river transport.\"\n },\n \"vol\": [\n {\n \"qVol\": \"optional; string; size 1..15; It states the number of packages/volumes.\",\n \"esp\": \"optional; string; size 1..60; It describes the type of package/volume (e.g., caixa, fardo).\",\n \"marca\": \"optional; string; size 1..60; It carries the brand or mark of the packages.\",\n \"nVol\": \"optional; string; size 1..60; It carries the volume numbering or identification.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"lacres\": [\n {\n \"nLacre\": \"required; string; size 1..60; It carries the seal (lacre) number applied to the cargo.\"\n }\n ]\n }\n ]\n },\n \"cobr\": {\n \"fat\": {\n \"nFat\": \"optional; string; size 1..60; It carries the invoice (fatura) number for billing control.\",\n \"vOrig\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the original invoice amount before any discounts.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vLiq\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the net invoice amount after discounts.\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional; string; size 1..60; It identifies the installment (duplicata) number within the invoice.\",\n \"dVenc\": \"optional; string; YYYY-MM-DD; It records the due date for this installment.\",\n \"vDup\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the face value of this installment.\"\n }\n ]\n },\n \"pag\": {\n \"detPag\": [\n {\n \"indPag\": \"optional; string; size 1; values: 0 (cash/à vista), 1 (installment/à prazo); It indicates the payment timing condition.\",\n \"tPag\": \"required; string; size 2; values: 01 (cash), 02 (cheque), 03 (credit card), 04 (debit card), 05 (store credit), 10 (meal voucher), 11 (food voucher), 12 (gift card), 13 (fuel voucher), 14 (trade bill/duplicata), 15 (bank slip/boleto), 16 (bank deposit), 17 (PIX), 18 (wire transfer), 19 (cashback), 90 (no payment), 99 (other); It identifies the payment method used.\",\n \"xPag\": \"optional; string; size 2..60; It provides a description when tPag=99 (other payment method).\",\n \"vPag\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the amount paid using this payment method.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\",\n \"CNPJPag\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the bank or payment institution processing this payment.\",\n \"UFPag\": \"optional; string; size 2; It identifies the state (UF) of the payment institution.\",\n \"card\": {\n \"tpIntegra\": \"required; string; size 1; values: 1 (integrated TEF), 2 (non-integrated); It indicates whether the card payment was processed through an integrated electronic payment terminal.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"tBand\": \"optional; string; size 2; values: 01 (Visa), 02 (Mastercard), 03 (Amex), 04 (Sorocred), 05 (Diners), 06 (Elo), 07 (Hipercard), 08 (Aura), 09 (Cabal), 99 (other); It identifies the card network/brand.\",\n \"cAut\": \"optional; string; size 1..20; It carries the card transaction authorization code.\",\n \"CNPJReceb\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the payment recipient's CNPJ, which may differ from the document issuer.\",\n \"idTermPag\": \"optional; string; size 1..40; It carries the payment terminal identifier.\"\n }\n }\n ],\n \"vTroco\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the change amount returned to the customer (NFC-e).\"\n },\n \"infIntermed\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"idCadIntTran\": \"required; string; size 2..60; It carries the intermediary's registration ID on the digital platform.\"\n },\n \"infAdic\": {\n \"infAdFisco\": \"optional; string; size 1..2000; It contains additional fiscal information required by the tax authority, printed on the DANFE.\",\n \"infCpl\": \"optional; string; size 1..5000; It contains complementary information added by the issuer, printed on the DANFE.\",\n \"obsCont\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"obsFisco\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"required; string; size 1..60; It carries the administrative or judicial process number referenced.\",\n \"indProc\": \"required; string; size 1; values: 0 (SEFAZ), 1 (Federal Court), 2 (State Court), 3 (SECEX/RFB), 9 (other); It identifies the type of process or authority issuing the referenced act.\",\n \"tpAto\": \"optional; string; size 2; values: 08 (summons), 10 (decision), 12 (sentence), 15 (court ruling/acórdão); It classifies the type of legal act referenced.\"\n }\n ]\n },\n \"exporta\": {\n \"UFSaidaPais\": \"required; string; size 2; It identifies the Brazilian state through which the exported goods will exit the country.\",\n \"xLocExporta\": \"required; string; size 1..60; It describes the export customs clearance location in free text.\",\n \"xLocDespacho\": \"optional; string; size 1..60; It describes the goods dispatch location for export purposes.\"\n },\n \"compra\": {\n \"xNEmp\": \"optional; string; size 1..17; It carries the purchase order or budget note number from the buyer.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"xCont\": \"optional; string; size 1..60; It carries the contract number associated with this purchase.\"\n },\n \"cana\": {\n \"safra\": \"required; string; size 4..9; It identifies the sugarcane harvest (safra) reference period.\",\n \"ref\": \"required; string; size 7; format AAMM; It indicates the year-month reference for the sugarcane supply.\",\n \"forDia\": [\n {\n \"dia\": \"required; string; size 1..2; It identifies the calendar day within the supply month.\",\n \"qtde\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the sugarcane quantity supplied on this day.\"\n }\n ],\n \"qTotMes\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied in the current month.\",\n \"qTotAnt\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the cumulative sugarcane quantity supplied in prior months of this harvest.\",\n \"qTotGer\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied across the entire harvest period.\",\n \"deduc\": [\n {\n \"xDed\": \"required; string; size 1..60; It describes the deduction type applied to the sugarcane supply value.\",\n \"vDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the deduction amount.\"\n }\n ],\n \"vFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross supply value before deductions.\",\n \"vTotDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total deductions applied.\",\n \"vLiqFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the net supply value after all deductions.\"\n },\n \"infRespTec\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xContato\": \"required; string; size 2..60; It provides the name of the technical contact person at the responsible company.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"idCSRT\": \"optional; string; size 2; It carries the two-digit identifier of the CSRT security token.\",\n \"hashCSRT\": \"optional; string; size 28; It carries the SHA-1 hash of the CSRT token concatenated with the NF-e access key, encoded in base64.\"\n },\n \"infSolicNFF\": {\n \"xSolic\": \"required; string; size 2..1000; It carries the NFF request information in free text.\"\n },\n \"agropecuario\": {\n \"defensivo\": [\n {\n \"nReceituario\": \"required; string; size 1..20; It carries the prescription number issued by the agronomist for the pesticide.\",\n \"CPFRespTec\": \"required; string; size 11; pattern [0-9]{11}; It identifies the agronomist or technician who prescribed the pesticide by their CPF.\"\n }\n ],\n \"guiaTransito\": {\n \"tpGuia\": \"required; string; size 2; values: 01 (animal transit), 02 (plant transit); It classifies the transit permit type for agricultural products.\",\n \"UFGuia\": \"required; string; size 2; It identifies the state that issued the transit permit.\",\n \"serieGuia\": \"optional; string; size 1..9; It carries the series number of the transit permit.\",\n \"nGuia\": \"required; string; size 1..20; It carries the transit permit number.\"\n }\n },\n \"infPAA\": {\n \"CNPJPAA\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the Signature and Authorization Provider (PAA) by their CNPJ.\",\n \"PAASignature\": {\n \"SignatureValue\": \"required; string; base64-encoded binary; It carries the PAA's digital signature value.\",\n \"RSAKeyValue\": \"required; object; It contains the RSA public key (Modulus and Exponent) used to verify the PAA signature.\"\n }\n }\n },\n \"infNFeSupl\": {\n \"qrCode\": \"required; string; size 1..1000; It carries the QR Code URL string for NFC-e consumer verification.\",\n \"urlChave\": \"required; string; size 1..85; It carries the URL for NFC-e access key consultation.\"\n },\n \"Signature\": \"required; object; It contains the XML-DSig digital signature of the NF-e, ensuring document integrity and authenticity.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/event/{tpEvento}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"57b1668e-b86e-4cd6-b00c-70c687383d32","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"accountId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"NFe\": {\n \"infNFe\": {\n \"_attr_Id\": \"required; string; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It uniquely identifies the NF-e by its 44-character access key, embedded as an XML attribute.\",\n \"_attr_versao\": \"required; string; It specifies the NF-e schema version used in the document.\",\n \"ide\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"cNF\": \"required; string; size 8; It carries an 8-digit random numeric code used as part of the NF-e access key composition.\",\n \"natOp\": \"required; string; size 1..60; It informs the nature of the operation in free text (e.g., 'Venda de mercadoria', 'Devolução').\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\",\n \"dhEmi\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the NF-e was issued.\",\n \"dhSaiEnt\": \"optional; string; YYYY-MM-DDThh:mm:ssTZD; It indicates the date and time of goods departure (outbound) or receipt (inbound).\",\n \"dPrevEntrega\": \"optional; string; YYYY-MM-DD; It informs the expected delivery date of the goods to the recipient.\",\n \"dCompet\": \"optional; string; YYYY-MM-DD; It provides the date of competence of the operation for service operations (NFS-e).\",\n \"tpNF\": \"required; string; size 1; values: 0 (inbound/entrada), 1 (outbound/saída); It indicates the direction of the operation.\",\n \"idDest\": \"required; string; size 1; values: 1 (within the same state), 2 (interstate), 3 (international); It classifies the geographic scope of the operation.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cMunFGIBS\": \"optional; string; size 7; It identifies the municipality of the IBS taxable event when different from cMunFG, using the IBGE code.\",\n \"tpImp\": \"required; string; size 1; values: 0 (no DANFE), 1 (portrait), 2 (landscape), 3 (simplified), 4 (NFC-e), 5 (NFC-e electronic message); It specifies the DANFE print format.\",\n \"tpEmis\": \"required; string; size 1; values: 1 (normal), 2 (FS contingency), 3 (SVC-AN), 4 (SVC-RS), 5 (FS-DA contingency), 6 (SVC-AN alt), 7 (SVC-RS alt), 9 (NFC-e offline); It identifies the emission mode, distinguishing normal from contingency.\",\n \"cDV\": \"required; string; size 1; It is the check digit of the 44-character NF-e access key, calculated using modulo 11.\",\n \"tpAmb\": \"required; string; size 1; values: 1 (production), 2 (homologation/testing); It indicates the environment in which the NF-e is being issued.\",\n \"finNFe\": \"required; string; size 1; values: 1 (normal NF-e), 2 (complementary), 3 (adjustment), 4 (return/devolution); It defines the fiscal purpose of the document.\",\n \"tpNFDebito\": \"optional; string; It classifies the debit NF-e type as defined by the tax authority.\",\n \"tpNFCredito\": \"optional; string; It classifies the credit NF-e type as defined by the tax authority.\",\n \"indFinal\": \"required; string; size 1; values: 0 (not a final consumer), 1 (final consumer); It indicates whether the recipient is the end consumer of the goods.\",\n \"indPres\": \"required; string; size 1; values: 0 (not applicable), 1 (in-person), 2 (internet), 3 (telephone service), 4 (NFC-e home delivery), 5 (in-person outside the establishment), 9 (other); It indicates whether the buyer was physically present at the point of sale.\",\n \"indIntermed\": \"optional; string; size 1; values: 0 (no intermediary), 1 (with intermediary/marketplace); It flags whether the operation was conducted through a digital marketplace or platform.\",\n \"cIndOp\": \"optional; string; size 1..6; It carries the operation indicator code as defined by the issuer's internal or industry classification.\",\n \"procEmi\": \"required; string; size 1; values: 0 (taxpayer application), 1 (standalone by Fisco), 2 (SCAN/DPEC standalone), 3 (taxpayer app provided by Fisco); It identifies which process and software were used to generate the NF-e.\",\n \"verProc\": \"required; string; size 1..20; It records the version of the application or process used to emit the NF-e.\",\n \"dhCont\": \"required; string; YYYY-MM-DDThh:mm:ssTZD; It records the date and time when the contingency mode was activated.\",\n \"xJust\": \"required; string; size 15..256; It provides the mandatory justification text explaining why contingency emission was used.\",\n \"tpEmit\": \"required; string; size 1; values: 1 (service provider/prestador), 2 (service taker/tomador), 3 (intermediary/intermediário); It identifies who is issuing the DPS/NFS-e.\",\n \"cMotivoEmisTI\": \"optional; string; size 1; values: 1 (service import), 2 (taker/intermediary required by municipal law), 3 (taker/intermediary issuing due to provider refusal), 4 (taker/intermediary rejecting provider's NFS-e); It indicates the reason why the taker or intermediary is issuing the DPS instead of the service provider.\",\n \"chNFSeRej\": \"optional; string; size 1..50; It carries the access key of the NFS-e previously rejected by the taker or intermediary, referenced when cMotivoEmisTI=4.\",\n \"cLocEmi\": \"required; string; size 7; It carries the 7-digit IBGE code of the municipality that authorized the issuance of this NFS-e.\",\n \"subst\": {\n \"chSubstda\": \"required; string; size 1..50; It carries the access key of the NFS-e being substituted.\",\n \"cMotivo\": \"required; string; size 1; values: 1 (opt-out of Simples Nacional), 2 (opt-in to Simples Nacional), 3 (retroactive inclusion of immunity/exemption), 4 (retroactive exclusion of immunity/exemption), 5 (rejection by taker or intermediary), 99 (other); It indicates the reason for substituting the NFS-e.\",\n \"xMotivo\": \"optional; string; size 15..255; It provides a free-text description of the substitution reason when cMotivo=99.\"\n },\n \"NFref\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\",\n \"refNFeSig\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e (simplified model) by its access key.\",\n \"refNF\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refNFP\": {\n \"cUF\": \"required; string; size 2; It identifies the Brazilian state (UF) of the issuer using the IBGE numeric code.\",\n \"AAMM\": \"required; string; size 4; format AAMM (e.g., 2403 = March 2024); It indicates the year and month of issuance of the referenced document.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"serie\": \"required; string; pattern 0..999; It identifies the document series number, used to distinguish issuance batches.\",\n \"nNF\": \"required; string; pattern 1..999999999; It is the sequential number of the fiscal document within the series.\"\n },\n \"refCTe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a CT-e (transport document) related to this NF-e by its access key.\",\n \"refECF\": {\n \"mod\": \"required; string; size 2; values: 55 (NF-e), 65 (NFC-e); It identifies the fiscal document model.\",\n \"nECF\": \"required; string; size 3; It identifies the ECF (electronic cash register) equipment number.\",\n \"nCOO\": \"required; string; size 6; It carries the Counter of Fiscal Operations (COO) from the referenced ECF receipt.\"\n }\n }\n ],\n \"gCompraGov\": {\n \"tpEnteGov\": \"required; string; size 1; values: 1 (Union/Federal), 2 (State), 3 (Federal District), 4 (Municipality), 5 (Public Consortium), 6 (IBS Management Committee); It identifies the type of government entity involved in the purchase.\",\n \"pRedutor\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the IBS/CBS rate reduction percentage applicable to government purchases.\",\n \"tpOperGov\": \"required; string; size 1; values: 1 (supply with later payment), 2 (payment received, supply already done), 3 (supply with payment already made), 4 (payment received, supply pending); It identifies the operational sequence of a government purchase.\",\n \"refDFeAnt\": \"optional; string; size 44; repeatable 0..99; pattern [0-9]{6}[A-Z0-9]{12}[0-9]{26}; It references previous fiscal documents for tpOperGov 2 or 3.\"\n },\n \"gPagAntecipado\": [\n {\n \"refNFe\": \"optional; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}; It references a previously issued NF-e by its full 44-character access key.\"\n }\n ]\n },\n \"emit\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"xFant\": \"optional; string; size 1..60; It provides the trade name or fantasy name used by the issuer commercially.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"IEST\": \"optional; string; size 2..14; It carries the state tax registration for ICMS tax substitution in a state different from the issuer's.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"CNAE\": \"optional; string; size 7; It identifies the issuer's primary economic activity using the CNAE classification code.\",\n \"CRT\": \"required; string; size 1; values: 1 (Simples Nacional), 2 (Simples Nacional — excess revenue), 3 (Normal Regime), 4 (Simples Nacional SIMEI); It identifies the tax regime of the issuer.\",\n \"ISUFEmit\": \"optional; string; size 8..9; It carries the issuer's SUFRAMA registration number for operations in incentive zones (ZFM/ALC).\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the issuer when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the issuer.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the issuer.\",\n \"enderEmit\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the issuer's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the issuer's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the issuer (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the issuer's address.\",\n \"cMun\": \"required; string; size 7; It identifies the issuer's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the issuer's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the issuer's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"required; string; size 8; It carries the issuer's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the issuer's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the issuer's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the issuer's contact phone number.\"\n }\n },\n \"avulsa\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xOrgao\": \"required; string; size 1..60; It names the tax authority that issued the standalone NF-e.\",\n \"matr\": \"required; string; size 1..60; It carries the registration number of the tax agent who authorized the avulsa NF-e.\",\n \"xAgente\": \"required; string; size 1..60; It provides the full name of the tax agent responsible for the avulsa NF-e.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\",\n \"nDAR\": \"optional; string; size 1..60; It carries the DAR (tax collection document) number related to the avulsa emission.\",\n \"dEmi\": \"optional; string; YYYY-MM-DD; It records the issuance date of the DAR.\",\n \"vDAR\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary value of the DAR payment.\",\n \"repEmi\": \"required; string; size 1..60; It identifies the Fisco representative who signed the avulsa document.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\"\n },\n \"dest\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"idEstrangeiro\": \"optional; string; size 2..20; It identifies a foreign recipient who does not hold a Brazilian CNPJ or CPF.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"indIEDest\": \"required; string; size 1; values: 1 (ICMS taxpayer), 2 (ICMS-exempt taxpayer), 9 (non-taxpayer); It classifies the recipient's ICMS tax registration status.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"ISUF\": \"optional; string; size 8..9; It carries the recipient's SUFRAMA registration number for incentive zone operations.\",\n \"IM\": \"optional; string; size 1..15; It carries the municipal tax registration (Inscrição Municipal) of the issuer.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"NIF\": \"optional; string; size 1..40; It carries the fiscal identification number issued by a foreign tax authority for the recipient when they are not a Brazilian resident.\",\n \"cNaoNIF\": \"optional; string; size 1; values: 0 (not informed in original document), 1 (NIF not required), 2 (NIF not mandatory); It indicates the reason for omitting the NIF of the recipient.\",\n \"CAEPF\": \"optional; string; size 14; It carries the Cadastro de Atividade Econômica da Pessoa Física (CAEPF) registration number of the recipient.\",\n \"enderDest\": {\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the recipient's address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the recipient's address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the recipient (e.g., apartment, floor).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the recipient's address.\",\n \"cMun\": \"required; string; size 7; It identifies the recipient's municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the recipient's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the recipient's state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the recipient's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the recipient's address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the recipient's country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the recipient's contact phone number.\"\n }\n },\n \"retirada\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"entrega\": {\n \"CNPJ\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the entity at the pickup/delivery location by their alphanumeric CNPJ.\",\n \"xNome\": \"optional; string; size 2..60; It provides the legal name of the entity at the pickup/delivery location.\",\n \"xLgr\": \"required; string; size 2..60; It provides the street name of the pickup/delivery address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the pickup/delivery address.\",\n \"xCpl\": \"optional; string; size 1..60; It provides address complement information for the pickup/delivery location (e.g., warehouse, dock).\",\n \"xBairro\": \"required; string; size 2..60; It identifies the neighborhood (bairro) of the pickup/delivery address.\",\n \"cMun\": \"required; string; size 7; It identifies the pickup/delivery municipality using the IBGE code.\",\n \"xMun\": \"required; string; size 2..60; It provides the pickup/delivery municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the pickup/delivery state (UF) using the two-letter abbreviation.\",\n \"CEP\": \"optional; string; size 8; It carries the pickup/delivery location's Brazilian postal code (CEP) with 8 digits.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for the pickup/delivery address (for foreign addresses).\",\n \"xPais\": \"optional; string; size 2..60; It provides the pickup/delivery country name in free text.\",\n \"fone\": \"optional; string; size 6..14; It provides the contact phone number at the pickup/delivery location.\",\n \"email\": \"optional; string; size 1..60; It provides the contact email address at the pickup/delivery location.\",\n \"IE\": \"optional; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the entity at the pickup/delivery location.\"\n },\n \"autXML\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\"\n },\n \"det\": [\n {\n \"nItem\": \"required; integer; range 1..990; It is the sequential line-item number within the NF-e.\",\n \"vItem\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total value of this line item.\",\n \"prod\": {\n \"cProd\": \"required; string; size 1..60; It carries the issuer's internal product or service code.\",\n \"cEAN\": \"required; string; It carries the product's GTIN barcode; use the literal 'SEM GTIN' when not applicable.\",\n \"cBarra\": \"optional; string; size 3..30; It carries an additional non-GTIN barcode for the product.\",\n \"xProd\": \"required; string; size 1..120; It describes the product or service in free text.\",\n \"NCM\": \"required; string; size 2..8; It classifies the product under the Mercosur Common Nomenclature (NCM/SH).\",\n \"NVE\": [\n \"optional; string; size 6; It carries the NVE (Nomenclatura de Valor Aduaneiro e Estatística) code for the product; repeatable 0..8 entries.\"\n ],\n \"CEST\": \"optional; string; size 7; It carries the CEST code identifying products subject to ICMS tax substitution.\",\n \"indEscala\": \"optional; string; size 1; values: S (relevant scale), N (not at relevant scale); It indicates whether the product is manufactured at commercially relevant scale.\",\n \"CNPJFab\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the manufacturer's CNPJ; required when indEscala=N.\",\n \"cBenef\": \"optional; string; size 8..10; It carries the fiscal benefit code (state or federal) applicable to the product.\",\n \"gCred\": {\n \"cCredPresumido\": \"required; string; It carries the classification code for the presumed credit applicable to this product.\",\n \"pCredPresumido\": \"required; decimal; 3 integer + 2..4 decimal; It specifies the presumed credit rate as a percentage.\",\n \"vCredPresumido\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the calculated presumed credit monetary value.\"\n },\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"EXTIPI\": \"optional; string; size 2..3; It carries the TIPI exception code for the product when different from the base NCM.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"uCom\": \"required; string; size 1..6; It specifies the unit of measure used in the commercial transaction (e.g., UN, KG, CX).\",\n \"qCom\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity sold or transferred in commercial units.\",\n \"vUnCom\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price in the commercial transaction.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"cEANTrib\": \"required; string; It carries the taxable GTIN barcode; use 'SEM GTIN' when not applicable.\",\n \"cBarraTrib\": \"optional; string; size 3..30; It carries an additional non-GTIN taxable barcode.\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vUnTrib\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the unit price for tax calculation purposes.\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"indTot\": \"required; string; size 1; values: 0 (not included in vProd total), 1 (included in vProd total); It controls whether the item value is summed into the document total.\",\n \"indBemMovelUsado\": \"optional; string; It flags the item as a used movable asset subject to specific ICMS rules.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"nItemPed\": \"optional; string; size 1..6; It identifies the specific line number within the buyer's purchase order.\",\n \"nFCI\": \"optional; string; size 36; It carries the GUID of the Import Content Form (FCI) for products with imported inputs.\",\n \"nRECOPI\": \"optional; string; size 20; It carries the RECOPI registration number for paper products subject to control.\",\n \"DI\": [\n {\n \"nDI\": \"required; string; size 1..12; It carries the import declaration number (DI, DSI, DA, or DIRE).\",\n \"dDI\": \"required; string; YYYY-MM-DD; It records the date the import declaration was registered at Receita Federal.\",\n \"xLocDesemb\": \"required; string; size 1..60; It describes the customs clearance location.\",\n \"UFDesemb\": \"required; string; size 2; It identifies the state where customs clearance took place.\",\n \"dDesemb\": \"required; string; YYYY-MM-DD; It records the date goods were cleared through customs.\",\n \"tpViaTransp\": \"required; string; size 2; values: 1 (maritime), 2 (river), 3 (lake), 4 (air), 5 (postal), 6 (rail), 7 (road), 8 (pipeline), 9 (own means), 10 (fictitious), 11 (courier), 12 (handcarry); It identifies the transport modality used to bring goods into Brazil.\",\n \"vAFRMM\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the AFRMM (marine freight renewal fee) amount.\",\n \"tpIntermedio\": \"required; string; size 1; values: 1 (own account import), 2 (import on behalf of third party), 3 (import by order); It identifies the legal relationship between the importer and the purchaser.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"UFTerceiro\": \"optional; string; size 2; It identifies the state of the acquiring or ordering party in a third-party import.\",\n \"cExportador\": \"required; string; size 1..60; It carries the exporter's identification code as registered in the import declaration.\",\n \"adi\": [\n {\n \"nAdicao\": \"optional; string; size 1..3; It identifies the addition number within the import declaration.\",\n \"nSeqAdic\": \"required; string; size 1..3; It carries the sequential number of this item within the DI addition.\",\n \"cFabricante\": \"required; string; size 1..60; It identifies the manufacturer as declared in the import addition.\",\n \"vDescDI\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount applied at the DI addition level.\",\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\"\n }\n ]\n }\n ],\n \"detExport\": {\n \"nDraw\": \"optional; string; size 1..20; It carries the drawback concession act number, used for re-export benefit control.\",\n \"exportInd\": [\n {\n \"nRE\": \"required; string; size 12; It carries the Export Registry (Registro de Exportação) number.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e referencing the export.\",\n \"qExport\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity effectively exported.\"\n }\n ]\n },\n \"rastro\": [\n {\n \"nLote\": \"required; string; size 1..20; It carries the batch or lot number for product traceability.\",\n \"qLote\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity contained in the batch.\",\n \"dFab\": \"required; string; YYYY-MM-DD; It records the product's manufacturing date.\",\n \"dVal\": \"required; string; YYYY-MM-DD; It records the product's expiration or best-before date.\",\n \"cAgreg\": \"optional; string; size 1..20; It carries an aggregation code linking related batches or units.\"\n }\n ],\n \"infProdNFF\": {\n \"cProdFisco\": \"required; string; size 1..60; It carries the fiscal product code as defined by the tax authority for NFF documents.\",\n \"cOperNFF\": \"required; string; size 1..12; It carries the operation code used in NFF (Nota Fiscal Fácil) emission.\"\n },\n \"infProdEmb\": {\n \"xEmb\": \"required; string; size 1..8; It identifies the packaging type for the product.\",\n \"qVolEmb\": \"required; decimal; 11 digits: 8 integer + 1..3 decimal; It states the quantity of items per packaging unit.\",\n \"uEmb\": \"required; string; size 1..8; It specifies the unit of measure for the packaging.\"\n },\n \"veicProd\": {\n \"tpOp\": \"required; string; size 1; values: 1 (dealership sale), 2 (direct manufacturer/importer), 3 (rural sale), 4 (other); It identifies the vehicle sale channel.\",\n \"chassi\": \"required; string; size 17; It carries the vehicle chassis number (VIN).\",\n \"cCor\": \"required; string; size 1..4; It carries the manufacturer's color code for the vehicle.\",\n \"xCor\": \"required; string; size 1..40; It describes the vehicle color in free text.\",\n \"pot\": \"required; string; size 1..4; It states the engine power in CV (horsepower).\",\n \"cilin\": \"required; string; size 1..4; It states the engine displacement in cubic centimeters.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"tpComb\": \"required; string; size 2; It identifies the fuel type using the RENAVAM classification code.\",\n \"nMotor\": \"required; string; size 1..21; It carries the engine number of the vehicle.\",\n \"CMT\": \"required; string; size 1..9; It states the maximum towing capacity (CMT) in kg.\",\n \"dist\": \"required; string; size 1..4; It states the wheelbase distance in millimeters.\",\n \"anoMod\": \"required; string; size 4; It states the vehicle model year.\",\n \"anoFab\": \"required; string; size 4; It states the vehicle manufacturing year.\",\n \"tpPint\": \"required; string; size 1; It identifies the paint type using the RENAVAM code.\",\n \"tpVeic\": \"required; string; size 1..2; It classifies the vehicle type using the RENAVAM code.\",\n \"espVeic\": \"required; string; size 1; It identifies the vehicle species using the RENAVAM code.\",\n \"VIN\": \"required; string; size 1; values: R (restamped VIN), N (normal VIN); It indicates whether the vehicle identification number was restamped.\",\n \"condVeic\": \"required; string; size 1; values: 1 (complete), 2 (incomplete), 3 (semi-complete); It describes the vehicle's completion status at the time of sale.\",\n \"cMod\": \"required; string; size 4; It carries the vehicle model code as registered with DENATRAN/SENATRAN.\",\n \"cCorDENATRAN\": \"required; string; size 2; It carries the DENATRAN color code for the vehicle.\",\n \"lota\": \"required; string; size 1..3; It states the maximum passenger capacity (lotação) of the vehicle.\",\n \"tpRest\": \"required; string; size 1; values: 0 (none), 1 (chattel mortgage), 2 (leasing), 3 (reservation of title), 4 (vehicle lien), 9 (other); It identifies any legal restriction registered on the vehicle.\"\n },\n \"med\": {\n \"cProdANVISA\": \"required; string; size 13 or 'ISENTO'; It carries the ANVISA product registration number for medicines, or the literal 'ISENTO' for exempt products.\",\n \"xMotivoIsencao\": \"optional; string; size 1..255; It provides the legal justification for ANVISA registration exemption.\",\n \"vPMC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Maximum Consumer Price (PMC) as set by CMED.\"\n },\n \"arma\": [\n {\n \"tpArma\": \"required; string; size 1; values: 0 (permitted use), 1 (restricted use); It classifies the firearm by its permitted use category.\",\n \"nSerie\": \"required; string; size 1..9; It carries the vehicle's serial number.\",\n \"nCano\": \"required; string; size 1..15; It carries the barrel number of the firearm.\",\n \"descr\": \"required; string; size 1..256; It describes the firearm characteristics in free text.\"\n }\n ],\n \"comb\": {\n \"cProdANP\": \"required; string; size 9; It carries the ANP product code identifying the fuel type.\",\n \"descANP\": \"required; string; size 2..95; It provides the fuel description as registered with ANP.\",\n \"pGLP\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of LPG (GLP) in the fuel mixture.\",\n \"pGNn\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of non-compressed natural gas (GNn) in the mixture.\",\n \"pGNi\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the percentage of imported natural gas (GNi) in the mixture.\",\n \"vPart\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the reference value per fuel unit for ICMS split calculation.\",\n \"CODIF\": \"optional; string; size 1..21; It carries the CODIF authorization code for interstate fuel operations.\",\n \"qTemp\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the fuel quantity at reference temperature (20°C).\",\n \"UFCons\": \"required; string; size 2; It identifies the state (UF) where the fuel will be consumed, for ICMS apportionment.\",\n \"pBio\": \"optional; decimal; max 100; It states the biodiesel percentage in the fuel.\",\n \"CIDE\": {\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCIDE\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total CIDE (fuel intervention contribution) amount.\"\n },\n \"encerrante\": {\n \"nBico\": \"required; string; size 1..3; It identifies the fuel pump nozzle number.\",\n \"nBomba\": \"optional; string; size 1..3; It identifies the pump number associated with the nozzle.\",\n \"nTanque\": \"required; string; size 1..3; It identifies the fuel storage tank number.\",\n \"vEncIni\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the start of the operation.\",\n \"vEncFin\": \"required; decimal; 15 digits: 12 integer + 3 decimal; It records the pump counter reading at the end of the operation.\"\n },\n \"origComb\": [\n {\n \"indImport\": \"required; string; size 1; values: 0 (domestic), 1 (imported); It classifies the fuel origin for ICMS apportionment purposes.\",\n \"cUFOrig\": \"required; string; size 2; It identifies the state of origin of the fuel using the IBGE code.\",\n \"pOrig\": \"required; decimal; max 100; It states the percentage of fuel from this origin in the mixture.\"\n }\n ]\n }\n },\n \"serv\": {\n \"locPrest\": {\n \"cLocPrestacao\": \"required; string; size 7; It carries the 7-digit code of the municipality, maritime waters area (0000000), or road concession segment where the service was provided.\",\n \"cPaisPrestacao\": \"required; string; size 2; It carries the ISO country code of the country where the service was rendered (for cross-border services).\"\n },\n \"cServ\": {\n \"cTribNac\": \"required; string; size 6; It carries the national ISSQN taxation code under LC 116/2003, as defined in the national service list (Annex III of the NFS-e contributor guide).\",\n \"cTribMun\": \"optional; string; size 3; It carries the municipal ISSQN taxation code assigned by the municipality of tax incidence.\",\n \"xDescServ\": \"required; string; size 1..1000; It provides a complete free-text description of the service rendered.\",\n \"cNBS\": \"optional; string; size 9; It carries the Brazilian Nomenclature of Services (NBS 2.0) code corresponding to the service rendered.\",\n \"cIntContrib\": \"optional; string; size 1..20; It carries the issuer's internal code for identifying the DPS in their own system.\"\n },\n \"comExt\": {\n \"mdPrestacao\": \"required; string; size 1; values: 0 (unknown/not informed in source document), 1 (cross-border), 2 (consumption in Brazil), 3 (temporary movement of individuals), 4 (consumption abroad); It identifies the mode of provision for cross-border service transactions.\",\n \"vincPrest\": \"required; string; size 1; values: 0 (no relationship), 1 (controlled), 2 (controlling), 3 (affiliated), 4 (parent), 5 (branch/subsidiary), 6 (other relationship), 9 (unknown); It indicates the legal or economic relationship between the service provider and the taker.\",\n \"tpMoeda\": \"required; string; size 3; It carries the ISO currency code of the foreign currency used in the commercial transaction.\",\n \"vServMoeda\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the service value expressed in the foreign currency identified by tpMoeda.\",\n \"mecAFComexP\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 (ACC), 03 (ACE), 04 (BNDES-Exim post-shipment), 05 (BNDES-Exim pre-shipment), 06 (FGE), 07 (PROEX equalization), 08 (PROEX financing); It identifies the trade finance mechanism used by the service provider.\",\n \"mecAFComexT\": \"required; string; size 2; values: 00 (unknown), 01 (none), 02 to 26 (various mechanisms per MDIC table); It identifies the trade finance or exemption mechanism used by the service taker.\",\n \"movTempBens\": \"required; string; size 1; values: 0 (unknown), 1 (not linked), 2 (linked to import declaration), 3 (linked to export declaration); It indicates whether the service is linked to a temporary movement of goods.\",\n \"nDI\": \"optional; string; size 1..12; It carries the number of the import declaration (DI/DSI/DA/DRI-E) related to the service.\",\n \"nRE\": \"optional; string; size 12; It carries the number of the export registration (Registro de Exportação) related to the service.\",\n \"mdic\": \"required; string; size 1; values: 0 (do not send to MDIC), 1 (send to MDIC); It indicates whether this NFS-e should be made available to the Ministry of Trade (MDIC).\"\n },\n \"lsadppu\": {\n \"categ\": \"required; string; It carries the category code for the public lighting or special public utility service.\",\n \"objeto\": \"required; string; It describes the object or purpose of the public utility service.\",\n \"extensao\": \"optional; string; It states the physical extension or length of the public utility installation.\",\n \"nPostes\": \"optional; string; It states the number of lighting poles related to the public utility service.\"\n },\n \"obra\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the construction site or for IPTU collection.\",\n \"cObra\": \"required; string; size 1..30; It carries the construction site identification number — either the CNO (National Construction Registry) or the CEI (INSS Specific Registry).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the construction site address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the construction site address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the construction site is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the construction site is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the construction site address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the construction site address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the construction site.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the construction site address.\"\n }\n },\n \"atvEvento\": {\n \"xNome\": \"required; string; size 1..255; It provides the name of the artistic, cultural, or sports event.\",\n \"dtIni\": \"required; string; YYYY-MM-DD; It records the start date of the event activity.\",\n \"dtFim\": \"required; string; YYYY-MM-DD; It records the end date of the event activity.\",\n \"idAtvEvt\": \"required; string; size 1..30; It carries the event activity identifier assigned by the municipal tax authority.\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the event venue address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the event venue in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the event is held.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the event is held.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the event venue address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the event venue address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the event venue.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the event venue address.\"\n }\n },\n \"explRod\": {\n \"categVeic\": \"required; string; It identifies the vehicle category for road toll calculation purposes.\",\n \"nEixos\": \"required; string; It states the number of axles of the vehicle for toll classification.\",\n \"rodagem\": \"required; string; It identifies the wheel configuration (single or dual) of the vehicle.\",\n \"sentido\": \"required; string; It indicates the direction of travel on the road concession (e.g., northbound, southbound).\",\n \"placa\": \"required; string; It carries the vehicle license plate number for road toll identification.\",\n \"codAcessoPed\": \"optional; string; It carries the toll access code associated with this road exploitation service.\",\n \"codContrato\": \"optional; string; It carries the contract number governing the road concession exploitation.\"\n },\n \"imovel\": {\n \"inscImobFisc\": \"optional; string; size 1..30; It carries the fiscal property registration code provided by the municipality to identify the real estate or for IPTU collection.\",\n \"cCIB\": \"required; string; size 8; It carries the Brazilian Real Estate Registry code (Cadastro Imobiliário Brasileiro — CIB).\",\n \"end\": {\n \"CEP\": \"required; string; size 8; It carries the postal code (CEP) of the property address.\",\n \"endExt\": {\n \"cEndPost\": \"required; string; size 1..11; It carries the alphanumeric postal code of the property address in a foreign country.\",\n \"xCidade\": \"required; string; size 1..60; It provides the name of the city in a foreign country where the property is located.\",\n \"xEstProvReg\": \"required; string; size 1..60; It provides the state, province, or region of the foreign city where the property is located.\"\n },\n \"xLgr\": \"required; string; size 1..255; It provides the street name of the property address.\",\n \"nro\": \"required; string; size 1..60; It provides the street number of the property address.\",\n \"xCpl\": \"optional; string; size 1..156; It provides address complement information for the property.\",\n \"xBairro\": \"required; string; size 1..60; It identifies the neighborhood (bairro) of the property address.\"\n }\n },\n \"infoCompl\": {\n \"idDocTec\": \"optional; string; size 1..40; It carries the identifier of the technical responsibility document (ART, RRT, DRT, or other) associated with this service.\",\n \"docRef\": \"optional; string; size 1..255; It carries the key, number, or contract identifier of a document issued by the service provider that supports the issuance of this NFS-e by the taker or intermediary.\",\n \"xInfComp\": \"optional; string; size 1..2000; It provides free-text complementary information about the service, available to all service codes.\"\n },\n \"valores\": {\n \"vServPrest\": {\n \"vReceb\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monetary amount received by the service intermediary (R$).\",\n \"vServ\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total monetary value of the service rendered (R$).\"\n },\n \"vDescCondIncond\": {\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount (R$) granted to the service taker.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount (R$) dependent on specific conditions agreed between the parties.\"\n },\n \"vDedRed\": {\n \"pDR\": \"required; decimal; 3 integer + 2 decimal; It carries the percentage rate applied to the service value to calculate the ISSQN base reduction.\",\n \"vDR\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It carries the monetary amount used as a standard deduction or reduction of the service value for ISSQN base calculation purposes (R$).\",\n \"documentos\": {\n \"docDedRed\": [\n {\n \"chNFSe\": \"required; string; size 1..50; It carries the access key of the NFS-e (national standard) used as a deduction or reduction document in the ISSQN base calculation.\",\n \"chNFe\": \"required; string; size 44; It carries the access key of the NF-e used as a deduction or reduction document in the ISSQN base calculation.\"\n }\n ]\n }\n }\n }\n },\n \"imposto\": {\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\",\n \"ICMS\": {\n \"ICMS00\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\"\n },\n \"ICMS02\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\"\n },\n \"ICMS10\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS15\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemICMSReten\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate subject to withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"pRedAdRem\": \"optional; decimal; max 100; 3 integer + 2 decimal; It states the ad rem rate reduction percentage.\",\n \"motRedAdRem\": \"optional; string; It carries the reason code for the ad rem rate reduction.\"\n },\n \"ICMS20\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS30\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS40\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMS51\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\"\n },\n \"ICMS53\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the monophase ICMS ad rem rate per unit.\",\n \"vICMSMonoOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSMonoDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred monophase ICMS amount.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoDif\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the deferred taxable quantity in the monophase regime.\",\n \"adRemICMSDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the deferred ad rem ICMS rate.\"\n },\n \"ICMS60\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMS61\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ad rem ICMS rate previously retained.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\"\n },\n \"ICMS70\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMS90\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"cBenefRBC\": \"optional; string; It carries the benefit code associated with the ICMS base reduction.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMSOp\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount before deferral.\",\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vICMSDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred ICMS amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vBCFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base amount.\",\n \"pFCP\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP (Fundo de Combate à Pobreza) rate as a percentage.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"pFCPDif\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP deferral percentage.\",\n \"vFCPDif\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the deferred FCP amount.\",\n \"vFCPEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective FCP amount after deferral.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\",\n \"vICMSSTDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST relief amount.\",\n \"motDesICMSST\": \"optional; string; size 1..2; It carries the reason code for the ICMS-ST relief.\"\n },\n \"ICMSPart\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pBCOp\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS base allocated to the operation state.\",\n \"UFST\": \"required; string; size 2; It identifies the destination state (UF) for ICMS-ST split.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"motDesICMS\": \"optional; string; size 1..2; It carries the reason code for the ICMS relief.\",\n \"indDeduzDeson\": \"optional; string; size 1; It indicates whether the ICMS relief amount should be deducted from the item value.\"\n },\n \"ICMSST\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"vBCSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST base in the destination state.\",\n \"vICMSSTDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount in the destination state.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN101\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN102\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\"\n },\n \"ICMSSN201\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n },\n \"ICMSSN202\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\"\n },\n \"ICMSSN500\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"vBCSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base retained by the previous taxpayer.\",\n \"pST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS-ST rate applied to the retained base.\",\n \"vICMSSubstituto\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount paid by the substitute taxpayer.\",\n \"vICMSSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount retained by the previous taxpayer.\",\n \"vBCFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base retained by the previous taxpayer.\",\n \"pFCPSTRet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST retained rate as a percentage.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"pRedBCEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS base reduction percentage applied at the final stage.\",\n \"vBCEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS calculation base at the final stage.\",\n \"pICMSEfet\": \"optional; decimal; 3 integer + 2..4 decimal; It states the effective ICMS rate at the final stage.\",\n \"vICMSEfet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the effective ICMS amount at the final stage.\"\n },\n \"ICMSSN900\": {\n \"orig\": \"required; string; size 1; It identifies the product's origin using the ICMS table (0=domestic, 1..8=imported/mixed variants).\",\n \"CSOSN\": \"required; string; size 3; It identifies the Tax Situation Code for Simples Nacional (CSOSN) taxpayers.\",\n \"modBC\": \"required; string; size 1; It identifies the ICMS tax base calculation method.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pRedBC\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS tax base reduction percentage.\",\n \"pICMS\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS rate as a percentage.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"modBCST\": \"required; string; size 1; It identifies the ICMS-ST (tax substitution) tax base calculation method.\",\n \"pMVAST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the MVA (Added Value Margin) percentage for ICMS-ST base calculation.\",\n \"pRedBCST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST tax base reduction percentage.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"pICMSST\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-ST rate as a percentage.\",\n \"vICMSST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST amount.\",\n \"vBCFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST calculation base amount.\",\n \"pFCPST\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP-ST rate as a percentage.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"pCredSN\": \"required; decimal; 3 integer + 2..4 decimal; It states the Simples Nacional ICMS credit rate as a percentage.\",\n \"vCredICMSSN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Simples Nacional ICMS credit amount.\"\n }\n },\n \"ICMSUFDest\": {\n \"vBCUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS calculation base in the destination state (EC 87/2015).\",\n \"vBCFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP calculation base in the destination state.\",\n \"pFCPUFDest\": \"optional; decimal; 3 integer + 2..4 decimal; It states the FCP rate in the destination state.\",\n \"pICMSUFDest\": \"required; decimal; 3 integer + 2..4 decimal; It states the internal ICMS rate of the destination state.\",\n \"pICMSInter\": \"required; string; size 4; values: 4.00 or 12.00; It states the interstate ICMS rate applicable to the operation (4% or 12%).\",\n \"pICMSInterPart\": \"required; decimal; 3 integer + 2..4 decimal; It states the percentage of the ICMS differential allocated to the destination state.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\"\n },\n \"IPI\": {\n \"CNPJProd\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the producer's CNPJ when different from the document issuer, for IPI purposes.\",\n \"cSelo\": \"optional; string; size 1..60; It carries the IPI control stamp code.\",\n \"qSelo\": \"optional; string; size 1..6; It states the quantity of IPI control stamps applied.\",\n \"cEnq\": \"required; string; size 3; It carries the IPI classification/framework code.\",\n \"IPITrib\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pIPI\": \"optional; decimal; 3 integer + 2..4 decimal; It states the IPI rate as a percentage.\",\n \"qUnid\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity in the IPI taxable unit.\",\n \"vUnid\": \"optional; decimal; 15 digits: 11 integer + 4 decimal; It states the IPI specific rate per taxable unit.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\"\n },\n \"IPINT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n }\n },\n \"II\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vDespAdu\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the customs handling fees (despesas aduaneiras) amount.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIOF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IOF (financial operations tax) amount levied on the import.\"\n },\n \"ISSQN\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vAliq\": \"required; decimal; 3 integer + 2..4 decimal; It states the ISS/ISSQN rate as a percentage.\",\n \"vISSQN\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount due.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\",\n \"cListServ\": \"required; string; size 1..5; It identifies the service under the LC 116/2003 national service list.\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"indISS\": \"required; string; size 1; values: 1 (due), 2 (non-incidence), 3 (exempt), 4 (export), 5 (immunity), 6 (suspended by court order), 7 (suspended by administrative process); It classifies the ISS applicability status for this service.\",\n \"cServico\": \"optional; string; It carries the municipality's internal service classification code.\",\n \"cMun\": \"optional; string; size 7; It identifies the municipality where the service is provided, using the IBGE code.\",\n \"cPais\": \"optional; string; size 4; It identifies the country code for exported services.\",\n \"nProcesso\": \"optional; string; size 1..30; It carries the administrative or judicial process number related to ISS suspension.\",\n \"indIncentivo\": \"required; string; size 1; values: 1 (yes), 2 (no); It indicates whether the service benefits from a municipal ISS fiscal incentive.\"\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n },\n \"PISNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"PISOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\"\n }\n },\n \"PISST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pPIS\": \"required; decimal; 3 integer + 2..4 decimal; It states the PIS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"indSomaPISST\": \"optional; string; size 1; It indicates whether the PIS-ST amount should be added to the item total.\"\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSQtde\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n },\n \"COFINSNT\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\"\n },\n \"COFINSOutr\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\"\n }\n },\n \"COFINSST\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"pCOFINS\": \"required; decimal; 3 integer + 2..4 decimal; It states the COFINS rate as a percentage.\",\n \"qBCProd\": \"required; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity (in specific units) used as the CIDE or tax calculation base.\",\n \"vAliqProd\": \"required; decimal; 15 digits: 11 integer + 4 decimal; It states the specific tax rate per unit of product.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"indSomaCOFINSST\": \"optional; string; size 1; It indicates whether the COFINS-ST amount should be added to the item total.\"\n },\n \"IS\": {\n \"CSTIS\": \"required; string; size 3; pattern [0-9]{3}; Tax situation code for the Selective Tax (IS).\",\n \"cClassTribIS\": \"required; string; size 6; pattern [0-9]{6}; Tax classification code for IS.\",\n \"vBCIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; IS tax calculation base amount.\",\n \"pIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS rate as a percentage.\",\n \"adRemIS\": \"optional; decimal; 3 integer + 2..4 decimal; IS specific rate (ad rem, per unit).\",\n \"uTrib\": \"required; string; size 1..6; It specifies the unit of measure used for tax calculation purposes.\",\n \"qTrib\": \"required; decimal; 15 digits: 11 integer + 1..4 decimal; It states the quantity in taxable units.\",\n \"vIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Calculated IS amount.\"\n },\n \"IBSCBS\": {\n \"CST\": \"required; string; size 2..3; It identifies the Tax Situation Code (CST) that governs how ICMS, IPI, PIS, or COFINS is applied to this item.\",\n \"cClassTrib\": \"required; string; size 6; pattern [0-9]{6}; IBS/CBS tax classification code.\",\n \"indDoacao\": \"optional; string; size 1; fixed value 1; Indicates the operation is a donation.\",\n \"indDest\": \"required; string; size 1; values: 0 (the recipient is the same person as the taker identified in the NFS-e), 1 (the recipient is a different person or a different establishment from the taker); It indicates whether the service recipient is the same party as the acquiring taker.\",\n \"gIBSCBS\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"gIBSUF\": {\n \"pIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate as a percentage.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage (LC 214/25 art. 118).\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount (cashback on the invoice).\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate as a percentage.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n }\n },\n \"gCBS\": {\n \"pCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate as a percentage.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount.\",\n \"gDif\": {\n \"pDif\": \"optional; decimal; max 100; 3 integer + 2..4 decimal; It states the ICMS deferral percentage.\",\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred amount.\"\n },\n \"gDevTrib\": {\n \"pDevTrib\": \"optional; decimal; 3 integer + 2..4 decimal; Tax refund percentage.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Tax refund amount.\"\n },\n \"gRed\": {\n \"pRedAliq\": \"required; decimal; 3 integer + 2..4 decimal; Rate reduction percentage.\",\n \"pAliqEfet\": \"required; decimal; 3 integer + 2..4 decimal; Effective rate after reduction.\"\n },\n \"gALCZFMCBS\": {\n \"_comment\": \"optional — ZFM/ALC incentive area CBS zero-rate group (NF-e variant)\",\n \"tpALCZFMCBS\": \"required; string; size 1; values: 1 (with Suframa-approved process), 2 (without approved process); Type of CBS zero-rate application in incentive areas.\",\n \"nProcSuframa\": \"optional; string; size 8..12; Suframa process number for the commercialized item.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; Reference CBS effective rate outside the incentive area.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value calculated outside the incentive area.\"\n }\n },\n \"gTribRegular\": {\n \"CSTReg\": \"required; string; size 3; CST that would apply without the condition.\",\n \"cClassTribReg\": \"required; string; size 6; cClassTrib that would apply without the condition.\",\n \"pAliqEfetRegIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state effective rate without condition.\",\n \"vTribRegIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value without condition.\",\n \"pAliqEfetRegIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal effective rate without condition.\",\n \"vTribRegIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value without condition.\",\n \"pAliqEfetRegCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS effective rate without condition.\",\n \"vTribRegCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value without condition.\"\n },\n \"gTribCompraGov\": {\n \"pAliqIBSUF\": \"required; decimal; 3 integer + 2..4 decimal; IBS state rate before Art. 473 LC 214/2025 reduction.\",\n \"vTribIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS state value before Art. 473 reduction.\",\n \"pAliqIBSMun\": \"required; decimal; 3 integer + 2..4 decimal; IBS municipal rate before Art. 473 reduction.\",\n \"vTribIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS municipal value before Art. 473 reduction.\",\n \"pAliqCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS rate before Art. 473 reduction.\",\n \"vTribCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS value before Art. 473 reduction.\"\n }\n },\n \"gIBSCBSMono\": {\n \"gMonoPadrao\": {\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"adRemIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate.\",\n \"adRemCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate.\",\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase IBS amount.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Monophase CBS amount.\"\n },\n \"gMonoReten\": {\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"adRemIBSReten\": \"required; decimal; 3 integer + 2..4 decimal; IBS ad rem rate subject to withholding.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS amount subject to withholding.\",\n \"adRemCBSReten\": \"required; decimal; 3 integer + 2..4 decimal; CBS ad rem rate subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS amount subject to withholding.\"\n },\n \"gMonoRet\": {\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"adRemIBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld IBS ad rem rate.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld IBS amount.\",\n \"adRemCBSRet\": \"required; decimal; 3 integer + 2..4 decimal; Previously withheld CBS ad rem rate.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Previously withheld CBS amount.\"\n },\n \"gMonoDif\": {\n \"pDifIBS\": \"required; decimal; 3 integer + 2..4 decimal; IBS deferral percentage.\",\n \"vIBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred IBS monophase amount.\",\n \"pDifCBS\": \"required; decimal; 3 integer + 2..4 decimal; CBS deferral percentage.\",\n \"vCBSMonoDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Deferred CBS monophase amount.\"\n },\n \"vTotIBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS for the item.\",\n \"vTotCBSMonoItem\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS for the item.\"\n },\n \"gTransfCred\": {\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be transferred.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be transferred.\"\n },\n \"gAjusteCompet\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS adjustment amount.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS adjustment amount.\"\n }\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; IBS credit amount to be reversed.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; CBS credit amount to be reversed.\"\n },\n \"gCredPresOper\": {\n \"vBCCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit calculation base.\",\n \"cCredPres\": \"required; string; size 2; pattern [0-9]{2}; Presumed credit classification code.\",\n \"gIBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n },\n \"gCBSCredPres\": {\n \"pCredPres\": \"required; decimal; 3 integer + 2..4 decimal; Presumed credit percentage.\",\n \"vCredPres\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit value.\",\n \"vCredPresCondSus\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit under suspensive condition.\"\n }\n },\n \"gCredPresIBSZFM\": {\n \"competApur\": \"required; string; format YYYY-MM (min 2025-01); Reference assessment period year-month.\",\n \"tpCredPresIBSZFM\": \"optional; string; size 1; values: 0 (none), 1 (consumer goods 55%), 2 (capital goods 75%), 3 (intermediate goods 90.25%), 4 (IT/other 100%); It classifies the IBS presumed credit type for ZFM operations (LC 214/25 art. 450 §1).\",\n \"vCredPresIBSZFM\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Presumed credit amount calculated on the net debit balance.\"\n }\n },\n \"impostoDevol\": {\n \"pDevol\": \"required; decimal; max 100; 3 integer + 2 decimal; It states the percentage of IPI being returned in a product return operation.\",\n \"IPI\": {\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\"\n }\n },\n \"infAdProd\": \"optional; string; size 1..500; It provides free-text additional information about the product, which is printed on the DANFE.\",\n \"obsItem\": {\n \"obsCont\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n },\n \"obsFisco\": {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n },\n \"DFeReferenciado\": {\n \"chaveAcesso\": \"required; string; size 44; pattern [0-9]{6}[0-9A-Z]{12}[0-9]{26}\",\n \"nItem\": \"optional; string; size 1..3\"\n }\n }\n ],\n \"total\": {\n \"ICMSTot\": {\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vICMS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS amount due.\",\n \"vICMSDeson\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS relief (desoneração) amount.\",\n \"vFCPUFDest\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount due to the destination state.\",\n \"vICMSUFDest\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount due to the destination state.\",\n \"vICMSUFRemet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS differential amount remaining with the origin state.\",\n \"vFCP\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP amount.\",\n \"vBCST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-ST calculation base amount.\",\n \"vST\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total ICMS-ST amount.\",\n \"vFCPST\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST amount.\",\n \"vFCPSTRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the FCP-ST retained amount.\",\n \"qBCMono\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the quantity used as the monophase ICMS calculation base.\",\n \"vICMSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount.\",\n \"qBCMonoReten\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity subject to monophase ICMS withholding.\",\n \"vICMSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the withheld monophase ICMS amount.\",\n \"qBCMonoRet\": \"optional; decimal; 16 digits: 12 integer + 4 decimal; It states the taxable quantity previously retained in the monophase regime.\",\n \"vICMSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the monophase ICMS amount previously retained.\",\n \"vProd\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross product or service value (quantity × unit price).\",\n \"vFrete\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the freight amount charged for this item.\",\n \"vSeg\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the insurance amount charged for this item.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vII\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the Import Tax (II) amount.\",\n \"vIPI\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount.\",\n \"vIPIDevol\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the IPI amount being refunded on the returned goods.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vNF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total document value (net amount due).\",\n \"vTotTrib\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the approximate total tax burden on the item, as required by Law 12.741/2012.\"\n },\n \"ISSQNtot\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBC\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS, IPI, PIS, COFINS, or IBS/CBS calculation base amount.\",\n \"vISS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total ISSQN amount for the document.\",\n \"vPIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount.\",\n \"vCOFINS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount.\",\n \"dCompet\": \"required; string; YYYY-MM-DD; It indicates the ISS competence date (month of service provision).\",\n \"vDeducao\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states deductible amounts allowed by the municipal ISS legislation.\",\n \"vOutro\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states other accessory expenses charged to the buyer for this item.\",\n \"vDescIncond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the unconditional discount amount.\",\n \"vDescCond\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the conditional discount amount.\",\n \"vISSRet\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the ISSQN amount withheld at source.\",\n \"cRegTrib\": \"optional; string; size 1; values: 1 (Simples Nacional), 2 (estimate), 3 (professional partnership), 4 (cooperative), 5 (ME/EPP Simples Nacional), 6 (ME/EPP Simples Nacional excess); It identifies the ISS tax regime of the service provider.\"\n },\n \"retTrib\": {\n \"vRetPIS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the PIS amount withheld at source.\",\n \"vRetCOFINS\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the COFINS amount withheld at source.\",\n \"vRetCSLL\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the CSLL amount withheld at source.\",\n \"vBCIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF (income tax at source) calculation base.\",\n \"vIRRF\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the IRRF amount withheld at source.\",\n \"vBCRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security withholding (INSS) calculation base.\",\n \"vRetPrev\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the social security (INSS) amount withheld at source.\"\n },\n \"ISTot\": {\n \"vIS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total Selective Tax (IS) amount for the document.\"\n },\n \"IBSCBSTot\": {\n \"vBCIBSCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS/CBS calculation base.\",\n \"gIBS\": {\n \"gIBSUF\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred state IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS tax refunds.\",\n \"vIBSUF\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total state IBS amount.\"\n },\n \"gIBSMun\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred municipal IBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS tax refunds.\",\n \"vIBSMun\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total municipal IBS amount.\"\n },\n \"vIBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS amount (state + municipal).\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total IBS presumed credit under suspensive condition.\"\n },\n \"gCBS\": {\n \"vDif\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total deferred CBS.\",\n \"vDevTrib\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS tax refunds.\",\n \"vCBS\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS amount.\",\n \"vCredPres\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit.\",\n \"vCredPresCondSus\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total CBS presumed credit under suspensive condition.\"\n },\n \"gMono\": {\n \"vIBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS.\",\n \"vCBSMono\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS.\",\n \"vIBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase IBS subject to withholding.\",\n \"vCBSMonoReten\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total monophase CBS subject to withholding.\",\n \"vIBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase IBS.\",\n \"vCBSMonoRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total previously withheld monophase CBS.\"\n },\n \"gEstornoCred\": {\n \"vIBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed IBS credit.\",\n \"vCBSEstCred\": \"required; decimal; 15 digits: 13 integer + 2 decimal; Total reversed CBS credit.\"\n }\n },\n \"vNFTot\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the grand total document value including IBS, CBS, and IS amounts.\"\n },\n \"transp\": {\n \"modFrete\": \"required; string; size 1; values: 0 (issuer's account CIF), 1 (recipient's account FOB), 2 (third-party account), 3 (issuer's own transport), 4 (recipient's own transport), 9 (no freight); It specifies who is responsible for the freight costs.\",\n \"transporta\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"CPF\": \"required; string; size 11; pattern [0-9]{11}; It identifies an individual issuer, recipient, or carrier by their CPF when no CNPJ applies.\",\n \"xNome\": \"required; string; size 2..60; It provides the legal name of the company or the full name of the individual.\",\n \"IE\": \"required; string; size 2..14; It carries the state tax registration (Inscrição Estadual) of the issuer.\",\n \"xEnder\": \"optional; string; size 1..60; It provides the carrier's address in free text.\",\n \"xMun\": \"optional; string; size 2..60; It provides the carrier's municipality name.\",\n \"UF\": \"required; string; size 2; It identifies the Brazilian state (UF) using the two-letter abbreviation.\"\n },\n \"retTransp\": {\n \"vServ\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the total service value subject to ISSQN.\",\n \"vBCRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport calculation base.\",\n \"pICMSRet\": \"required; decimal; 3 integer + 2..4 decimal; It states the ICMS-transport withholding rate as a percentage.\",\n \"vICMSRet\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the ICMS-transport withheld amount.\",\n \"CFOP\": \"required; string; size 4; It identifies the fiscal nature of the operation using the Código Fiscal de Operações e Prestações.\",\n \"cMunFG\": \"required; string; size 7; It identifies the municipality where the taxable event (fato gerador) occurred, using the IBGE code.\"\n },\n \"veicTransp\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\"\n },\n \"reboque\": {\n \"placa\": \"required; string; It carries the vehicle license plate number.\",\n \"UF\": \"optional; string; size 2; It identifies the state (UF) of the vehicle's registration using the two-letter abbreviation.\",\n \"RNTC\": \"optional; string; size 1..20; It carries the RNTC (National Road Transport Registry) number of the vehicle.\",\n \"vagao\": \"optional; string; size 1..20; It carries the rail wagon identification for rail transport.\",\n \"balsa\": \"optional; string; size 1..20; It carries the barge identification for river transport.\"\n },\n \"vol\": [\n {\n \"qVol\": \"optional; string; size 1..15; It states the number of packages/volumes.\",\n \"esp\": \"optional; string; size 1..60; It describes the type of package/volume (e.g., caixa, fardo).\",\n \"marca\": \"optional; string; size 1..60; It carries the brand or mark of the packages.\",\n \"nVol\": \"optional; string; size 1..60; It carries the volume numbering or identification.\",\n \"pesoL\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the net weight of the volumes in kg.\",\n \"pesoB\": \"optional; decimal; 15 digits: 12 integer + 3 decimal; It states the gross weight of the volumes in kg.\",\n \"lacres\": [\n {\n \"nLacre\": \"required; string; size 1..60; It carries the seal (lacre) number applied to the cargo.\"\n }\n ]\n }\n ]\n },\n \"cobr\": {\n \"fat\": {\n \"nFat\": \"optional; string; size 1..60; It carries the invoice (fatura) number for billing control.\",\n \"vOrig\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the original invoice amount before any discounts.\",\n \"vDesc\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the discount amount granted on this item.\",\n \"vLiq\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the net invoice amount after discounts.\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional; string; size 1..60; It identifies the installment (duplicata) number within the invoice.\",\n \"dVenc\": \"optional; string; YYYY-MM-DD; It records the due date for this installment.\",\n \"vDup\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the face value of this installment.\"\n }\n ]\n },\n \"pag\": {\n \"detPag\": [\n {\n \"indPag\": \"optional; string; size 1; values: 0 (cash/à vista), 1 (installment/à prazo); It indicates the payment timing condition.\",\n \"tPag\": \"required; string; size 2; values: 01 (cash), 02 (cheque), 03 (credit card), 04 (debit card), 05 (store credit), 10 (meal voucher), 11 (food voucher), 12 (gift card), 13 (fuel voucher), 14 (trade bill/duplicata), 15 (bank slip/boleto), 16 (bank deposit), 17 (PIX), 18 (wire transfer), 19 (cashback), 90 (no payment), 99 (other); It identifies the payment method used.\",\n \"xPag\": \"optional; string; size 2..60; It provides a description when tPag=99 (other payment method).\",\n \"vPag\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the amount paid using this payment method.\",\n \"dPag\": \"optional; string; YYYY-MM-DD; It records the date on which this payment was or will be made.\",\n \"CNPJPag\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the bank or payment institution processing this payment.\",\n \"UFPag\": \"optional; string; size 2; It identifies the state (UF) of the payment institution.\",\n \"card\": {\n \"tpIntegra\": \"required; string; size 1; values: 1 (integrated TEF), 2 (non-integrated); It indicates whether the card payment was processed through an integrated electronic payment terminal.\",\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"tBand\": \"optional; string; size 2; values: 01 (Visa), 02 (Mastercard), 03 (Amex), 04 (Sorocred), 05 (Diners), 06 (Elo), 07 (Hipercard), 08 (Aura), 09 (Cabal), 99 (other); It identifies the card network/brand.\",\n \"cAut\": \"optional; string; size 1..20; It carries the card transaction authorization code.\",\n \"CNPJReceb\": \"optional; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the payment recipient's CNPJ, which may differ from the document issuer.\",\n \"idTermPag\": \"optional; string; size 1..40; It carries the payment terminal identifier.\"\n }\n }\n ],\n \"vTroco\": \"optional; decimal; 15 digits: 13 integer + 2 decimal; It states the change amount returned to the customer (NFC-e).\"\n },\n \"infIntermed\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"idCadIntTran\": \"required; string; size 2..60; It carries the intermediary's registration ID on the digital platform.\"\n },\n \"infAdic\": {\n \"infAdFisco\": \"optional; string; size 1..2000; It contains additional fiscal information required by the tax authority, printed on the DANFE.\",\n \"infCpl\": \"optional; string; size 1..5000; It contains complementary information added by the issuer, printed on the DANFE.\",\n \"obsCont\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"obsFisco\": [\n {\n \"xCampo\": \"required; string; size 1..20; It identifies the custom field name used in taxpayer or Fisco observations.\",\n \"xTexto\": \"required; string; size 1..60; It carries the content of the custom observation field.\"\n }\n ],\n \"procRef\": [\n {\n \"nProc\": \"required; string; size 1..60; It carries the administrative or judicial process number referenced.\",\n \"indProc\": \"required; string; size 1; values: 0 (SEFAZ), 1 (Federal Court), 2 (State Court), 3 (SECEX/RFB), 9 (other); It identifies the type of process or authority issuing the referenced act.\",\n \"tpAto\": \"optional; string; size 2; values: 08 (summons), 10 (decision), 12 (sentence), 15 (court ruling/acórdão); It classifies the type of legal act referenced.\"\n }\n ]\n },\n \"exporta\": {\n \"UFSaidaPais\": \"required; string; size 2; It identifies the Brazilian state through which the exported goods will exit the country.\",\n \"xLocExporta\": \"required; string; size 1..60; It describes the export customs clearance location in free text.\",\n \"xLocDespacho\": \"optional; string; size 1..60; It describes the goods dispatch location for export purposes.\"\n },\n \"compra\": {\n \"xNEmp\": \"optional; string; size 1..17; It carries the purchase order or budget note number from the buyer.\",\n \"xPed\": \"optional; string; size 1..15; It carries the buyer's purchase order number for traceability.\",\n \"xCont\": \"optional; string; size 1..60; It carries the contract number associated with this purchase.\"\n },\n \"cana\": {\n \"safra\": \"required; string; size 4..9; It identifies the sugarcane harvest (safra) reference period.\",\n \"ref\": \"required; string; size 7; format AAMM; It indicates the year-month reference for the sugarcane supply.\",\n \"forDia\": [\n {\n \"dia\": \"required; string; size 1..2; It identifies the calendar day within the supply month.\",\n \"qtde\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the sugarcane quantity supplied on this day.\"\n }\n ],\n \"qTotMes\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied in the current month.\",\n \"qTotAnt\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the cumulative sugarcane quantity supplied in prior months of this harvest.\",\n \"qTotGer\": \"required; decimal; 21 digits: 11 integer + 1..10 decimal; It states the total sugarcane quantity supplied across the entire harvest period.\",\n \"deduc\": [\n {\n \"xDed\": \"required; string; size 1..60; It describes the deduction type applied to the sugarcane supply value.\",\n \"vDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the deduction amount.\"\n }\n ],\n \"vFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the gross supply value before deductions.\",\n \"vTotDed\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the total deductions applied.\",\n \"vLiqFor\": \"required; decimal; 15 digits: 13 integer + 2 decimal; It states the net supply value after all deductions.\"\n },\n \"infRespTec\": {\n \"CNPJ\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the issuer, recipient, carrier, or other party by their alphanumeric CNPJ.\",\n \"xContato\": \"required; string; size 2..60; It provides the name of the technical contact person at the responsible company.\",\n \"email\": \"optional; string; size 1..60; It provides the email address for document delivery.\",\n \"fone\": \"optional; string; size 6..14; It provides a contact phone number.\",\n \"idCSRT\": \"optional; string; size 2; It carries the two-digit identifier of the CSRT security token.\",\n \"hashCSRT\": \"optional; string; size 28; It carries the SHA-1 hash of the CSRT token concatenated with the NF-e access key, encoded in base64.\"\n },\n \"infSolicNFF\": {\n \"xSolic\": \"required; string; size 2..1000; It carries the NFF request information in free text.\"\n },\n \"agropecuario\": {\n \"defensivo\": [\n {\n \"nReceituario\": \"required; string; size 1..20; It carries the prescription number issued by the agronomist for the pesticide.\",\n \"CPFRespTec\": \"required; string; size 11; pattern [0-9]{11}; It identifies the agronomist or technician who prescribed the pesticide by their CPF.\"\n }\n ],\n \"guiaTransito\": {\n \"tpGuia\": \"required; string; size 2; values: 01 (animal transit), 02 (plant transit); It classifies the transit permit type for agricultural products.\",\n \"UFGuia\": \"required; string; size 2; It identifies the state that issued the transit permit.\",\n \"serieGuia\": \"optional; string; size 1..9; It carries the series number of the transit permit.\",\n \"nGuia\": \"required; string; size 1..20; It carries the transit permit number.\"\n }\n },\n \"infPAA\": {\n \"CNPJPAA\": \"required; string; size 14; pattern [0-9A-Z]{12}[0-9]{2}; It identifies the Signature and Authorization Provider (PAA) by their CNPJ.\",\n \"PAASignature\": {\n \"SignatureValue\": \"required; string; base64-encoded binary; It carries the PAA's digital signature value.\",\n \"RSAKeyValue\": \"required; object; It contains the RSA public key (Modulus and Exponent) used to verify the PAA signature.\"\n }\n }\n },\n \"infNFeSupl\": {\n \"qrCode\": \"required; string; size 1..1000; It carries the QR Code URL string for NFC-e consumer verification.\",\n \"urlChave\": \"required; string; size 1..85; It carries the URL for NFC-e access key consultation.\"\n },\n \"Signature\": \"required; object; It contains the XML-DSig digital signature of the NF-e, ensuring document integrity and authenticity.\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/event/{tpEvento}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"ff0971fd-9a18-4523-9968-825ddf3cd0d6"},{"name":"cancellation","id":"301ecfe4-8c2f-404c-98d6-b71ee67a1c42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/event/{tpEvento}","description":"

To \"cancel\" an invoice you must send an event code equal to “110111” (for normal cancellation) or “110112” (for replacement cancellation). Cancellation by substitution is only allowed if the document model is equal to 65 - NFC-e and the emission type (tpEmis) is equal to 1 - Normal.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is provided, but if provided, it must be a string, and can't exceed 256 characters.
subsidiaryId	This is the invoice issuing subsidiary, the only one with powers to cancel it. It is mandatory to identify the issuing subsidiary by informing only its UUID (\"subsidiaryId\") or simultaneously the attributes \"accountId\", \"CNPJ\" and \"IE\" (another way of identifying the subsidiary), as they are exclusive. Must be a string containing a valid UUID.
accountId	This is the invoice issuing subsidiary, the only one with powers to cancel it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. Must be a string containing a valid UUID.
CNPJ	This is the invoice issuing subsidiary, the only one with powers to cancel it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"CNPJ\" attribute must be a string containing 14 digits.
IE	This is the invoice issuing subsidiary, the only one with powers to cancel it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"IE\" attribute must be a string containing between 1 and 14 digits.
chNFe	This is the unique access key for the invoice that will be cancelled. It is mandatory to identify a previously authorized access key, not yet canceled and that is related to the informed subsidiary. It must be a string with length 44 digits.
xJust	This is justification for canceling the invoice. It is mandatory and must be a string between 15 and 256 characters long.
chNFeRef	This is the unique access key for the invoice deemed to be a replacement for the invoice that will be canceled by replacement. It is optional, but if informed, it must be a previously authorized access key in model \"65\", in offline contingency mode (tpEmis = 9), not yet cancelled, which is related to the informed subsidiary and which has the attributes \" cProd\", \"cEAN\", \"xProd\", \"NCM\", \"CFOP\", \"uCom\", \"qCom\", \"vUnCom\", \"vProd\", \"indTot\" with the same information declared in the replaced invoice. It must be a string with a length of 44 digits.
CodigoCancelamentoNfse	This is the invoice cancellation code, exclusively authorized in model \"99\" (NFS-e). It is mandatory, it must be a string and the content must be obtained from GET/tax-infos/name?page=1&limit=100&name=CodigoCancelamentoNfse.

For \"correction\" of an invoice you must send event code equal to \"110110\". It is only allowed to correct a document model equal to 55 - NF-e.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is provided, but if provided, it must be a string, and can't exceed 256 characters.
subsidiaryId	This is the subsidiary issuing the invoice, the only one with powers to correct it. It is mandatory to identify the issuing subsidiary by informing only its UUID (\"subsidiaryId\") or simultaneously the attributes \"accountId\", \"CNPJ\" and \"IE\" (another form of identification of the subsidiary), as they are exclusive. Must be a string containing a valid UUID.
accountId	This is the subsidiary issuing the invoice, the only one with the power to correct it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. Must be a string containing a valid UUID.
CNPJ	This is the invoice issuing subsidiary, the only one with powers to correct it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"CNPJ\" attribute must be a string containing 14 digits.
IE	This is the invoice issuing subsidiary, the only one with powers to correct it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"IE\" attribute must be a string containing between 1 and 14 digits.
chNFe	This is the unique access key for the invoice to be corrected. It is mandatory to identify a previously authorized access key, not yet canceled and that is related to the informed subsidiary. It must be a string with a length of 44 digits.
xCorrecao	This is the rationale for correcting the invoice. It is required and must be a string between 15 and 256 characters long.

To \"disable\" an invoice number, you must send an event code equal to \"999999\" (Disablement). Disablement events are only allowed if the invoice number is no longer usable.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is provided, but if provided, it must be a string, and can't exceed 256 characters.
subsidiaryId	This is the subsidiary issuing the invoice, the only one with the power to disable your number. It is mandatory to identify the issuing subsidiary by informing only its UUID (\"subsidiaryId\") or simultaneously the attributes \"accountId\", \"CNPJ\" and \"IE\" (another form of identification of the subsidiary), as they are exclusive. Must be a string containing a valid UUID.
accountId	This is the subsidiary issuing the invoice, the only one with powers to disable it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. Must be a string containing a valid UUID.
CNPJ	This is the subsidiary issuing the invoice, the only one with powers to disable it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"CNPJ\" attribute must be a string containing 14 digits.
IE	This is the subsidiary issuing the invoice, the only one with powers to disable it. It is mandatory to identify the issuing subsidiary by simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"IE\" attribute must be a string containing between 1 and 14 digits.
mod	This is the tax document template code associated with the number you want to disable, considering the tax document templates available on the platform. It is mandatory, it must be a string with length 2 and the informed content must be \"55\" (NF-e), \"65\" (NFC-e), \"57\" (CT-e), \"67\" (CT -e OS) and \"99\" (NFS-e).
nNF	This is the number you want to disable. It is mandatory and must be a number generated by the ContabilOne platform that has a rejected or error status that has not yet been used.
serie	This is the series associated with the number you want to disable. It is mandatory and must be a number.
xJust	This is the justification for the invalidation of the number. It is mandatory and must be a string between 15 and 256 characters long.

For “manifestation” of an invoice as its recipient, you must send an event code equal to “210210” (aware), “210200” (realized), “210220” (unknown) or “210240” (unrealized).

The statement is the recipient's prerogative and serves as proof of whether or not the transaction was carried out before the Brazilian public administration. Manifestation events will only be allowed if the document model is equal to 55 - NF-e and each manifestation event will only be allowed once, the last being the definitive one.

Event code “210210” (aware) indicates to the public administration that the recipient of the tax document recognizes the possibility of a tax transaction between him and the issuer even before deeply assessing the transaction itself and providing a definitive statement. This event must occur within 10 days of the transaction date.

The event code “210200” (realized) indicates to the public administration that the recipient of the tax document confirms that said tax transaction was carried out between him and the issuer. This event must occur within 180 days of the transaction date.

Event code “210220” (unknown) indicates to the public administration that the recipient of the tax document confirms that he or she is unaware of the existence of said tax transaction. This event must occur within 180 days of the transaction date.

Event code “210240” (unrealized) indicates to the public administration that the recipient of the tax document declares that said tax transaction was initiated, but not carried out between him and the issuer. This event must occur within 180 days of the transaction date.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is provided, but if provided, it must be a string, and can't exceed 256 characters.
subsidiaryId	This is the subsidiary that is the addressee of the invoice, the only one empowered to manifest it. It is mandatory to identify the receiving subsidiary by informing only its UUID (\"subsidiaryId\") or simultaneously the attributes \"accountId\", \"CNPJ\" and \"IE\" (another form of identification of the subsidiary), as they are exclusive. Must be a string containing a valid UUID.
accountId	This is the subsidiary receiving the invoice, the only one qualified to manifest it. It is mandatory to identify the recipient, simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. Must be a string containing a valid UUID.
CNPJ	This is the subsidiary receiving the invoice, the only one qualified to manifest it. It is mandatory to identify the recipient, simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"CNPJ\" attribute must be a string containing 14 digits.
IE	This is the subsidiary receiving the invoice, the only one qualified to manifest it. It is mandatory to identify the recipient, simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"IE\" attribute must be a string containing between 1 and 14 digits.
chNFe	This is the unique access key for the invoice manifestation. It is mandatory to identify a previously authorized access key, which has not yet been canceled and which the informed subsidiary is in the capacity of recipient. It must be a string with a length of 44 digits.
xJust	This is the justification for the statement made by the recipient of the invoice. It is mandatory when the manifestation is code 210220 - Unknown operation or 210240 - Operation not executed. It must be a string between 15 and 256 characters.

The protocol query event allows you to verify (i) whether the invoice access key has been authorized and (ii) whether the XML existing on the platform has an intact digital signature. It is this combination of factors that determines that the XML has \"legal validity\". To \"check the status\" of an invoice, you must send an event code equal to \"999996\".

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is provided, but if provided, it must be a string, and can't exceed 256 characters.
subsidiaryId	This is the subsidiary that is the addressee of the invoice, the only one empowered to manifest it. It is mandatory to identify the receiving subsidiary by informing only its UUID (\"subsidiaryId\") or simultaneously the attributes \"accountId\", \"CNPJ\" and \"IE\" (another form of identification of the subsidiary), as they are exclusive. Must be a string containing a valid UUID.
accountId	This is the subsidiary receiving the invoice, the only one qualified to manifest it. It is mandatory to identify the recipient, simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. Must be a string containing a valid UUID.
CNPJ	This is the subsidiary receiving the invoice, the only one qualified to manifest it. It is mandatory to identify the recipient, simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"CNPJ\" attribute must be a string containing 14 digits.
IE	This is the subsidiary receiving the invoice, the only one qualified to manifest it. It is mandatory to identify the recipient, simultaneously informing the attributes \"accountId\", \"CNPJ\" and \"IE\" or just its UUID (\"subsidiaryId\"), as they are unique. The \"IE\" attribute must be a string containing between 1 and 14 digits.
chNFe	This is the unique access key for the invoice, used to view the invoice protocol. It must be a 44-digit sequence.

Through this endpoint, it is possible to list all invoice events for a specific domain, account, company or even a specific subsidiary. It is also possible to further refine your search using filters for specific attributes (name) using properties such as \"interval\" or \"term\" (type) with predetermined values (value).

Properties of type “range” are those that allow you to find something within a range, for example, find an invoice between January and February 2022 or between the amount 50.00 and 1000.00.

List of properties of type “range” available for filtering:

\"det.prod.vProd\"
\n
\"det.prod.vUnCom\"
\n
\"vNF\"
\n
\"ide.dhEmi\"
\n
\"dhRecbto\"
\n
\"authorization.createdAt\"
\n
\"contingencyAuthorization.createdAt\"
\n
\"cancellation.createdAt\"
\n
\"corrections.createdAt\"
\n
\"disablement.createdAt\",
\n
\"distribution.createdAt\"
\n
\"manifestationAware.createdAt\"
\n
\"manifestationRealized.createdAt\"
\n
\"manifestationUnknown.createdAt\"
\n
\"manifestationUnrealized.createdAt\"
\n

Comments:

A) For value type properties (\"det.prod.vProd\", \"det.prod.vUnCom\" and \"vNF\") the format must be 13v2, that is, up to 13 integers and two decimals separated by a point (eg 1000.00).

B) For data type properties (eg \"ide.dhEmi\", \"dhRecbto\", \"authorization.createdAt\" etc) the format must be \"YYYY-MM-DDThh:mm:ss\".

Examples of how to represent “range” type properties in your request:

{\n    \"limit\": 10,\n    \"page\": 1,\n    \"filters\": [\n        {\n            \"name\": \"ide.dhEmi\",\n            \"start\": \"2026-01-12T00:00:00.000Z\",\n            \"end\": \"2026-01-12T23:59:59.000Z\",\n        },\n        {\n            \"name\": \"vNF\",\n            \"start\": \"10.00\",\n            \"end\": \"20.00\"\n        }\n    ]\n}\n\n

The \"term\" type properties are those that allow finding a defined value, for example, finding a document that had an issuer with CNPJ 00000000000001 or NCM 84715010.

List of properties of type “term” available for filtering:

\"remoteId\"
\n
\"requestId\"
\n
\"chNFe\"
\n
\"terminalCashierNumber\"
\n
\"recovery\"
\n
\"emit.CNPJ\"
\n
\"emit.IE\"
\n
\"emit.CRT\"
\n
\"emit.xNome\"
\n
\"emit.xFant\"
\n
\"emit.cMun\"
\n
\"emit.UF\"
\n
\"emit.xPais\"
\n
\"dest.CNPJ\"
\n
\"dest.CPF\"
\n
\"dest.idEstrangeiro\"
\n
\"dest.IE\"
\n
\"dest.xNome\"
\n
\"dest.xFant\"
\n
\"dest.cMun\"
\n
\"dest.UF\"
\n
\"dest.xPais\"
\n
\"ide.mod\"
\n
\"ide.serie\"
\n
\"ide.tpNF\"
\n
\"ide.nNF\"
\n
\"ide.nNFStatus\"
\n
\"ide.tpEmis\"
\n
\"ide.verProc\"
\n
\"sefaz.cStat\"
\n
\"sefaz.xMotivo\"
\n
\"sefaz.nProt\"
\n
\"det.prod.NCM\"
\n
\"det.prod.CEST\"
\n
\"det.prod.cProd\"
\n
\"det.prod.xProd\"
\n
\"det.prod.cEAN\"
\n
\"det.prod.CFOP\"
\n
\"det.prod.cBenef\"
\n
\"det.imposto.ICMSCST\"
\n
\"det.imposto.ICMSCSOSN\"
\n
\"det.imposto.IPICST\"
\n
\"det.imposto.PISCST\"
\n
\"det.imposto.COFINSCST\"
\n
\"det.infAdProd\"
\n
\"authorization.status\"
\n
\"contingencyAuthorization.status\"
\n
\"cancellation.status\"
\n
\"correction.status\"
\n
\"disablement.status\"
\n
\"distribution.status\"
\n
\"manifestationRealized.status\"
\n
\"manifestationUnknown.status\"
\n
\"manifestationUnrealized.status\"
\n
\"manifestationAware.status\"
\n

Comments:

A) For status type properties (eg \"status.authorization\") enter: AUTHORIZED, REJECTED, DENEGATED, PROCESSING, ERROR.

Examples of how to represent “term” type properties in your request:

{\n    \"limit\": 10,\n    \"page\": 1,\n    \"filters\": [\n        {\n            \"name\": \"authorization.status\",\n            \"values\": [\n                \"AUTHORIZED\"\n            ]\n        },\n        {\n            \"name\": \"cancellation.status\",\n            \"values\": [\n                \"REJECTED\"\n            ]\n        },\n        {\n            \"name\": \"ide.mod\",\n            \"values\": [\n                \"65\"\n            ]\n        }\n    ]\n}\n\n

\n","urlObject":{"protocol":"{{PROTOCOL}}","path":["invoices"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"00e02d53-c3ba-4c8a-bb28-c3a3fd116124","name":"200 Accepted","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 10,\n \"page\": 1,\n \"whitelabelId\": \"optional, uuid-v7\",\n \"accountId\": \"optional, uuid-v7\",\n \"companyId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"q\": \"optional, requestId|remoteId|chNFe|nProt\",\n \"filters\": [\n {\n \"name\": \"emit.CNPJ\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"ide.dhEmi\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"ide.mod\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"authorization.status\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"cancellation.createdAt\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"det.prod.CFOP\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"vNF\",\n \"start\": \"required, string\",\n \"end\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api-homologation.omnitax.ai/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"message\": {\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1758396018,\n \"formatted\": \"20/09/2025 - 16:20:18\"\n },\n \"updatedAt\": {\n \"epoch\": 1758396144,\n \"formatted\": \"20/09/2025 - 16:22:24\"\n },\n \"finished\": true,\n \"events\": [\n {\n \"type\": \"AUTHORIZATION\",\n \"label\": \"Autorização normal\",\n \"requestId\": \"{requestId}\",\n \"remoteId\": null,\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396018,\n \"formatted\": \"20/09/2025 - 16:20:18\"\n }\n },\n {\n \"type\": \"CALCULATION_REQUEST\",\n \"label\": \"Requisição do cálculo\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/calculation-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396021,\n \"formatted\": \"20/09/2025 - 16:20:21\"\n }\n },\n {\n \"type\": \"CALCULATION_RESPONSE\",\n \"label\": \"Resposta do cálculo\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/calculation-response?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396021,\n \"formatted\": \"20/09/2025 - 16:20:21\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396026,\n \"formatted\": \"20/09/2025 - 16:20:26\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396027,\n \"formatted\": \"20/09/2025 - 16:20:27\"\n },\n \"data\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"cStat\": \"104\",\n \"xMotivo\": \"Lote processado\",\n \"cUF\": \"35\",\n \"dhRecbto\": \"2025-09-20T16:20:27-03:00\",\n \"infRec\": null,\n \"protNFe\": {\n \"infProt\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"dhRecbto\": \"2025-09-20T16:20:27-03:00\",\n \"nProt\": \"135250007509229\",\n \"digVal\": \"d4eu03yAYojTn19zwMtk0k0Y1h8=\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"_versao\": \"4.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396027,\n \"formatted\": \"20/09/2025 - 16:20:27\"\n },\n \"raw\": \"{XML or JSON}\"\n },\n {\n \"type\": \"DANFE\",\n \"label\": \"Danfe\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/danfe?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396027,\n \"formatted\": \"20/09/2025 - 16:20:27\"\n },\n \"raw\": \"{XML or JSON}\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1758396018,\n \"formatted\": \"20/09/2025 - 16:20:18\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"CORRECTION\",\n \"label\": \"Carta de correção\",\n \"requestId\": \"\",\n \"remoteId\": \"teste-correcao\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396091,\n \"formatted\": \"20/09/2025 - 16:21:31\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396100,\n \"formatted\": \"20/09/2025 - 16:21:40\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396100,\n \"formatted\": \"20/09/2025 - 16:21:40\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de Evento Processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-09-20T16:21:40-03:00\",\n \"nProt\": \"135250007509289\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396101,\n \"formatted\": \"20/09/2025 - 16:21:41\"\n },\n \"raw\": \"{XML or JSON}\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1758396091,\n \"formatted\": \"20/09/2025 - 16:21:31\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Ciência da Operação\",\n \"requestId\": \"\",\n \"remoteId\": \"teste-ciencia-da-operacao\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396103,\n \"formatted\": \"20/09/2025 - 16:21:43\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396105,\n \"formatted\": \"20/09/2025 - 16:21:45\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396105,\n \"formatted\": \"20/09/2025 - 16:21:45\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"tpEvento\": \"210210\",\n \"xEvento\": \"Ciencia da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-09-20T16:21:45-03:00\",\n \"nProt\": \"891250009487698\",\n \"_Id\": \"ID891250009487698\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396105,\n \"formatted\": \"20/09/2025 - 16:21:45\"\n },\n \"raw\": \"{XML or JSON}\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1758396102,\n \"formatted\": \"20/09/2025 - 16:21:42\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Operação desconhecida\",\n \"requestId\": \"\",\n \"remoteId\": \"teste-operacao-desconhecida\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396108,\n \"formatted\": \"20/09/2025 - 16:21:48\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396112,\n \"formatted\": \"20/09/2025 - 16:21:52\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396113,\n \"formatted\": \"20/09/2025 - 16:21:53\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"tpEvento\": \"210220\",\n \"xEvento\": \"Desconhecimento da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-09-20T16:21:52-03:00\",\n \"nProt\": \"891250009487700\",\n \"_Id\": \"ID891250009487700\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396113,\n \"formatted\": \"20/09/2025 - 16:21:53\"\n },\n \"raw\": \"{XML or JSON}\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1758396108,\n \"formatted\": \"20/09/2025 - 16:21:48\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Operação não Realizada\",\n \"requestId\": \"\",\n \"remoteId\": \"teste-operacao-nao-realizada\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396124,\n \"formatted\": \"20/09/2025 - 16:22:04\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396127,\n \"formatted\": \"20/09/2025 - 16:22:07\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396128,\n \"formatted\": \"20/09/2025 - 16:22:08\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"tpEvento\": \"210240\",\n \"xEvento\": \"Operacao nao Realizada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-09-20T16:22:08-03:00\",\n \"nProt\": \"891250009487701\",\n \"_Id\": \"ID891250009487701\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396128,\n \"formatted\": \"20/09/2025 - 16:22:08\"\n },\n \"raw\": \"{XML or JSON}\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1758396124,\n \"formatted\": \"20/09/2025 - 16:22:04\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Operação Realizada\",\n \"requestId\": \"\",\n \"remoteId\": \"teste-operacao-realizada\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396129,\n \"formatted\": \"20/09/2025 - 16:22:09\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396136,\n \"formatted\": \"20/09/2025 - 16:22:16\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396137,\n \"formatted\": \"20/09/2025 - 16:22:17\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"tpEvento\": \"210200\",\n \"xEvento\": \"Confirmacao da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-09-20T16:22:17-03:00\",\n \"nProt\": \"891250009487702\",\n \"_Id\": \"ID891250009487702\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396137,\n \"formatted\": \"20/09/2025 - 16:22:17\"\n },\n \"raw\": \"{XML or JSON}\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1758396129,\n \"formatted\": \"20/09/2025 - 16:22:09\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"CANCELLATION\",\n \"label\": \"Cancelamento\",\n \"requestId\": \"\",\n \"remoteId\": \"teste-cancelamento\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396138,\n \"formatted\": \"20/09/2025 - 16:22:18\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396143,\n \"formatted\": \"20/09/2025 - 16:22:23\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396144,\n \"formatted\": \"20/09/2025 - 16:22:24\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de Evento Processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35250957228150000174556870003456181334469023\",\n \"tpEvento\": \"110111\",\n \"xEvento\": \"Cancelamento registrado\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-09-20T16:22:24-03:00\",\n \"nProt\": \"135250007509297\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/{requestId}/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1758396144,\n \"formatted\": \"20/09/2025 - 16:22:24\"\n },\n \"raw\": \"{XML or JSON}\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1758396138,\n \"formatted\": \"20/09/2025 - 16:22:18\"\n },\n \"lastStatus\": true\n }\n ],\n \"emitSubsidiary\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746624007,\n \"formatted\": \"07/05/2025 - 10:20:07\"\n },\n \"updatedAt\": {\n \"epoch\": 1758395850,\n \"formatted\": \"20/09/2025 - 16:17:30\"\n },\n \"identification\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": null,\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\",\n \"openingDate\": {\n \"epoch\": 1743547752,\n \"formatted\": \"01/04/2025 - 19:49:12\"\n },\n \"closingDate\": null,\n \"headquarters\": true\n },\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"cUF\": \"\",\n \"xUF\": \"\",\n \"UF\": \"\",\n \"Pais\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746623895,\n \"formatted\": \"07/05/2025 - 10:18:15\"\n },\n \"updatedAt\": {\n \"epoch\": 1758395850,\n \"formatted\": \"20/09/2025 - 16:17:30\"\n },\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 0,\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746480845,\n \"formatted\": \"05/05/2025 - 18:34:05\"\n },\n \"updatedAt\": {\n \"epoch\": 1758061762,\n \"formatted\": \"16/09/2025 - 19:29:22\"\n },\n \"name\": \"\",\n \"companiesTotal\": 2,\n \"usersTotal\": 1,\n \"images\": {\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746479811,\n \"formatted\": \"05/05/2025 - 18:16:51\"\n },\n \"updatedAt\": {\n \"epoch\": 1758135988,\n \"formatted\": \"17/09/2025 - 16:06:28\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 10,\n \"usersTotal\": 1\n }\n }\n },\n \"stateTaxes\": [\n {\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"stateDocument\": \"\",\n \"UF\": \"\",\n \"suframa\": null,\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"cscId\": null,\n \"cscToken\": null,\n \"startDate\": {\n \"epoch\": 1743547918,\n \"formatted\": \"01/04/2025 - 19:51:58\"\n },\n \"endDate\": null\n }\n ]\n },\n \"destSubsidiary\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746624007,\n \"formatted\": \"07/05/2025 - 10:20:07\"\n },\n \"updatedAt\": {\n \"epoch\": 1758395850,\n \"formatted\": \"20/09/2025 - 16:17:30\"\n },\n \"identification\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"xFant\": \"\",\n \"nire\": null,\n \"email\": \"\",\n \"fone\": \"\",\n \"website\": \"\",\n \"openingDate\": {\n \"epoch\": 1743547752,\n \"formatted\": \"01/04/2025 - 19:49:12\"\n },\n \"closingDate\": null,\n \"headquarters\": true\n },\n \"address\": {\n \"cep\": \"\",\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"cUF\": \"\",\n \"xUF\": \"\",\n \"UF\": \"\",\n \"Pais\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\"\n },\n \"company\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": \"\",\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746623895,\n \"formatted\": \"07/05/2025 - 10:18:15\"\n },\n \"updatedAt\": {\n \"epoch\": 1758395850,\n \"formatted\": \"20/09/2025 - 16:17:30\"\n },\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 0,\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746480845,\n \"formatted\": \"05/05/2025 - 18:34:05\"\n },\n \"updatedAt\": {\n \"epoch\": 1758061762,\n \"formatted\": \"16/09/2025 - 19:29:22\"\n },\n \"name\": \"\",\n \"companiesTotal\": 2,\n \"usersTotal\": 1,\n \"images\": {\n \"logoUrl\": \"\",\n \"iconUrl\": \"\"\n },\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1746479811,\n \"formatted\": \"05/05/2025 - 18:16:51\"\n },\n \"updatedAt\": {\n \"epoch\": 1758135988,\n \"formatted\": \"17/09/2025 - 16:06:28\"\n },\n \"name\": \"\",\n \"domain\": \"\",\n \"accountsTotal\": 10,\n \"usersTotal\": 1\n }\n }\n },\n \"stateTaxes\": [\n {\n \"taxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"typeTaxPayer\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"stateDocument\": \"\",\n \"UF\": \"\",\n \"suframa\": null,\n \"crtEspecial\": [\n {\n \"code\": \"\",\n \"description\": \"\"\n }\n ],\n \"cscId\": null,\n \"cscToken\": null,\n \"startDate\": {\n \"epoch\": 1743547918,\n \"formatted\": \"01/04/2025 - 19:51:58\"\n },\n \"endDate\": null\n }\n ]\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"1ee51110-7953-4ba2-958b-f8d87fed7ab8","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 10,\n \"page\": 1,\n \"whitelabelId\": \"optional, uuid-v7\",\n \"accountId\": \"optional, uuid-v7\",\n \"companyId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"q\": \"optional, requestId|remoteId|chNFe|nProt\",\n \"filters\": [\n {\n \"name\": \"emit.CNPJ\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"ide.dhEmi\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"ide.mod\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"authorization.status\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"cancellation.createdAt\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"det.prod.CFOP\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"vNF\",\n \"start\": \"required, string\",\n \"end\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"filters[0].values\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"db1da4b5-f014-4133-87e1-1766178e512e","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 10,\n \"page\": 1,\n \"whitelabelId\": \"optional, uuid-v7\",\n \"accountId\": \"optional, uuid-v7\",\n \"companyId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"q\": \"optional, requestId|remoteId|chNFe|nProt\",\n \"filters\": [\n {\n \"name\": \"emit.CNPJ\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"ide.dhEmi\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"ide.mod\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"authorization.status\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"cancellation.createdAt\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"det.prod.CFOP\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"vNF\",\n \"start\": \"required, string\",\n \"end\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"cce15ac5-b571-4cd3-a621-0ad17472153c","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 10,\n \"page\": 1,\n \"whitelabelId\": \"optional, uuid-v7\",\n \"accountId\": \"optional, uuid-v7\",\n \"companyId\": \"optional, uuid-v7\",\n \"subsidiaryId\": \"optional, uuid-v7\",\n \"q\": \"optional, requestId|remoteId|chNFe|nProt\",\n \"filters\": [\n {\n \"name\": \"emit.CNPJ\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"ide.dhEmi\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"ide.mod\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"authorization.status\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"cancellation.createdAt\",\n \"start\": \"required, YYYY-MM-DDThh:mm:ss\",\n \"end\": \"required, YYYY-MM-DDThh:mm:ss\"\n },\n {\n \"name\": \"det.prod.CFOP\",\n \"values\": [\n \"required, string\"\n ]\n },\n {\n \"name\": \"vNF\",\n \"start\": \"required, string\",\n \"end\": \"required, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"534dbc51-0de2-484b-9c4c-4bda53d5e4f7"},{"name":"invoices (detail)","id":"46083d6e-f85c-40a8-a2de-49cd0c25a8eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/{requestId, remoteId, chNFe}?xmlFormatResponse=JSON&metadata=false","description":"

This endpoint is used to detail the invoice by searching for it by \"requestId,\" \"remoteId,\" or \"chNFe.\" Additionally, you can specify the \"xmlFormatResponse\" variable as a query parameter with the value \"XML\" (to view the final invoice in XML format) or \"JSON\" (to view the final invoice in JSON format).

The response file is structured to present, at its root, variables that identify the request (requestId, remoteId, creation date, and whether the request processing has been completed).

By analyzing the \"event\" object, you can see that each event associated with the invoice up to the time of its query (yes, events are extemporaneous, in most cases) will have an individual representation precisely because they can have distinct or concurrent natures.

By analyzing each event, it's possible to observe a structure of subevents that occur sequentially to document the entire request flow (received request -> tax calculation performed -> XML generated -> XML sent to SEFAZ -> response received from SEFAZ). This structure is mostly repeated in each event.

\n","urlObject":{"protocol":"{{PROTOCOL}}","path":["invoices","{requestId, remoteId, chNFe}"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

JSON or XML

\n","type":"text/plain"},"key":"xmlFormatResponse","value":"JSON"},{"description":{"content":"

If \"xmlFormatResponse\" equals JSON, inform false or true

\n","type":"text/plain"},"key":"metadata","value":"false"}],"variable":[]}},"response":[{"id":"63360a75-2ff0-4033-ae0b-a9753b00634b","name":"200 Ok","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/{requestId, remoteId, chNFe}?xmlFormatResponse=JSON&metadata=false","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["invoices","{requestId, remoteId, chNFe}"],"query":[{"key":"xmlFormatResponse","value":"JSON","description":"JSON or XML"},{"key":"metadata","value":"false","description":"If \"xmlFormatResponse\" equals JSON, inform false or true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"requestId\": \"0199de8a-8772-759e-b1a9-00cfa9885538\",\n \"remoteId\": \"regra-completa-reforma\",\n \"createdAt\": {\n \"epoch\": 1760375244,\n \"formatted\": \"13/10/2025 - 14:07:24\"\n },\n \"updatedAt\": {\n \"epoch\": 1760376720,\n \"formatted\": \"13/10/2025 - 14:32:00\"\n },\n \"finished\": true,\n \"events\": [\n {\n \"type\": \"AUTHORIZATION\",\n \"label\": \"Autorização normal\",\n \"requestId\": \"0199de8a-8772-759e-b1a9-00cfa9885538\",\n \"remoteId\": \"regra-completa-reforma\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8a-8772-759e-b1a9-00cfa9885538/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375244,\n \"formatted\": \"13/10/2025 - 14:07:24\"\n }\n },\n {\n \"type\": \"CALCULATION_REQUEST\",\n \"label\": \"Requisição do cálculo\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8a-8772-759e-b1a9-00cfa9885538/calculation-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375254,\n \"formatted\": \"13/10/2025 - 14:07:34\"\n }\n },\n {\n \"type\": \"CALCULATION_RESPONSE\",\n \"label\": \"Resposta do cálculo\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8a-8772-759e-b1a9-00cfa9885538/calculation-response?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375255,\n \"formatted\": \"13/10/2025 - 14:07:35\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8a-8772-759e-b1a9-00cfa9885538/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375263,\n \"formatted\": \"13/10/2025 - 14:07:43\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8a-8772-759e-b1a9-00cfa9885538/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375265,\n \"formatted\": \"13/10/2025 - 14:07:45\"\n },\n \"data\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"cStat\": \"104\",\n \"xMotivo\": \"Lote processado\",\n \"cUF\": \"35\",\n \"dhRecbto\": \"2025-10-13T14:07:44-03:00\",\n \"infRec\": null,\n \"protNFe\": {\n \"infProt\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhRecbto\": \"2025-10-13T14:07:44-03:00\",\n \"nProt\": \"135250007853422\",\n \"digVal\": \"8h3bf4gqs72ujtTfWDqB+E3LKpc=\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"_versao\": \"4.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8a-8772-759e-b1a9-00cfa9885538/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375265,\n \"formatted\": \"13/10/2025 - 14:07:45\"\n },\n \"raw\": {\n \"nfeProc\": {\n \"NFe\": {\n \"infNFe\": {\n \"ide\": {\n \"cUF\": \"35\",\n \"cNF\": \"85100305\",\n \"natOp\": \"icms-00\",\n \"mod\": \"55\",\n \"serie\": \"139\",\n \"nNF\": \"46\",\n \"dhEmi\": \"2025-10-13T14:07:43-03:00\",\n \"dhSaiEnt\": \"2025-10-13T14:07:43-03:00\",\n \"tpNF\": \"1\",\n \"idDest\": \"1\",\n \"cMunFG\": \"3550308\",\n \"tpImp\": \"1\",\n \"tpEmis\": \"1\",\n \"cDV\": \"4\",\n \"tpAmb\": \"2\",\n \"finNFe\": \"1\",\n \"indFinal\": \"1\",\n \"indPres\": \"1\",\n \"indIntermed\": \"0\",\n \"procEmi\": \"0\",\n \"verProc\": \"api-1.0.0\"\n },\n \"emit\": {\n \"CNPJ\": \"57228150000174\",\n \"xNome\": \"MGJX COMERCIO LTDA\",\n \"xFant\": \"MGJX COMERCIO LTDA\",\n \"enderEmit\": {\n \"xLgr\": \"Rua do Rocio\",\n \"nro\": \"199\",\n \"xCpl\": \"10 andar\",\n \"xBairro\": \"Vila Olimpia\",\n \"cMun\": \"3550308\",\n \"xMun\": \"SAO PAULO\",\n \"UF\": \"SP\",\n \"CEP\": \"04552000\",\n \"cPais\": \"1058\",\n \"xPais\": \"BRASIL\",\n \"fone\": \"1199999999\"\n },\n \"IE\": \"150810656117\",\n \"IM\": \"123123\",\n \"CNAE\": \"4789001\",\n \"CRT\": \"3\"\n },\n \"dest\": {\n \"CNPJ\": \"57228150000174\",\n \"xNome\": \"NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\",\n \"enderDest\": {\n \"xLgr\": \"Modelo\",\n \"nro\": \"99\",\n \"xCpl\": \"TESTE\",\n \"xBairro\": \"TESTE\",\n \"cMun\": \"3550308\",\n \"xMun\": \"SAO PAULO\",\n \"UF\": \"SP\",\n \"CEP\": \"04671071\",\n \"cPais\": \"1058\",\n \"xPais\": \"Brasil\",\n \"fone\": \"99999999999\"\n },\n \"indIEDest\": \"1\",\n \"IE\": \"150810656117\",\n \"email\": \"modelo@modelo.com\"\n },\n \"autXML\": [\n {\n \"CNPJ\": \"13937073000156\"\n }\n ],\n \"det\": [\n {\n \"prod\": {\n \"cProd\": \"1\",\n \"cEAN\": \"SEM GTIN\",\n \"xProd\": \"NOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\",\n \"NCM\": \"33061000\",\n \"CEST\": \"2002300\",\n \"EXTIPI\": \"01\",\n \"CFOP\": \"5101\",\n \"uCom\": \"UN\",\n \"qCom\": \"1\",\n \"vUnCom\": \"1374.57\",\n \"vProd\": \"1374.57\",\n \"cEANTrib\": \"SEM GTIN\",\n \"uTrib\": \"UN\",\n \"qTrib\": \"1\",\n \"vUnTrib\": \"1374.57\",\n \"vFrete\": \"100.00\",\n \"vSeg\": \"100.00\",\n \"vDesc\": \"300.00\",\n \"vOutro\": \"100.00\",\n \"indTot\": \"1\"\n },\n \"imposto\": {\n \"vTotTrib\": \"0.00\",\n \"ICMS\": {\n \"ICMS00\": {\n \"orig\": \"0\",\n \"CST\": \"00\",\n \"modBC\": \"3\",\n \"vBC\": \"1374.57\",\n \"pICMS\": \"18.00\",\n \"vICMS\": \"247.42\",\n \"pFCP\": \"2.00\",\n \"vFCP\": \"27.49\"\n }\n },\n \"IPI\": {\n \"cEnq\": \"999\",\n \"IPITrib\": {\n \"CST\": \"50\",\n \"vBC\": \"1374.57\",\n \"pIPI\": \"5.00\",\n \"vIPI\": \"68.73\"\n }\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1099.66\",\n \"pPIS\": \"1.65\",\n \"vPIS\": \"18.14\"\n }\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1099.66\",\n \"pCOFINS\": \"7.60\",\n \"vCOFINS\": \"83.57\"\n }\n },\n \"IS\": {\n \"CSTIS\": \"000\",\n \"cClassTribIS\": \"000001\",\n \"vBCIS\": \"997.95\",\n \"pIS\": \"1.00\",\n \"vIS\": \"9.98\"\n },\n \"IBSCBS\": {\n \"CST\": \"000\",\n \"cClassTrib\": \"000001\",\n \"gIBSCBS\": {\n \"vBC\": \"1007.93\",\n \"gIBSUF\": {\n \"pIBSUF\": \"0.10\",\n \"vIBSUF\": \"1.01\"\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"0.00\",\n \"vIBSMun\": \"0.00\"\n },\n \"vIBS\": \"1.01\",\n \"gCBS\": {\n \"pCBS\": \"0.90\",\n \"vCBS\": \"9.07\"\n }\n }\n }\n },\n \"infAdProd\": \"Teste de Informacao adicional do item\",\n \"vItem\": \"1374.57\",\n \"nItem\": \"1\"\n },\n {\n \"prod\": {\n \"cProd\": \"1\",\n \"cEAN\": \"SEM GTIN\",\n \"xProd\": \"NOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\",\n \"NCM\": \"33061000\",\n \"CEST\": \"2002300\",\n \"EXTIPI\": \"01\",\n \"CFOP\": \"5401\",\n \"uCom\": \"UN\",\n \"qCom\": \"1\",\n \"vUnCom\": \"1374.57\",\n \"vProd\": \"1374.57\",\n \"cEANTrib\": \"SEM GTIN\",\n \"uTrib\": \"UN\",\n \"qTrib\": \"1\",\n \"vUnTrib\": \"1374.57\",\n \"vFrete\": \"100.00\",\n \"vSeg\": \"100.00\",\n \"vDesc\": \"300.00\",\n \"vOutro\": \"100.00\",\n \"indTot\": \"1\"\n },\n \"imposto\": {\n \"vTotTrib\": \"0.00\",\n \"ICMS\": {\n \"ICMS10\": {\n \"orig\": \"0\",\n \"CST\": \"10\",\n \"modBC\": \"3\",\n \"vBC\": \"1374.57\",\n \"pICMS\": \"18.00\",\n \"vICMS\": \"247.42\",\n \"vBCFCP\": \"1374.57\",\n \"pFCP\": \"2.00\",\n \"vFCP\": \"27.49\",\n \"modBCST\": \"4\",\n \"pMVAST\": \"78.40\",\n \"pRedBCST\": \"0.00\",\n \"vBCST\": \"2574.85\",\n \"pICMSST\": \"18.00\",\n \"vICMSST\": \"216.05\",\n \"vBCFCPST\": \"2574.85\",\n \"pFCPST\": \"2.00\",\n \"vFCPST\": \"51.50\"\n }\n },\n \"IPI\": {\n \"cEnq\": \"999\",\n \"IPITrib\": {\n \"CST\": \"50\",\n \"vBC\": \"1374.57\",\n \"pIPI\": \"5.00\",\n \"vIPI\": \"68.73\"\n }\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1099.66\",\n \"pPIS\": \"1.65\",\n \"vPIS\": \"18.14\"\n }\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1099.66\",\n \"pCOFINS\": \"7.60\",\n \"vCOFINS\": \"83.57\"\n }\n },\n \"IS\": {\n \"CSTIS\": \"000\",\n \"cClassTribIS\": \"000001\",\n \"vBCIS\": \"997.95\",\n \"pIS\": \"1.00\",\n \"vIS\": \"9.98\"\n },\n \"IBSCBS\": {\n \"CST\": \"000\",\n \"cClassTrib\": \"000001\",\n \"gIBSCBS\": {\n \"vBC\": \"1007.93\",\n \"gIBSUF\": {\n \"pIBSUF\": \"0.10\",\n \"vIBSUF\": \"1.01\"\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"0.00\",\n \"vIBSMun\": \"0.00\"\n },\n \"vIBS\": \"1.01\",\n \"gCBS\": {\n \"pCBS\": \"0.90\",\n \"vCBS\": \"9.07\"\n }\n }\n }\n },\n \"infAdProd\": \"Teste de Informacao adicional do item\",\n \"vItem\": \"1649.48\",\n \"nItem\": \"2\"\n },\n {\n \"prod\": {\n \"cProd\": \"1\",\n \"cEAN\": \"SEM GTIN\",\n \"xProd\": \"NOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\",\n \"NCM\": \"33061000\",\n \"CEST\": \"2002300\",\n \"EXTIPI\": \"01\",\n \"CFOP\": \"5101\",\n \"uCom\": \"UN\",\n \"qCom\": \"1\",\n \"vUnCom\": \"1374.57\",\n \"vProd\": \"1374.57\",\n \"cEANTrib\": \"SEM GTIN\",\n \"uTrib\": \"UN\",\n \"qTrib\": \"1\",\n \"vUnTrib\": \"1374.57\",\n \"vFrete\": \"100.00\",\n \"vSeg\": \"100.00\",\n \"vDesc\": \"300.00\",\n \"vOutro\": \"100.00\",\n \"indTot\": \"1\"\n },\n \"imposto\": {\n \"vTotTrib\": \"0.00\",\n \"ICMS\": {\n \"ICMS20\": {\n \"orig\": \"0\",\n \"CST\": \"20\",\n \"modBC\": \"3\",\n \"pRedBC\": \"33.33\",\n \"vBC\": \"916.43\",\n \"pICMS\": \"18.00\",\n \"vICMS\": \"164.96\",\n \"vBCFCP\": \"916.43\",\n \"pFCP\": \"2.00\",\n \"vFCP\": \"18.33\"\n }\n },\n \"IPI\": {\n \"cEnq\": \"999\",\n \"IPITrib\": {\n \"CST\": \"50\",\n \"vBC\": \"1374.57\",\n \"pIPI\": \"5.00\",\n \"vIPI\": \"68.73\"\n }\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1191.28\",\n \"pPIS\": \"1.65\",\n \"vPIS\": \"19.66\"\n }\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1191.28\",\n \"pCOFINS\": \"7.60\",\n \"vCOFINS\": \"90.54\"\n }\n },\n \"IS\": {\n \"CSTIS\": \"000\",\n \"cClassTribIS\": \"000001\",\n \"vBCIS\": \"1081.08\",\n \"pIS\": \"1.00\",\n \"vIS\": \"10.81\"\n },\n \"IBSCBS\": {\n \"CST\": \"000\",\n \"cClassTrib\": \"000001\",\n \"gIBSCBS\": {\n \"vBC\": \"1091.89\",\n \"gIBSUF\": {\n \"pIBSUF\": \"0.10\",\n \"vIBSUF\": \"1.09\"\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"0.00\",\n \"vIBSMun\": \"0.00\"\n },\n \"vIBS\": \"1.09\",\n \"gCBS\": {\n \"pCBS\": \"0.90\",\n \"vCBS\": \"9.83\"\n }\n }\n }\n },\n \"infAdProd\": \"Teste de Informacao adicional do item\",\n \"vItem\": \"1374.57\",\n \"nItem\": \"3\"\n },\n {\n \"prod\": {\n \"cProd\": \"1\",\n \"cEAN\": \"SEM GTIN\",\n \"xProd\": \"NOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\",\n \"NCM\": \"33061000\",\n \"CEST\": \"2002300\",\n \"EXTIPI\": \"01\",\n \"CFOP\": \"5401\",\n \"uCom\": \"UN\",\n \"qCom\": \"1\",\n \"vUnCom\": \"1374.57\",\n \"vProd\": \"1374.57\",\n \"cEANTrib\": \"SEM GTIN\",\n \"uTrib\": \"UN\",\n \"qTrib\": \"1\",\n \"vUnTrib\": \"1374.57\",\n \"vFrete\": \"100.00\",\n \"vSeg\": \"100.00\",\n \"vDesc\": \"300.00\",\n \"vOutro\": \"100.00\",\n \"indTot\": \"1\"\n },\n \"imposto\": {\n \"vTotTrib\": \"0.00\",\n \"ICMS\": {\n \"ICMS70\": {\n \"orig\": \"0\",\n \"CST\": \"70\",\n \"modBC\": \"3\",\n \"pRedBC\": \"33.33\",\n \"vBC\": \"916.43\",\n \"pICMS\": \"18.00\",\n \"vICMS\": \"164.96\",\n \"vBCFCP\": \"916.43\",\n \"pFCP\": \"2.00\",\n \"vFCP\": \"18.33\",\n \"modBCST\": \"4\",\n \"pMVAST\": \"78.40\",\n \"pRedBCST\": \"0.00\",\n \"vBCST\": \"2574.85\",\n \"pICMSST\": \"18.00\",\n \"vICMSST\": \"298.51\",\n \"vBCFCPST\": \"2574.85\",\n \"pFCPST\": \"2.00\",\n \"vFCPST\": \"51.50\"\n }\n },\n \"IPI\": {\n \"cEnq\": \"999\",\n \"IPITrib\": {\n \"CST\": \"50\",\n \"vBC\": \"1374.57\",\n \"pIPI\": \"5.00\",\n \"vIPI\": \"68.73\"\n }\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1191.28\",\n \"pPIS\": \"1.65\",\n \"vPIS\": \"19.66\"\n }\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1191.28\",\n \"pCOFINS\": \"7.60\",\n \"vCOFINS\": \"90.54\"\n }\n },\n \"IS\": {\n \"CSTIS\": \"000\",\n \"cClassTribIS\": \"000001\",\n \"vBCIS\": \"1081.08\",\n \"pIS\": \"1.00\",\n \"vIS\": \"10.81\"\n },\n \"IBSCBS\": {\n \"CST\": \"000\",\n \"cClassTrib\": \"000001\",\n \"gIBSCBS\": {\n \"vBC\": \"1091.89\",\n \"gIBSUF\": {\n \"pIBSUF\": \"0.10\",\n \"vIBSUF\": \"1.09\"\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"0.00\",\n \"vIBSMun\": \"0.00\"\n },\n \"vIBS\": \"1.09\",\n \"gCBS\": {\n \"pCBS\": \"0.90\",\n \"vCBS\": \"9.83\"\n }\n }\n }\n },\n \"infAdProd\": \"Teste de Informacao adicional do item\",\n \"vItem\": \"1374.57\",\n \"nItem\": \"4\"\n },\n {\n \"prod\": {\n \"cProd\": \"1\",\n \"cEAN\": \"SEM GTIN\",\n \"xProd\": \"NOTA FISCAL EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL\",\n \"NCM\": \"33061000\",\n \"CEST\": \"2002300\",\n \"EXTIPI\": \"01\",\n \"CFOP\": \"5401\",\n \"uCom\": \"UN\",\n \"qCom\": \"1\",\n \"vUnCom\": \"1374.57\",\n \"vProd\": \"1374.57\",\n \"cEANTrib\": \"SEM GTIN\",\n \"uTrib\": \"UN\",\n \"qTrib\": \"1\",\n \"vUnTrib\": \"1374.57\",\n \"vFrete\": \"100.00\",\n \"vSeg\": \"100.00\",\n \"vDesc\": \"300.00\",\n \"vOutro\": \"100.00\",\n \"indTot\": \"1\"\n },\n \"imposto\": {\n \"vTotTrib\": \"0.00\",\n \"ICMS\": {\n \"ICMS90\": {\n \"orig\": \"0\",\n \"CST\": \"90\",\n \"modBC\": \"3\",\n \"vBC\": \"916.43\",\n \"pRedBC\": \"33.33\",\n \"pICMS\": \"18.00\",\n \"vICMS\": \"164.96\",\n \"vBCFCP\": \"916.43\",\n \"pFCP\": \"2.00\",\n \"vFCP\": \"18.33\",\n \"modBCST\": \"4\",\n \"pMVAST\": \"78.40\",\n \"pRedBCST\": \"0.00\",\n \"vBCST\": \"2574.85\",\n \"pICMSST\": \"18.00\",\n \"vICMSST\": \"298.51\",\n \"vBCFCPST\": \"2574.85\",\n \"pFCPST\": \"2.00\",\n \"vFCPST\": \"51.50\"\n }\n },\n \"IPI\": {\n \"cEnq\": \"999\",\n \"IPITrib\": {\n \"CST\": \"50\",\n \"vBC\": \"1374.57\",\n \"pIPI\": \"5.00\",\n \"vIPI\": \"68.73\"\n }\n },\n \"PIS\": {\n \"PISAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1191.28\",\n \"pPIS\": \"1.65\",\n \"vPIS\": \"19.66\"\n }\n },\n \"COFINS\": {\n \"COFINSAliq\": {\n \"CST\": \"01\",\n \"vBC\": \"1191.28\",\n \"pCOFINS\": \"7.60\",\n \"vCOFINS\": \"90.54\"\n }\n },\n \"IS\": {\n \"CSTIS\": \"000\",\n \"cClassTribIS\": \"000001\",\n \"vBCIS\": \"1081.08\",\n \"pIS\": \"1.00\",\n \"vIS\": \"10.81\"\n },\n \"IBSCBS\": {\n \"CST\": \"000\",\n \"cClassTrib\": \"000001\",\n \"gIBSCBS\": {\n \"vBC\": \"1091.89\",\n \"gIBSUF\": {\n \"pIBSUF\": \"0.10\",\n \"vIBSUF\": \"1.09\"\n },\n \"gIBSMun\": {\n \"pIBSMun\": \"0.00\",\n \"vIBSMun\": \"0.00\"\n },\n \"vIBS\": \"1.09\",\n \"gCBS\": {\n \"pCBS\": \"0.90\",\n \"vCBS\": \"9.83\"\n }\n }\n }\n },\n \"infAdProd\": \"Teste de Informacao adicional do item\",\n \"vItem\": \"1374.57\",\n \"nItem\": \"5\"\n }\n ],\n \"total\": {\n \"ICMSTot\": {\n \"vBC\": \"5498.43\",\n \"vICMS\": \"989.72\",\n \"vICMSDeson\": \"0.00\",\n \"vFCPUFDest\": \"0.00\",\n \"vICMSUFDest\": \"0.00\",\n \"vICMSUFRemet\": \"0.00\",\n \"vFCP\": \"109.97\",\n \"vBCST\": \"7724.55\",\n \"vST\": \"813.07\",\n \"vFCPST\": \"154.50\",\n \"vFCPSTRet\": \"0.00\",\n \"qBCMono\": \"0.00\",\n \"vICMSMono\": \"0.00\",\n \"qBCMonoReten\": \"0.00\",\n \"vICMSMonoReten\": \"0.00\",\n \"qBCMonoRet\": \"0.00\",\n \"vICMSMonoRet\": \"0.00\",\n \"vProd\": \"6872.85\",\n \"vFrete\": \"500.00\",\n \"vSeg\": \"500.00\",\n \"vDesc\": \"1500.00\",\n \"vII\": \"0.00\",\n \"vIPI\": \"343.65\",\n \"vIPIDevol\": \"0.00\",\n \"vPIS\": \"95.26\",\n \"vCOFINS\": \"438.76\",\n \"vOutro\": \"500.00\",\n \"vNF\": \"8184.07\",\n \"vTotTrib\": \"0.00\"\n },\n \"ISTot\": {\n \"vIS\": \"52.39\"\n },\n \"IBSCBSTot\": {\n \"vBCIBSCBS\": \"5291.53\",\n \"gIBS\": {\n \"gIBSUF\": {\n \"vDif\": \"0.00\",\n \"vDevTrib\": \"0.00\",\n \"vIBSUF\": \"5.29\"\n },\n \"gIBSMun\": {\n \"vDif\": \"0.00\",\n \"vDevTrib\": \"0.00\",\n \"vIBSMun\": \"0.00\"\n },\n \"vIBS\": \"5.29\",\n \"vCredPres\": \"0.00\",\n \"vCredPresCondSus\": \"0.00\"\n },\n \"gCBS\": {\n \"vDif\": \"0.00\",\n \"vDevTrib\": \"0.00\",\n \"vCBS\": \"47.63\",\n \"vCredPres\": \"0.00\",\n \"vCredPresCondSus\": \"0.00\"\n }\n },\n \"vNFTot\": \"7147.76\"\n },\n \"transp\": {\n \"modFrete\": \"9\"\n },\n \"pag\": {\n \"detPag\": [\n {\n \"indPag\": \"1\",\n \"tPag\": \"01\",\n \"vPag\": \"2500.00\"\n }\n ]\n },\n \"infAdic\": {\n \"infAdFisco\": \"Teste de Informacao adicional da nota\",\n \"infCpl\": \"Teste de Informacao complementar da nota\"\n },\n \"infRespTec\": {\n \"CNPJ\": \"32403309000119\",\n \"xContato\": \"Edson Sampaio de Lima\",\n \"email\": \"gestao@omnitax.ai\",\n \"fone\": \"2135205124\",\n \"idCSRT\": \"35\",\n \"hashCSRT\": \"lCatDArt2r0ooGNRHqmzOLEu74w=\"\n },\n \"_versao\": \"4.00\",\n \"_Id\": \"NFe35251057228150000174551390000000461851003054\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"8h3bf4gqs72ujtTfWDqB+E3LKpc=\",\n \"_URI\": \"#NFe35251057228150000174551390000000461851003054\"\n }\n },\n \"SignatureValue\": \"FC5tibvzlVPBpj+0QKgLUeKn6DhN+QqJ1TqVxtQm9H9lPHx/FaL2r/XhdzihiwkPYL4WR6gPnuNBGrU0+uUDEz2wDrnilmBwWGKhJ8R7EbDUepveavIgieRZm0mmL1qnD+L+HrNnBWqfAbvE8aZjIvGCgm+Eb45d0vw9GEFRGQqVK1r9h4ZdWTviIa7/zatBuBpCC63c8e32rjsU+7W+iCOB9ke27dHEhgA/s9z7gIAcH/UhVvegYmLmfNCUHxk3vMyhZvg8/uA42AJtYgf0R83zTAisx3s84N+v/Q1y5d29dOgjWaMRrTjWv2I2VaYD7jst1fb1Css3V/spqMDK7Q==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"protNFe\": {\n \"infProt\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhRecbto\": \"2025-10-13T14:07:44-03:00\",\n \"nProt\": \"135250007853422\",\n \"digVal\": \"8h3bf4gqs72ujtTfWDqB+E3LKpc=\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"_versao\": \"4.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"4.00\"\n }\n }\n },\n {\n \"type\": \"DANFE\",\n \"label\": \"Danfe\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8a-8772-759e-b1a9-00cfa9885538/danfe?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375265,\n \"formatted\": \"13/10/2025 - 14:07:45\"\n },\n \"raw\": \"JVBERi0xLjQKJeLjz9MKNSAwIG9iago8PC9MZW5ndGggMzcwOS9GaWx0ZXIvRmxhdGVEZWNvZGU+PnN0cmVhbQp4nK1czY4ctxG+71MQSAwowKqXbJL941trpkduYWZ61D2zEHybaFfJBtode7WKAD9abk4Ohg86JXmIHPIOKbJJ7Ta7irMb2bCFUVcVq1gfv+JPs/3jyYvtiWaZSNn24oSz58OPs0XKCrZ9d/JsXvfbZl1tf+6alp2xrl7V23q9rf+w/Quoc2dVFIT5otruugoM57vNsplV26ofW0rK8ezn5Wy3bNm8Zc1q0/bbdmyY+R8l5XvbVet+03bbat52EMJ5u9yt6p49fB5G43+kRfhDKfOj3p68PvnR/peyV/D85QlPNPt0krEsK1nKORM8Y7eXJ70TpHwQiXQikmnGcqlZCn1RfCLhuZVABIHEegKJHEnguRI2grGFDQAksriXvDawC2Y6LgD8RCoIBDp4DekTLn2rl6/esFm7qrsZQL/cziuTK2+kywTynUM0YPSMdR/37OLAusPbq8MpE2UJf3C2v7nY3z60KjTLRWFNzq/e71n7/ur6h6v9Q5VcJ0UJWtxq9VXLNpUZB89Zvxk1Bb2D1nhq9Wb1hn3LldbQf27UAKgHXUx1mqQQbiaGPn4Z3dV6USPqMk9SaFzlkEGXlHIwaGcwhtbDYPyingob85DBZ6zavWmWTdWxecXW7bYa63LIGh/afcYWTT+rlqxe1tvuX2sgCBY7t2NhFIcw+dj/92KP6WdJXrKs1OO+rv/GVDYKRcHAKOQQSP9r19RMyHKkMaQty4WL9vD+z3smnM8fmdeTSieQXWnS9faanb15J9j8wEaj7KEONGZylg28e/7g97grEsZrnrquS6aGwvBddV6zec2qWd337TQBxlNuBpoM0ZMaUBVcA7HSAsYwjBXGRa6Y1kKy0v7V/KEyGKRawC/JtUI85HxIcT6mzOxw8+Hj+zugwiXbf7y7vLm7ent1sYe/3RzYD4fbu/17drMHitzAj4s9Wy+eXz7MtyzKxIJS2nx/+vQpuXl3mbzb/3QJTEr+dPhr8sfbM9fQ4aNp9cPV3agJBWMrVdDEABk46S/BnlUf7w63Vz/tLw63yJgpoKaIcZrXpnLX31dmELebuqt++QeSazCckuTq7fWH5ygNOeJo07XbdtaaUg+Y7rZt13xvnJm/7jB8bStTr8KgC+jlhZYKRu1zGM1ngp+l3ICuvuX5t0r6oYtXcBgERP0EiSngSC02EhlKlJ5KXgd5k3Kch2bdz7rGdBym3Gq+q5ZoukU56bjmBcwsOhMiJ7KF+Uq8GzPF9rsX/TaBqbF5sbNzPTLoU6Sh2XrzilCdBqqhqqZFAvGeAU7ieY5QS+loalY7KJLNBsuNtUSyk0r4N4p7AdVVFlmS5SHAZWoe5sB1UcoEwtLZeMp9IBqbwhRoHiLyYBwUaTnubFfP6hf1qu0NAaaTMAMBUGYOROlBsgYQYTnW+7nGzyjNeg6zCTysXlTNGwROlZcJjOxCfKlhZso1xA+KksptZophCnrGJvOIymxLeekU+v/cXl2GU4nK06SEVUaRY1PJOCM8qBBzWDaaZNjMNF+m33CcC5PliXEzB/1mAcmw1GJV3zfrYVUK435INqwPIwPEVBqdA5HLSWkovQwdA6rkCcyvRl4io8vaqpRuF2SYnSxVAqhRYu+VENuWhcIjhupnbUGO2bq4CKmPixD7uCbiESEMf3XJg7kICHDWVd8DgH07azD2WzsYqQH7YTDXrF412waoUK9YtXrRmO2LGU7ftSuYdV5Ws8quLkF6Xi2/jISHQ6tEo5ptFmd4/XMG03B0bhYeZpYyyw6ElFBwTI5CV5YBJuLOzsfQob7HpmNvP/VMz4VhErN07Ltez+uu/gXxZtVVEbpaHS4u38MuwGwCoDJtsQV2ibqCUtV1GLdLwhXRvIQBZkZi2D7sEmjlaetcwcqX50iR8nkOHQQ49dXneXUG462r5sjK3rcy9fx4tPyuzUdgJ8jPG2wCt/p+63Hv68sWC6upQ4Chk0W7rs8W1RvaYuqmvP+HBDj0s1uQqkg/ItiGDT9mreVtp57iCy6PKu0zXMRQk46CiUOPdu2kJqxEYUUMu55xzdXa7GOtVCV5WJFhg5PA/pkyFuZhTotLnWhJilMlE3hixSLJi1BcaLNosOJ0KpZpnhSKbFzmOslIqUphahu6rcH1ZFoGYz5EJkSamBl4MkPKsogk1ErphFLGLqGkeEgoJXYJtWI6oVZMJ5RqfEgoJXUJNeJIQq0YshLmU6dl4qTQNj3tK5WF00FfM3MOmLBmturxiqakvudnPqygf890osriFKua2h7tTHydLwkfTh/1UhblaZ5ObQRUQUOsqZOhJ7D66KGEwqyAFF1vjHrkp9i+WqjSMpX0t5ht2G5h3G4T2vwpHs1KUEY8Rrw50yd4S83ZURH3Zk+mEXfe9inuitzWJswdZJI2QH0IXp6WyDwhDS3U0VHP+i1tizoEkqXqVGvs3CpPiH6ZY3bS22CGOiuEPOXYLJhqW4OJHAJcsCRvUXfeFM+mhq4hmCmIkRNDxPlLmNkpd03bJbhf18QTRootQMOB9til36ETJjxHXGRJkaenBYKbq0GYowV0DFkBOwvUD2w/cE67woO56euXO2xl7m2e5sjVG8wRFI1Zi27wvRXqSiSkM1duMGdNQ+ujbuLlCXWxQXx4A9SHVPI0QwaBLzKEF8jcebs8b7ApxZs+oU++wqCDu0HGtTdAfZT6NM3IwoL5mLULWDCTJqgXJYvTHHHjC0rop91tOzviNol7mdA1FeLT2z9pkPtqgg7y+/dCuBHPxu9uTKFNRKHQUqulSAhHFdShN80K1hnuaBerSM4e8fmgZ9jOQxi6sO7lsGIuUrtZEalb+402KNKckanELLnT0aoVlpOZlWZZokNpUSQyHWx5aV5SjsWGqtlgLe3aOGhbcnPkaM1LU6UCMdSTcrCG5S1UlkCcS7PSJcWl71YKu/ewbZlmdiNgIisSLkNxpuxanRArU1RLWqy4efdKdVtB4IqMTHORlJIWQ86UJnOmIWcqJyOzKTEoDkgrBGnzYmRAWiFIm+cOaYUhDXLXZYUhbcyHqBWGNIgdlApDmhKXvlsuYQpD2kQ2ZERhSBNijzQldkgT3XZIE5F5pCmxQ5rImUeaiMymRKUxpEEaQdrYxpAGeQxpYx5B2uzpI0hT4tJ3K4a0iSyCNCH2SFNihzTRbYc0EZlHmhI7pImceaSJyGxKbEAk0uZtH420sY0hbc40IkgbQQRpEMeQpsSl71YMaRNZBGlC7JGmxA5potsOaSIyjzQldkgTOfNIE5HZlJg3QzTS8DCCtLGNIQ1PY0jbl1I00vA0hjQlLn23YkibyCJIE2KPNCV2SBPddkgTkXmkKbFDmsiZR5qIzKaE8xjSnMeQ5jyONOdRpDmPIs15FGlKXPpuxZDmPIo0IfZIU2KHNNFthzQRmUeaEjukiZx5pCeRTY5XZaHCy29zc8mg9YcV7Ay2+d15Q73qk3lwtvI77ObcsJ4PNGf/nDcvsWb5sMAP1M0hgH1Vgm3Py2HNH5isZyssmnTYAYThYMc/qRbDfiBUXrTYkV+uh+1BoL1bN3PqpdVE+fWuWqOne8WwewjPsszraQYeMBtgK0eiH2y2LXbexdWwzaAOIBETlQ5bj8eenptXAwgARh87GNFcDruTQP8b6nAeAFZIYr8hmgeI7fYFOSS0W+VkdMXVaw9XTOkNtMXWvwoWLBteEpLkeISm40UmvaZ29yDuL/jglxoexu8a0cN9W+K2g2uOJloYrZQ8E/glW8e20IK4kTuwLVTWgmOZc2wLtXdrkmuTLCccDcSTLdS3h4oyV6caO7t3bHuSkefb04wc4xCjVOWnCnn75DiHWGTFaY69EnOsm6SsQE+2POkm0OHajkVIOPSZulTFWBvppmNTqEmzSZW/AZuU+io2hdEeZ1NowUWETaGyVjE2hdoRNk2yfIRNof6j2PQkI8+mpxk5NiFGR9iEWBxh0yRlcTZNoIuyCQknwqb7TzvcqCPZFGrSbJL6N2CT5F/Fpkm/jrIptOBphE2hcnxuCrUjbJpk+QibQv1HselJRp5NiFEpMvQihecS5idTpyX2ImbgEmJxhEuThMW5NAEuyiUknAiXUj7WRm5xOi6FmjSXUvEbcElkX8WlMNrjXAoteB7hUqgcn5lC7QiXJlk+wqVQ/1FcepKR5xJidIxLmJ84lxCLI1yaJCzOpQlwUS4h4US45F85fmmb5FKoSXPp/ku5r+CS+6rw/+VSGO1xLoUWvIxwaZK2KJdC7QiXJlk+wqVQ/1FcepKR5xJidIxLmJ84lxCLI1yaJCzOpQlwUS4h4Rx5IW8OQFP7GjNPJvdDlU6klQrBk/COptTa2WYwhCfXP3VivytlOmxVFdKJgKiTi588cy4L8UA4OZlMw/OY+KcesFI3zYZG9iYU2wA9zQUi7EPawS5Lk/BquiH35TV7d3s5fEwZDFydY0HOWnOmae6UoXfYcpOX0GazhFpijlzP688z9Mq9KjRmiN2E17zA8mA+STmbbRbHxol5C2RzEd4E5lYmpDaVKUR0eGjkRSLCi8A6tafoqf1SMFEqArkKbqvQX5mY87eJeuQzB81zG2NogqYwtTVpouvu6v998n0AmU2Of+MluP0mihK7761IcRlr231vRYnd91ZT8RSMNPjcyJ5Lw0Q5R24WCm4/i5jY1P3m11mDfeszfBIyMVhVHfq5e4mGtN6tqG+Q3YcaE5NN3bfsRbfDLhO6jzRwm+Xn17v7e3RHbz6JIovcfBKmZhJf+IWyCTKiKLB3NtW8mTXtusLu4VmzfDKeF223qn75d/3Q2HwE15grsXXf16YqmXUN8fIHps6wbG4vP9xdmk/dm5t3h9vr/dv9ge0vru4/b7853GH/f4LyaIizdrVZ1uZDz6qrp2Ga+m4O481DBk/r7tzccKtacmHmfD6uD28P1z+8v7y+vLnb3wbd+B/zMnnkCmVuZHN0cmVhbQplbmRvYmoKNyAwIG9iago8PC9UeXBlL1BhZ2UvTWVkaWFCb3hbMCAwIDU5NSA4NDJdL1Jlc291cmNlczw8L0ZvbnQ8PC9GMSAyIDAgUi9GMiAzIDAgUi9GMyA0IDAgUj4+L1hPYmplY3Q8PC9YZjEgMSAwIFI+Pj4+L0NvbnRlbnRzIDUgMCBSL1BhcmVudCA2IDAgUj4+CmVuZG9iagoyIDAgb2JqCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1R5cGUxL0Jhc2VGb250L1RpbWVzLVJvbWFuL0VuY29kaW5nL1dpbkFuc2lFbmNvZGluZz4+CmVuZG9iagozIDAgb2JqCjw8L1R5cGUvRm9udC9TdWJ0eXBlL1R5cGUxL0Jhc2VGb250L1RpbWVzLUJvbGQvRW5jb2RpbmcvV2luQW5zaUVuY29kaW5nPj4KZW5kb2JqCjQgMCBvYmoKPDwvVHlwZS9Gb250L1N1YnR5cGUvVHlwZTEvQmFzZUZvbnQvVGltZXMtSXRhbGljL0VuY29kaW5nL1dpbkFuc2lFbmNvZGluZz4+CmVuZG9iagoxIDAgb2JqCjw8L1R5cGUvWE9iamVjdC9TdWJ0eXBlL0Zvcm0vUmVzb3VyY2VzPDw+Pi9CQm94WzAgMCAyMjEuNiAzNV0vRm9ybVR5cGUgMS9NYXRyaXggWzEgMCAwIDEgMCAwXS9MZW5ndGggMjg1L0ZpbHRlci9GbGF0ZURlY29kZT4+c3RyZWFtCnicjZQ7csYgDIR7n8In8GjF+0BJ+v/+RWzjjOGjybgwEuyuBDuy3c7v87NdPx15D2n/fG1+xGvjqE8cz5XtV7bH9Y7fffkcpsMnPpVzORK47sQL8QCI57uGIdEACY4qQpd9VUIFRzRAIvYLGJLhJhJFUxcdEvk+cfXTE7n3+qrkhE4yZYuh8NJlh8RMWRqurzoYagRDnftoM76xrZbhAZnNj258Qhkblc01SL3RgVURhUu8ULmhFy32kSfcurwSFYAJi3YoZImLdly0I72rSPMqCW+uBKVE9+px0oBZrKTHSyOqEVVoYsFOKot2pYu1OEp10a6NqBZYzeOsoZpGdTdOJDeemDlc4kARx4OrktUxB//m1D/j7+0XE4sMNgplbmRzdHJlYW0KZW5kb2JqCjYgMCBvYmoKPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbNyAwIFJdPj4KZW5kb2JqCjggMCBvYmoKPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDYgMCBSPj4KZW5kb2JqCjkgMCBvYmoKPDwvUHJvZHVjZXIoaVRleHSuIDUuNS4xMCCpMjAwMC0yMDE1IGlUZXh0IEdyb3VwIE5WIFwoQUdQTC12ZXJzaW9uXCkpL0NyZWF0aW9uRGF0ZShEOjIwMjUxMDEzMTQwNzQ1LTAzJzAwJykvTW9kRGF0ZShEOjIwMjUxMDEzMTQwNzQ1LTAzJzAwJyk+PgplbmRvYmoKeHJlZgowIDEwCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwNDIxNCAwMDAwMCBuIAowMDAwMDAzOTQ0IDAwMDAwIG4gCjAwMDAwMDQwMzQgMDAwMDAgbiAKMDAwMDAwNDEyMyAwMDAwMCBuIAowMDAwMDAwMDE1IDAwMDAwIG4gCjAwMDAwMDQ2NTcgMDAwMDAgbiAKMDAwMDAwMzc5MiAwMDAwMCBuIAowMDAwMDA0NzA4IDAwMDAwIG4gCjAwMDAwMDQ3NTMgMDAwMDAgbiAKdHJhaWxlcgo8PC9TaXplIDEwL1Jvb3QgOCAwIFIvSW5mbyA5IDAgUi9JRCBbPGNlYWViNjk5MjhhNjQ1ZmUzOWNmYzg2NGVlMDM5MTA1PjxjZWFlYjY5OTI4YTY0NWZlMzljZmM4NjRlZTAzOTEwNT5dPj4KJWlUZXh0LTUuNS4xMApzdGFydHhyZWYKNDkxMQolJUVPRgo=\"\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760375244,\n \"formatted\": \"13/10/2025 - 14:07:24\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"CORRECTION\",\n \"label\": \"Carta de correção\",\n \"requestId\": \"0199de8b-02a1-704d-8993-d22b5286499a\",\n \"remoteId\": \"teste-carta-correcao\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8b-02a1-704d-8993-d22b5286499a/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375276,\n \"formatted\": \"13/10/2025 - 14:07:56\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8b-02a1-704d-8993-d22b5286499a/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375280,\n \"formatted\": \"13/10/2025 - 14:08:00\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8b-02a1-704d-8993-d22b5286499a/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375281,\n \"formatted\": \"13/10/2025 - 14:08:01\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de Evento Processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"emailDest\": \"modelo@modelo.com\",\n \"dhRegEvento\": \"2025-10-13T14:08:01-03:00\",\n \"nProt\": \"135250007853428\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de8b-02a1-704d-8993-d22b5286499a/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760375281,\n \"formatted\": \"13/10/2025 - 14:08:01\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:08:00-03:00\",\n \"tpEvento\": \"110110\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Carta de Correcao\",\n \"xCorrecao\": \"Teste de carta de correcao\",\n \"xCondUso\": \"A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1101103525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"LlYp48+Oxg3yW+qOR4by5aUrbeE=\",\n \"_URI\": \"#ID1101103525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"Quk+v+4b7vSNGKnMrSM+goxFRSiZFkrq4FErM3yts61G5cUe8284sL09UEw5WyP9QV85pDO7pRizG+392mV42Yr+HpkKV3GWR+ELd6wc2M5ZmF+aWkYVkQ6Wo5SGEZ2fo/InNUCrLWnUANBsI/0gVQ7o6+J/WREvgD5YZmktFT5JLP8p9AQf1CLHQ3XLPFKdO52CHcoZwfg5uTXSXwS/y/1H7AHsWzZIXVxhan9gPz8Ar0YQ3Ix3dP1WSw1+fL+JxPmCE+oUzm7HhWJhNH++wC7M5sbkKZawy6frUH43cxBSHtZ+QPhM5xHzc6kHmEremvTdHCDyX0CkhDfmEejC1Q==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"emailDest\": \"modelo@modelo.com\",\n \"dhRegEvento\": \"2025-10-13T14:08:01-03:00\",\n \"nProt\": \"135250007853428\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760375276,\n \"formatted\": \"13/10/2025 - 14:07:56\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"CORRECTION\",\n \"label\": \"Carta de correção\",\n \"requestId\": \"0199de9f-e3f4-7640-b34d-62b18857d3af\",\n \"remoteId\": \"teste-carta-correcao\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de9f-e3f4-7640-b34d-62b18857d3af/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376644,\n \"formatted\": \"13/10/2025 - 14:30:44\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de9f-e3f4-7640-b34d-62b18857d3af/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376652,\n \"formatted\": \"13/10/2025 - 14:30:52\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de9f-e3f4-7640-b34d-62b18857d3af/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376653,\n \"formatted\": \"13/10/2025 - 14:30:53\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de Evento Processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"2\",\n \"CNPJDest\": \"57228150000174\",\n \"emailDest\": \"modelo@modelo.com\",\n \"dhRegEvento\": \"2025-10-13T14:30:53-03:00\",\n \"nProt\": \"135250007854024\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199de9f-e3f4-7640-b34d-62b18857d3af/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376653,\n \"formatted\": \"13/10/2025 - 14:30:53\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:30:52-03:00\",\n \"tpEvento\": \"110110\",\n \"nSeqEvento\": \"2\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Carta de Correcao\",\n \"xCorrecao\": \"Teste de carta de correcao\",\n \"xCondUso\": \"A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1101103525105722815000017455139000000046185100305402\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"JmsZVB6HvKkn/FllXeau9OExzbY=\",\n \"_URI\": \"#ID1101103525105722815000017455139000000046185100305402\"\n }\n },\n \"SignatureValue\": \"P1HvlJ2WJIaXdWmhJf7Vq960fa6v8sJ1CAHWR6137/9wEMSk8Q5sP2GDLsptxSD4rdgQSLGRzguo1Pc3K0ikTouBKzLYqmM6NefGRpyHUjrpYM5cfSYMC78i1fO7I1GABBufa2Gdx0pI3ZFZVc6Wr7S3ZOFZrLalse/ietQdK84L3KA9dLinBBfcFiyQEPFRC8vyGLuaYpOsWuQK4aomTEbtb+g4JHA7FeCAfpKleFb98y1A05QBf5DAs9Q2j/PEkZayfp27R3ZfhDcMCZtmafKQyFHA4KIJasnSOSC3IkdHYKKsZoBQcb3aHdzTb79M5n0i/Vd8y44hcchk2ykFEA==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"2\",\n \"CNPJDest\": \"57228150000174\",\n \"emailDest\": \"modelo@modelo.com\",\n \"dhRegEvento\": \"2025-10-13T14:30:53-03:00\",\n \"nProt\": \"135250007854024\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376644,\n \"formatted\": \"13/10/2025 - 14:30:44\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"PROTOCOL_QUERY\",\n \"label\": \"Consulta de Protocolo\",\n \"requestId\": \"0199dea0-1bc9-700f-a08c-4a5b22ac8ef1\",\n \"remoteId\": \"teste-consulta-protocolo\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-1bc9-700f-a08c-4a5b22ac8ef1/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376658,\n \"formatted\": \"13/10/2025 - 14:30:58\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-1bc9-700f-a08c-4a5b22ac8ef1/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376664,\n \"formatted\": \"13/10/2025 - 14:31:04\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-1bc9-700f-a08c-4a5b22ac8ef1/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376665,\n \"formatted\": \"13/10/2025 - 14:31:05\"\n },\n \"data\": {\n \"versao\": \"4.00\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\",\n \"cUF\": \"35\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"protNFe\": {\n \"infProt\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhRecbto\": \"2025-10-13T14:07:44-03:00\",\n \"nProt\": \"135250007853422\",\n \"digVal\": \"8h3bf4gqs72ujtTfWDqB+E3LKpc=\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"_versao\": \"4.00\"\n },\n \"retCancNFe\": null,\n \"procEventoNFe\": [\n {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:08:00-03:00\",\n \"tpEvento\": \"110110\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Carta de Correcao\",\n \"xCorrecao\": \"Teste de carta de correcao\",\n \"xCondUso\": \"A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1101103525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"LlYp48+Oxg3yW+qOR4by5aUrbeE=\",\n \"_URI\": \"#ID1101103525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"Quk+v+4b7vSNGKnMrSM+goxFRSiZFkrq4FErM3yts61G5cUe8284sL09UEw5WyP9QV85pDO7pRizG+392mV42Yr+HpkKV3GWR+ELd6wc2M5ZmF+aWkYVkQ6Wo5SGEZ2fo/InNUCrLWnUANBsI/0gVQ7o6+J/WREvgD5YZmktFT5JLP8p9AQf1CLHQ3XLPFKdO52CHcoZwfg5uTXSXwS/y/1H7AHsWzZIXVxhan9gPz8Ar0YQ3Ix3dP1WSw1+fL+JxPmCE+oUzm7HhWJhNH++wC7M5sbkKZawy6frUH43cxBSHtZ+QPhM5xHzc6kHmEremvTdHCDyX0CkhDfmEejC1Q==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:08:01-03:00\",\n \"nProt\": \"135250007853428\"\n },\n \"_versao\": \"1.00\"\n },\n \"_versao\": \"1.00\"\n },\n {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:30:52-03:00\",\n \"tpEvento\": \"110110\",\n \"nSeqEvento\": \"2\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Carta de Correcao\",\n \"xCorrecao\": \"Teste de carta de correcao\",\n \"xCondUso\": \"A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1101103525105722815000017455139000000046185100305402\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"JmsZVB6HvKkn/FllXeau9OExzbY=\",\n \"_URI\": \"#ID1101103525105722815000017455139000000046185100305402\"\n }\n },\n \"SignatureValue\": \"P1HvlJ2WJIaXdWmhJf7Vq960fa6v8sJ1CAHWR6137/9wEMSk8Q5sP2GDLsptxSD4rdgQSLGRzguo1Pc3K0ikTouBKzLYqmM6NefGRpyHUjrpYM5cfSYMC78i1fO7I1GABBufa2Gdx0pI3ZFZVc6Wr7S3ZOFZrLalse/ietQdK84L3KA9dLinBBfcFiyQEPFRC8vyGLuaYpOsWuQK4aomTEbtb+g4JHA7FeCAfpKleFb98y1A05QBf5DAs9Q2j/PEkZayfp27R3ZfhDcMCZtmafKQyFHA4KIJasnSOSC3IkdHYKKsZoBQcb3aHdzTb79M5n0i/Vd8y44hcchk2ykFEA==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"2\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:30:53-03:00\",\n \"nProt\": \"135250007854024\"\n },\n \"_versao\": \"1.00\"\n },\n \"_versao\": \"1.00\"\n }\n ]\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376658,\n \"formatted\": \"13/10/2025 - 14:30:58\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Ciência da Operação\",\n \"requestId\": \"0199dea0-38f7-73fe-a02d-ab4b31587799\",\n \"remoteId\": \"teste-ciencia-da-operacao\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-38f7-73fe-a02d-ab4b31587799/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376666,\n \"formatted\": \"13/10/2025 - 14:31:06\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-38f7-73fe-a02d-ab4b31587799/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376667,\n \"formatted\": \"13/10/2025 - 14:31:07\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-38f7-73fe-a02d-ab4b31587799/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376668,\n \"formatted\": \"13/10/2025 - 14:31:08\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210210\",\n \"xEvento\": \"Ciencia da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:07-03:00\",\n \"nProt\": \"891250010538669\",\n \"_Id\": \"ID891250010538669\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-38f7-73fe-a02d-ab4b31587799/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376668,\n \"formatted\": \"13/10/2025 - 14:31:08\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"91\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:31:07-03:00\",\n \"tpEvento\": \"210210\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Ciencia da Operacao\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID2102103525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"Ru8WIAXyl+iUgr1BXwdR1BA702A=\",\n \"_URI\": \"#ID2102103525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"lMMKyKQvDf0lGGbNRfftNrw3DfrGNPN6r15+5vw6treSLrblkIUtP98UuMwjG7K5yySjYeC6P3XesqPxdGRBzQT/AIlUSacZUqbaQGVq+HOwUlgNGvFRI656CVcRMYccBzDBusg2G2QhlnmMhLodyvyhT2ToKUbj0dXbRue4WHAN+AlTiZZqxRJoWvWBkpZyoPVv02tPSSIugYNRjGtwo3Mxr6abhkG+jIlBiWOWPYSQte5TgdAVyP2RKFOTTSlUZW7MlakHjTJzLVa7qht3oxAl7xf+wQqZOXtMGGNbUtALY2ipGblduOSWUwI4dKhcHYS6V6eHU77xJGU/Qh4EDg==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210210\",\n \"xEvento\": \"Ciencia da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:07-03:00\",\n \"nProt\": \"891250010538669\",\n \"_Id\": \"ID891250010538669\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376666,\n \"formatted\": \"13/10/2025 - 14:31:06\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Operação desconhecida\",\n \"requestId\": \"0199dea0-4f1d-71cd-82de-a5b030540241\",\n \"remoteId\": \"teste-operacao-desconhecida\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-4f1d-71cd-82de-a5b030540241/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376672,\n \"formatted\": \"13/10/2025 - 14:31:12\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-4f1d-71cd-82de-a5b030540241/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376673,\n \"formatted\": \"13/10/2025 - 14:31:13\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-4f1d-71cd-82de-a5b030540241/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376673,\n \"formatted\": \"13/10/2025 - 14:31:13\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210220\",\n \"xEvento\": \"Desconhecimento da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:12-03:00\",\n \"nProt\": \"891250010538670\",\n \"_Id\": \"ID891250010538670\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-4f1d-71cd-82de-a5b030540241/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376673,\n \"formatted\": \"13/10/2025 - 14:31:13\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"91\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:31:13-03:00\",\n \"tpEvento\": \"210220\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Desconhecimento da Operacao\",\n \"xJust\": \"Teste de manifestacao\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID2102203525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"qeCpTSVv0bueNiGM+sH8KiBzxy8=\",\n \"_URI\": \"#ID2102203525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"CrpinYqOKgBXZX4tWuMdYNSNY2Gu5HE77xXDCVUtTstsDQUOHe/tHlw4aZRMF0v8BY9tRy0NsCwsIY7HtjCorIdhHHWfwK4kWwDVqWkYNyo2VSXw72wdku3rJLRydM0u5/fOmOwcFVZvZ/6NuKrH0REHK5WAgcvQ1e31RhGsydg6sYix49MANK28ZHTLjoy+BdNCIR7qmlI9pG3DPtMvR0GdPJNfUooOwwHhyUjuXfJ9urK9AOj7s4WZ3Pe31iyrx5k8Lfzj+G7UuCQPptLEgXlHOmlxYXCpLdRRKS7yIvmPQ5pFj+Uv5fN+h5OOELgIupT7iRoFWw6uKU0mCKEhPw==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210220\",\n \"xEvento\": \"Desconhecimento da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:12-03:00\",\n \"nProt\": \"891250010538670\",\n \"_Id\": \"ID891250010538670\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376672,\n \"formatted\": \"13/10/2025 - 14:31:12\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Operação não Realizada\",\n \"requestId\": \"0199dea0-6110-733a-81f4-de2f0ba01879\",\n \"remoteId\": \"teste-operacao-nao-realizada\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-6110-733a-81f4-de2f0ba01879/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376676,\n \"formatted\": \"13/10/2025 - 14:31:16\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-6110-733a-81f4-de2f0ba01879/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376680,\n \"formatted\": \"13/10/2025 - 14:31:20\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-6110-733a-81f4-de2f0ba01879/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376681,\n \"formatted\": \"13/10/2025 - 14:31:21\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210240\",\n \"xEvento\": \"Operacao nao Realizada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:20-03:00\",\n \"nProt\": \"891250010538671\",\n \"_Id\": \"ID891250010538671\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-6110-733a-81f4-de2f0ba01879/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376681,\n \"formatted\": \"13/10/2025 - 14:31:21\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"91\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:31:20-03:00\",\n \"tpEvento\": \"210240\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Operacao nao Realizada\",\n \"xJust\": \"Teste de manifestacao\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID2102403525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"e4V454Zppz/6Km3V02v6bLmLduw=\",\n \"_URI\": \"#ID2102403525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"jd3tKgMdGRodOgDaq/3XpZDirfVVi8LugsjjUWDRBS1RJe6sF8sdIANZuxatSXmemwFPuK7+qCgWUkG4bSw9KG8mcr0CdKaw+laq1SkKFN5SjiN6jQ7Hf10afBRMoTvOiBup10EiQup0+HGdPF1jWcY2f3kIjnzjAPd3KL+7f9aBeGrZMyNgvkRbFvd8KYBGetV40edwdJFngY3kwr+0eh+kAglRhu0Yb3w+fT7vMWO1G2foCCXCvUWb/wp1nH0CA5U+RtCJrpB+n8L/yar3d41SZcrrXvMr3oV9Zas/QEnMIiyisfaP7dkaW8K3sD/O21iq3OGvcDj4b6q17VYMJA==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210240\",\n \"xEvento\": \"Operacao nao Realizada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:20-03:00\",\n \"nProt\": \"891250010538671\",\n \"_Id\": \"ID891250010538671\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376676,\n \"formatted\": \"13/10/2025 - 14:31:16\"\n },\n \"lastStatus\": false\n },\n {\n \"type\": \"MANIFESTATION\",\n \"label\": \"Manifestação - Operação Realizada\",\n \"requestId\": \"0199dea0-73a6-754f-b065-ca910a56c87a\",\n \"remoteId\": \"teste-operacao-realizada\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-73a6-754f-b065-ca910a56c87a/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376681,\n \"formatted\": \"13/10/2025 - 14:31:21\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-73a6-754f-b065-ca910a56c87a/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376688,\n \"formatted\": \"13/10/2025 - 14:31:28\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-73a6-754f-b065-ca910a56c87a/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376689,\n \"formatted\": \"13/10/2025 - 14:31:29\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de evento processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210200\",\n \"xEvento\": \"Confirmacao da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:28-03:00\",\n \"nProt\": \"891250010538673\",\n \"_Id\": \"ID891250010538673\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-73a6-754f-b065-ca910a56c87a/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376689,\n \"formatted\": \"13/10/2025 - 14:31:29\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"91\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:31:28-03:00\",\n \"tpEvento\": \"210200\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Confirmacao da Operacao\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID2102003525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"F0sYyulGRSwA5odO0cRzcKYiVvk=\",\n \"_URI\": \"#ID2102003525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"QqAL5adxebMTDqHjRK5KQCzT/7e1zNNcX6FaoC3LSoFWDyWfONDzYvGW+Nwd/9tTbvGiNTqiDAsR0N2HTBzwNe/tf/PyKLorOfQpKuUEhmqujgsdE8YTJQdw5p7GCkbvlgn2WANajdC9oyWdwFdL6gxMv/WfGSQbAM7yyBC/XkU3QVdfSNzBLfhV+FYfBew3V6qqWPwRKjNyfwlO7wNJNYoqWo96H2SAFmJwFs5scjbeCKzHmJ7sJGVS+aE9bDjXJ/zr1CwSMSrSqOsHY4yhgKIEKcVbQ+/kWkMAIaeJzONPih073ocWcwwh1w+l9LnZ0gGsCziM/Z//4W87FkyzUA==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"AN_1.8.7\",\n \"cOrgao\": \"91\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"210200\",\n \"xEvento\": \"Confirmacao da Operacao\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:31:28-03:00\",\n \"nProt\": \"891250010538673\",\n \"_Id\": \"ID891250010538673\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376681,\n \"formatted\": \"13/10/2025 - 14:31:21\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"FULL_PAYMENT\",\n \"label\": \"Informação de efetivo pagamento integral para liberar crédito presumido do adquirente\",\n \"requestId\": \"0199dea0-95bf-764b-b2ca-a7e767ff659f\",\n \"remoteId\": \"rtc-efetivo-pagamento\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-95bf-764b-b2ca-a7e767ff659f/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376690,\n \"formatted\": \"13/10/2025 - 14:31:30\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-95bf-764b-b2ca-a7e767ff659f/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376701,\n \"formatted\": \"13/10/2025 - 14:31:41\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-95bf-764b-b2ca-a7e767ff659f/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376702,\n \"formatted\": \"13/10/2025 - 14:31:42\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SVRS2510020917\",\n \"cOrgao\": \"35\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de Evento Processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SVRS2510020917\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"112110\",\n \"nSeqEvento\": \"1\",\n \"CPFDest\": \"00000000000\",\n \"dhRegEvento\": \"2025-10-13T14:31:41-03:00\",\n \"nProt\": \"335250000002297\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-95bf-764b-b2ca-a7e767ff659f/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376702,\n \"formatted\": \"13/10/2025 - 14:31:42\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:31:40-03:00\",\n \"tpEvento\": \"112110\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Informação de efetivo pagamento integral para liberar crédito presumido do adquirente\",\n \"cOrgaoAutor\": \"35\",\n \"tpAutor\": \"1\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"indQuitacao\": \"1\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1121103525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"srRsYc6H40bx9uZg4yrj7yQBqAY=\",\n \"_URI\": \"#ID1121103525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"D8kr1KeeGZwhhM+OcZSdPOqA1zvvvhYi2A+z02fhNyE6WfNcIY1j/Yky3lrWOKTClUcqDfm1o4AlbZatAEfWYIAq4vYn6osbNmvsUOR0X5tgQCMW9S9390xPF5dLavLt9q6EvYgXR/8T1o8fvCIq6MhNqf0czbbaCDrS0nPxVoavryKWVahzgGgcNLhpQ2D9wPeYHjaSM/SlAz4AHWEEo1zwTj/b44wkMGRETGcMk1YqCQQUvW0u6hzIduauUYWI7u1GnpZDrYjJi5RHGO3u4uikK+oolcf8FF+qehOOGM0lnU0cBmty8OfASNIqYrxOyalMst/6D4BgMAuVvZLCig==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SVRS2510020917\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"112110\",\n \"nSeqEvento\": \"1\",\n \"CPFDest\": \"00000000000\",\n \"dhRegEvento\": \"2025-10-13T14:31:41-03:00\",\n \"nProt\": \"335250000002297\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376690,\n \"formatted\": \"13/10/2025 - 14:31:30\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"EVENT_CANCELLATION\",\n \"label\": \"Cancelamento de evento\",\n \"requestId\": \"0199dea0-cf63-75d9-94e6-8611d57d849b\",\n \"remoteId\": \"rtc-efetivo-pagamento\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-cf63-75d9-94e6-8611d57d849b/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376704,\n \"formatted\": \"13/10/2025 - 14:31:44\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-cf63-75d9-94e6-8611d57d849b/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376705,\n \"formatted\": \"13/10/2025 - 14:31:45\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-cf63-75d9-94e6-8611d57d849b/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376706,\n \"formatted\": \"13/10/2025 - 14:31:46\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SVRS2510020917\",\n \"cOrgao\": \"35\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de Evento Processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SVRS2510020917\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110001\",\n \"nSeqEvento\": \"1\",\n \"CPFDest\": \"00000000000\",\n \"dhRegEvento\": \"2025-10-13T14:31:46-03:00\",\n \"nProt\": \"335250000002298\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-cf63-75d9-94e6-8611d57d849b/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376706,\n \"formatted\": \"13/10/2025 - 14:31:46\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:31:45-03:00\",\n \"tpEvento\": \"110001\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Cancelamento de Evento\",\n \"cOrgaoAutor\": \"35\",\n \"verAplic\": \"SVRS2510020917\",\n \"tpEventoAut\": \"112110\",\n \"nProtEvento\": \"335250000002297\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1100013525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"ijnF1+dCYe1laNaKWxV+sVPCZ9s=\",\n \"_URI\": \"#ID1100013525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"kZwOh7HwSl8cuQL5sNIJ1UEjIxLzj3jCgiSkjsDPEGIgwtyeOOZRr8GEeRVAGMs5xp/A7ObV/yH5gRt5ubBUJUXplrUzj/0iBmdm/o+bxT6A4mhOBcIFVbuQhJLgX2/kHDiFW0L5Uk5TCmcz52l55RqsRYfgSE7hRdBhAGlcX+LXRHERgg/17JsfWiSncfUAcoaM5VMpKrtxt7IiVChS6Af2imk0rXN0EeCPUfX7d7Za9ebXo7OzgN+VW2BTBDh9qW3n4wK9V0p1qjtBrpQNVSWLh+aZ1/TU8p0bqmbEUvPA3P7BRJbuurq6EAwHpa4Hhbo1WdHJxysXODczQGsnpA==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SVRS2510020917\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110001\",\n \"nSeqEvento\": \"1\",\n \"CPFDest\": \"00000000000\",\n \"dhRegEvento\": \"2025-10-13T14:31:46-03:00\",\n \"nProt\": \"335250000002298\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376704,\n \"formatted\": \"13/10/2025 - 14:31:44\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"PROTOCOL_QUERY\",\n \"label\": \"Consulta de Protocolo\",\n \"requestId\": \"0199dea0-eaf7-71a2-9489-def87af64c70\",\n \"remoteId\": \"teste-consulta-protocolo\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-eaf7-71a2-9489-def87af64c70/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376711,\n \"formatted\": \"13/10/2025 - 14:31:51\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-eaf7-71a2-9489-def87af64c70/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376717,\n \"formatted\": \"13/10/2025 - 14:31:57\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea0-eaf7-71a2-9489-def87af64c70/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376718,\n \"formatted\": \"13/10/2025 - 14:31:58\"\n },\n \"data\": {\n \"versao\": \"4.00\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\",\n \"cUF\": \"35\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"protNFe\": {\n \"infProt\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_NFE_PL009_V4\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhRecbto\": \"2025-10-13T14:07:44-03:00\",\n \"nProt\": \"135250007853422\",\n \"digVal\": \"8h3bf4gqs72ujtTfWDqB+E3LKpc=\",\n \"cStat\": \"100\",\n \"xMotivo\": \"Autorizado o uso da NF-e\"\n },\n \"_versao\": \"4.00\"\n },\n \"retCancNFe\": null,\n \"procEventoNFe\": [\n {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:08:00-03:00\",\n \"tpEvento\": \"110110\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Carta de Correcao\",\n \"xCorrecao\": \"Teste de carta de correcao\",\n \"xCondUso\": \"A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1101103525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"LlYp48+Oxg3yW+qOR4by5aUrbeE=\",\n \"_URI\": \"#ID1101103525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"Quk+v+4b7vSNGKnMrSM+goxFRSiZFkrq4FErM3yts61G5cUe8284sL09UEw5WyP9QV85pDO7pRizG+392mV42Yr+HpkKV3GWR+ELd6wc2M5ZmF+aWkYVkQ6Wo5SGEZ2fo/InNUCrLWnUANBsI/0gVQ7o6+J/WREvgD5YZmktFT5JLP8p9AQf1CLHQ3XLPFKdO52CHcoZwfg5uTXSXwS/y/1H7AHsWzZIXVxhan9gPz8Ar0YQ3Ix3dP1WSw1+fL+JxPmCE+oUzm7HhWJhNH++wC7M5sbkKZawy6frUH43cxBSHtZ+QPhM5xHzc6kHmEremvTdHCDyX0CkhDfmEejC1Q==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:08:01-03:00\",\n \"nProt\": \"135250007853428\"\n },\n \"_versao\": \"1.00\"\n },\n \"_versao\": \"1.00\"\n },\n {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:30:52-03:00\",\n \"tpEvento\": \"110110\",\n \"nSeqEvento\": \"2\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Carta de Correcao\",\n \"xCorrecao\": \"Teste de carta de correcao\",\n \"xCondUso\": \"A Carta de Correcao e disciplinada pelo paragrafo 1o-A do art. 7o do Convenio S/N, de 15 de dezembro de 1970 e pode ser utilizada para regularizacao de erro ocorrido na emissao de documento fiscal, desde que o erro nao esteja relacionado com: I - as variaveis que determinam o valor do imposto tais como: base de calculo, aliquota, diferenca de preco, quantidade, valor da operacao ou da prestacao; II - a correcao de dados cadastrais que implique mudanca do remetente ou do destinatario; III - a data de emissao ou de saida.\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1101103525105722815000017455139000000046185100305402\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"JmsZVB6HvKkn/FllXeau9OExzbY=\",\n \"_URI\": \"#ID1101103525105722815000017455139000000046185100305402\"\n }\n },\n \"SignatureValue\": \"P1HvlJ2WJIaXdWmhJf7Vq960fa6v8sJ1CAHWR6137/9wEMSk8Q5sP2GDLsptxSD4rdgQSLGRzguo1Pc3K0ikTouBKzLYqmM6NefGRpyHUjrpYM5cfSYMC78i1fO7I1GABBufa2Gdx0pI3ZFZVc6Wr7S3ZOFZrLalse/ietQdK84L3KA9dLinBBfcFiyQEPFRC8vyGLuaYpOsWuQK4aomTEbtb+g4JHA7FeCAfpKleFb98y1A05QBf5DAs9Q2j/PEkZayfp27R3ZfhDcMCZtmafKQyFHA4KIJasnSOSC3IkdHYKKsZoBQcb3aHdzTb79M5n0i/Vd8y44hcchk2ykFEA==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110110\",\n \"xEvento\": \"Carta de Correção registrada\",\n \"nSeqEvento\": \"2\",\n \"CNPJDest\": \"57228150000174\",\n \"dhRegEvento\": \"2025-10-13T14:30:53-03:00\",\n \"nProt\": \"135250007854024\"\n },\n \"_versao\": \"1.00\"\n },\n \"_versao\": \"1.00\"\n }\n ]\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376711,\n \"formatted\": \"13/10/2025 - 14:31:51\"\n },\n \"lastStatus\": true\n },\n {\n \"type\": \"CANCELLATION\",\n \"label\": \"Cancelamento\",\n \"requestId\": \"0199dea1-0834-72e0-a413-fd3843da245d\",\n \"remoteId\": \"teste-cancelamento-normal\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"source\": \"API\",\n \"status\": {\n \"description\": \"AUTHORIZED\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\"\n },\n \"events\": [\n {\n \"type\": \"INCOMING_REQUEST\",\n \"label\": \"Requisição recebida\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea1-0834-72e0-a413-fd3843da245d/incoming-request?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376719,\n \"formatted\": \"13/10/2025 - 14:31:59\"\n }\n },\n {\n \"type\": \"SEFAZ_REQUEST\",\n \"label\": \"Requisição para SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea1-0834-72e0-a413-fd3843da245d/generated-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376720,\n \"formatted\": \"13/10/2025 - 14:32:00\"\n }\n },\n {\n \"type\": \"SEFAZ_RESPONSE\",\n \"label\": \"Resposta da SEFAZ\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea1-0834-72e0-a413-fd3843da245d/sefaz-ret-xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376720,\n \"formatted\": \"13/10/2025 - 14:32:00\"\n },\n \"data\": {\n \"idLote\": \"1\",\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"128\",\n \"xMotivo\": \"Lote de Evento Processado\",\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110111\",\n \"xEvento\": \"Cancelamento registrado\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"emailDest\": \"modelo@modelo.com\",\n \"dhRegEvento\": \"2025-10-13T14:32:00-03:00\",\n \"nProt\": \"135250007854045\"\n },\n \"_versao\": \"1.00\"\n }\n }\n },\n {\n \"type\": \"XML\",\n \"label\": \"XML\",\n \"file\": \"https://api-homologation.omnitax.ai/invoices/download/0199dea1-0834-72e0-a413-fd3843da245d/xml?tpEmis=1\",\n \"createdAt\": {\n \"epoch\": 1760376720,\n \"formatted\": \"13/10/2025 - 14:32:00\"\n },\n \"raw\": {\n \"procEventoNFe\": {\n \"evento\": {\n \"infEvento\": {\n \"cOrgao\": \"35\",\n \"tpAmb\": \"2\",\n \"CNPJ\": \"57228150000174\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"dhEvento\": \"2025-10-13T14:32:00-03:00\",\n \"tpEvento\": \"110111\",\n \"nSeqEvento\": \"1\",\n \"verEvento\": \"1.00\",\n \"detEvento\": {\n \"descEvento\": \"Cancelamento\",\n \"nProt\": \"135250007853422\",\n \"xJust\": \"Teste de cancelamento normal\",\n \"_versao\": \"1.00\"\n },\n \"_Id\": \"ID1101113525105722815000017455139000000046185100305401\"\n },\n \"Signature\": {\n \"SignedInfo\": {\n \"CanonicalizationMethod\": {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n },\n \"SignatureMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#rsa-sha1\"\n },\n \"Reference\": {\n \"Transforms\": {\n \"Transform\": [\n {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#enveloped-signature\"\n },\n {\n \"_Algorithm\": \"http://www.w3.org/TR/2001/REC-xml-c14n-20010315\"\n }\n ]\n },\n \"DigestMethod\": {\n \"_Algorithm\": \"http://www.w3.org/2000/09/xmldsig#sha1\"\n },\n \"DigestValue\": \"FLBDB7otpslCQggapC2MgjJuukE=\",\n \"_URI\": \"#ID1101113525105722815000017455139000000046185100305401\"\n }\n },\n \"SignatureValue\": \"NS6jU3pJgZeyFSv/KzX2ljo/BmKj0pOISXr88XrpyZo++pdWlHMVaohMSxuKsTH7W2DhtnJqcFJHww/YXvWspB90y08FQvMT/Td/VSa0IekIxxej3XecCHGgF1OAJgOH79oY2KVRkb0ZDf+MyISV8LNsYTg4bSwG/k/kMTwIUIgcBZIaemP9fRMwujdMf5pIKRYGUnLSSi2FE1A31bgjDO0e6LLodq7YvH38ZrfrKTGefwwxDOHLuuriZ3YgmpUwMU0e5ADQWVBlTW4q84qg74xelHYyKFCB4QSjRb+HS9Oc95ApCf7Fb4utba4mKO3IOpK43VvN7HyTrCtNH8+q6g==\",\n \"KeyInfo\": {\n \"X509Data\": {\n \"X509Certificate\": \"MIIHXzCCBUegAwIBAgIMf+gFN/qmLm0FX5qzMA0GCSqGSIb3DQEBCwUAMIGLMQswCQYDVQQGEwJCUjETMBEGA1UECgwKSUNQLUJyYXNpbDE7MDkGA1UECwwyU2VydmljbyBGZWRlcmFsIGRlIFByb2Nlc3NhbWVudG8gZGUgRGFkb3MgLSBTRVJQUk8xKjAoBgNVBAMMIUF1dG9yaWRhZGUgQ2VydGlmaWNhZG9yYSBQUk9DRVJUSTAeFw0yNTA5MTAxNDU0MzFaFw0yNjA5MTAxNDU0MzFaMIIBAjELMAkGA1UEBhMCQlIxCzAJBgNVBAgMAlNQMRIwEAYDVQQHDAlTQU8gUEFVTE8xEzARBgNVBAoMCklDUC1CcmFzaWwxGTAXBgNVBAsMEHZpZGVvY29uZmVyZW5jaWExFzAVBgNVBAsMDjA1NDQxNjQ5MDAwMTYxMRswGQYDVQQLDBJQZXNzb2EgSnVyaWRpY2EgQTExFDASBgNVBAsMC0FSUFJPTk9WQUNEMSowKAYDVQQLDCFBdXRvcmlkYWRlIENlcnRpZmljYWRvcmEgUFJPQ0VSVEkxKjAoBgNVBAMMIU1HSlggQ09NRVJDSU8gTFREQTo1NzIyODE1MDAwMDE3NDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKcU7hjRfS0sh2mLVEH58XVXJyjszVqPYigL4xHnbEPQV+XOe4mRkWxVq3+l2ZN2MNiP3QCw7GdnU7KHOJCOAVcW4amvapZwT0BFTngpzx72yP6UqzZD8eUooae91wvvm5bqRdfG0e3fI62QE4n2g8J2fZFUL6v7xqz81RvRzILyVrxHMRCcVVLPjwqpqZmmyri7EYmtTImJWply0K89rgZ/2Ny+ye6gg0PLcvssXgQdq9uopxvGCufHD72Oup/lgDxxp2vC3r3fyUgDZ3M1WEd9+/A3+QDjm6CFZhVxr5pLNR/uW11hCCdEmFr6msKrVgQSKhQgcd/IDA6trJ4Ca7kCAwEAAaOCAkcwggJDMB8GA1UdIwQYMBaAFKnEHc+p7mj5AG7CrPsiRWpn5X72MA4GA1UdDwEB/wQEAwIF4DBaBgNVHSAEUzBRME8GBmBMAQIBfjBFMEMGCCsGAQUFBwIBFjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9kb2NzL2RwY2FjcHJvY2VydGkucGRmMIG7BgNVHREEgbMwgbCgOAYFYEwBAwSgLwQtMTgwNzE5ODkwNjkxNTQ0MzYwNjAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwoCQGBWBMAQMCoBsEGUpVTElBTkEgR0lPVkFOSU5JIE1BUlRJTlOgGQYFYEwBAwOgEAQONTcyMjgxNTAwMDAxNzSgFwYFYEwBAwegDgQMMDAwMDAwMDAwMDAwgRpqdWxpYW5hLm1hcnRpbnNAbmV4YWFzLmNvbTAdBgNVHSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwQwgYEGA1UdHwR6MHgwOaA3oDWGM2h0dHA6Ly9yZXBvc2l0b3Jpby5zZXJwcm8uZ292LmJyL2xjci9hY3Byb2NlcnRpLmNybDA7oDmgN4Y1aHR0cDovL2NlcnRpZmljYWRvczIuc2VycHJvLmdvdi5ici9sY3IvYWNwcm9jZXJ0aS5jcmwwUwYIKwYBBQUHAQEERzBFMEMGCCsGAQUFBzAChjdodHRwOi8vcmVwb3NpdG9yaW8uc2VycHJvLmdvdi5ici9jYWRlaWFzL2FjcHJvY2VydGkucDdiMA0GCSqGSIb3DQEBCwUAA4ICAQB9TxFrwOONv02wLOQqgGmvkVVOiYbMe6tC6xAnnRXCKq+CJfYvSqAuZhv9SRjGDQKvJLZCQcNrhHptKWJwionpXoOPJOnh4NX3wo4hmpt9U/LfxrxDfSgBvzcXI+DpAy6D+He8FqNm6kW/+F3Dy80vkQKQ9CgLd2x7GoZ0+OL01yf7fsBFAVXC55nlQUwXY1V5sZGivq40p30Z7puKFDQtu4mGGlSWF8SzmfCZoEtw/+j7Q/mJ7XShgLXGW7oRuL1L2hbapOwSfgLmi33h1i0vL8hUWC3y7phHdeGSAvloKN8Ff5W58dwUq8OfQSRmBllrS/QXH5t0ShqLSvFcOBKgsoMlNHEnusFvug4V1A7V9eLzVwTW6/I8kzRNER8g/L8KkxFBNZzqzcqnH+gML8+TFNO6IbjH+FX5QM6gin72IU6ZClvaPpiCgN0ierKhg5RdBMrblO4AVKV92BjY3OJZ4NcS073mSWLQ3XuLtUeFIRpzlZ61kgdFrb9CkBFT6ia3r0G4EGWRw5eWYpL2Wg2Mg7qGT4ZQBYkFzRMDlCVPggdgzeE0irZ3/gGphG2nYTGHWqPG0vD7b0IibrkxvmUfmT7HUQt0ZXPyijuvI5gLJ4/Prk0Cf1vKjvB9HWB9vNpTPXvAHYuWeJK7IWfJ/ezxa8lC2L1Dakt/I/Hxk7Navw==\"\n }\n },\n \"_xmlns\": \"http://www.w3.org/2000/09/xmldsig#\"\n },\n \"_versao\": \"1.00\",\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\"\n },\n \"retEvento\": {\n \"infEvento\": {\n \"tpAmb\": \"2\",\n \"verAplic\": \"SP_EVENTOS_PL_100\",\n \"cOrgao\": \"35\",\n \"cStat\": \"135\",\n \"xMotivo\": \"Evento registrado e vinculado a NF-e\",\n \"chNFe\": \"35251057228150000174551390000000461851003054\",\n \"tpEvento\": \"110111\",\n \"xEvento\": \"Cancelamento registrado\",\n \"nSeqEvento\": \"1\",\n \"CNPJDest\": \"57228150000174\",\n \"emailDest\": \"modelo@modelo.com\",\n \"dhRegEvento\": \"2025-10-13T14:32:00-03:00\",\n \"nProt\": \"135250007854045\"\n },\n \"_versao\": \"1.00\"\n },\n \"_xmlns\": \"http://www.portalfiscal.inf.br/nfe\",\n \"_versao\": \"1.00\"\n }\n }\n }\n ],\n \"createdAt\": {\n \"epoch\": 1760376719,\n \"formatted\": \"13/10/2025 - 14:31:59\"\n },\n \"lastStatus\": true\n }\n ],\n \"emitSubsidiary\": {\n \"id\": \"0196aae7-4c37-757d-b2ef-f7ca03eb5930\",\n \"requestId\": \"0196aae7-4a7c-7241-a589-93805ad68a1b\",\n \"remoteId\": \"edson-teste-subsidiary\",\n \"enabled\": true,\n \"transactions\": [\n \"SERIE\",\n \"TERMINAL\",\n \"INVOICE\"\n ],\n \"createdAt\": {\n \"epoch\": 1746624007,\n \"formatted\": \"07/05/2025 - 10:20:07\"\n },\n \"updatedAt\": {\n \"epoch\": 1760003717,\n \"formatted\": \"09/10/2025 - 06:55:17\"\n },\n \"identification\": {\n \"federalDocument\": \"57228150000174\",\n \"xNome\": \"MGJX COMERCIO LTDA\",\n \"xFant\": \"MGJX COMERCIO LTDA\",\n \"nire\": null,\n \"email\": \"teste@teste.com.br\",\n \"fone\": \"1199999999\",\n \"website\": \"teste.com.br\",\n \"openingDate\": {\n \"epoch\": 1743547752,\n \"formatted\": \"01/04/2025 - 19:49:12\"\n },\n \"closingDate\": null,\n \"headquarters\": true\n },\n \"address\": {\n \"cep\": \"04552000\",\n \"xLgr\": \"Rua do Rocio\",\n \"nro\": \"199\",\n \"xCpl\": \"10 andar\",\n \"xBairro\": \"Vila Olimpia\",\n \"cMun\": \"3550308\",\n \"xMun\": \"SAO PAULO\",\n \"cUF\": \"35\",\n \"xUF\": \"SAO PAULO\",\n \"UF\": \"SP\",\n \"Pais\": \"BRA\",\n \"cPais\": \"1058\",\n \"xPais\": \"BRAZIL\"\n },\n \"company\": {\n \"id\": \"0196aae5-9569-74ff-b068-dc42e86f4bf5\",\n \"requestId\": \"0196aae5-94d8-702e-bfc2-b8b784913bd5\",\n \"remoteId\": \"edson-teste-company\",\n \"enabled\": true,\n \"transactions\": [\n \"SUBSIDIARY\",\n \"PARTICIPANT\",\n \"SETTING\"\n ],\n \"createdAt\": {\n \"epoch\": 1746623895,\n \"formatted\": \"07/05/2025 - 10:18:15\"\n },\n \"updatedAt\": {\n \"epoch\": 1758395850,\n \"formatted\": \"20/09/2025 - 16:17:30\"\n },\n \"federalDocument\": \"57228150\",\n \"name\": \"MGJX COMERCIO LTDA\",\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 0,\n \"account\": {\n \"id\": \"0196a25e-d1cf-7499-b73f-033bafe62a3a\",\n \"requestId\": \"0196a25e-d1bd-73ee-a587-7207f83fa200\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"RULES_BASE\",\n \"COMPANY\",\n \"PROFILE\"\n ],\n \"createdAt\": {\n \"epoch\": 1746480845,\n \"formatted\": \"05/05/2025 - 18:34:05\"\n },\n \"updatedAt\": {\n \"epoch\": 1760113521,\n \"formatted\": \"10/10/2025 - 13:25:21\"\n },\n \"name\": \"MGJX\",\n \"companiesTotal\": 2,\n \"usersTotal\": 1,\n \"images\": {\n \"logoUrl\": \"https://homologation-images.omnitax.ai/accounts/0196a25e-d1cf-7499-b73f-033bafe62a3a/logo-conta-modelo-sa-1746480845266.png\",\n \"iconUrl\": \"https://homologation-images.omnitax.ai/accounts/0196a25e-d1cf-7499-b73f-033bafe62a3a/icon-conta-modelo-sa-1746480845266.png\"\n },\n \"whitelabel\": {\n \"id\": \"0196a24f-0bca-7599-b00f-70882344a185\",\n \"requestId\": \"0196a24f-0bbc-7026-a0b3-710e403dbd9b\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"SETTING\",\n \"ACCOUNT\",\n \"PROFILE\"\n ],\n \"createdAt\": {\n \"epoch\": 1746479811,\n \"formatted\": \"05/05/2025 - 18:16:51\"\n },\n \"updatedAt\": {\n \"epoch\": 1759772343,\n \"formatted\": \"06/10/2025 - 14:39:03\"\n },\n \"name\": \"Stratax\",\n \"domain\": \"app-hml.stratax.com.br\",\n \"accountsTotal\": 10,\n \"usersTotal\": 1\n }\n }\n },\n \"stateTaxes\": [\n {\n \"taxPayer\": {\n \"code\": \"1\",\n \"description\": \"CONTRIBUINTE COM INSCRICAO\"\n },\n \"typeTaxPayer\": {\n \"code\": \"0\",\n \"description\": \"NORMAL\"\n },\n \"stateDocument\": \"150810656117\",\n \"UF\": \"SP\",\n \"suframa\": null,\n \"crtEspecial\": [\n {\n \"code\": \"027\",\n \"description\": \"ISSQN - MICROEMPRESARIO E EMPRESA DE PEQUENO PORTE (ME EPP)\"\n }\n ],\n \"cscId\": null,\n \"cscToken\": null,\n \"startDate\": {\n \"epoch\": 1743547918,\n \"formatted\": \"01/04/2025 - 19:51:58\"\n },\n \"endDate\": null\n }\n ]\n },\n \"destSubsidiary\": {\n \"id\": \"0196aae7-4c37-757d-b2ef-f7ca03eb5930\",\n \"requestId\": \"0196aae7-4a7c-7241-a589-93805ad68a1b\",\n \"remoteId\": \"edson-teste-subsidiary\",\n \"enabled\": true,\n \"transactions\": [\n \"SERIE\",\n \"TERMINAL\",\n \"INVOICE\"\n ],\n \"createdAt\": {\n \"epoch\": 1746624007,\n \"formatted\": \"07/05/2025 - 10:20:07\"\n },\n \"updatedAt\": {\n \"epoch\": 1760003717,\n \"formatted\": \"09/10/2025 - 06:55:17\"\n },\n \"identification\": {\n \"federalDocument\": \"57228150000174\",\n \"xNome\": \"MGJX COMERCIO LTDA\",\n \"xFant\": \"MGJX COMERCIO LTDA\",\n \"nire\": null,\n \"email\": \"teste@teste.com.br\",\n \"fone\": \"1199999999\",\n \"website\": \"teste.com.br\",\n \"openingDate\": {\n \"epoch\": 1743547752,\n \"formatted\": \"01/04/2025 - 19:49:12\"\n },\n \"closingDate\": null,\n \"headquarters\": true\n },\n \"address\": {\n \"cep\": \"04552000\",\n \"xLgr\": \"Rua do Rocio\",\n \"nro\": \"199\",\n \"xCpl\": \"10 andar\",\n \"xBairro\": \"Vila Olimpia\",\n \"cMun\": \"3550308\",\n \"xMun\": \"SAO PAULO\",\n \"cUF\": \"35\",\n \"xUF\": \"SAO PAULO\",\n \"UF\": \"SP\",\n \"Pais\": \"BRA\",\n \"cPais\": \"1058\",\n \"xPais\": \"BRAZIL\"\n },\n \"company\": {\n \"id\": \"0196aae5-9569-74ff-b068-dc42e86f4bf5\",\n \"requestId\": \"0196aae5-94d8-702e-bfc2-b8b784913bd5\",\n \"remoteId\": \"edson-teste-company\",\n \"enabled\": true,\n \"transactions\": [\n \"SUBSIDIARY\",\n \"PARTICIPANT\",\n \"SETTING\"\n ],\n \"createdAt\": {\n \"epoch\": 1746623895,\n \"formatted\": \"07/05/2025 - 10:18:15\"\n },\n \"updatedAt\": {\n \"epoch\": 1758395850,\n \"formatted\": \"20/09/2025 - 16:17:30\"\n },\n \"federalDocument\": \"57228150\",\n \"name\": \"MGJX COMERCIO LTDA\",\n \"subsidiariesTotal\": 1,\n \"usersTotal\": 0,\n \"account\": {\n \"id\": \"0196a25e-d1cf-7499-b73f-033bafe62a3a\",\n \"requestId\": \"0196a25e-d1bd-73ee-a587-7207f83fa200\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"RULES_BASE\",\n \"COMPANY\",\n \"PROFILE\"\n ],\n \"createdAt\": {\n \"epoch\": 1746480845,\n \"formatted\": \"05/05/2025 - 18:34:05\"\n },\n \"updatedAt\": {\n \"epoch\": 1760113521,\n \"formatted\": \"10/10/2025 - 13:25:21\"\n },\n \"name\": \"MGJX\",\n \"companiesTotal\": 2,\n \"usersTotal\": 1,\n \"images\": {\n \"logoUrl\": \"https://homologation-images.omnitax.ai/accounts/0196a25e-d1cf-7499-b73f-033bafe62a3a/logo-conta-modelo-sa-1746480845266.png\",\n \"iconUrl\": \"https://homologation-images.omnitax.ai/accounts/0196a25e-d1cf-7499-b73f-033bafe62a3a/icon-conta-modelo-sa-1746480845266.png\"\n },\n \"whitelabel\": {\n \"id\": \"0196a24f-0bca-7599-b00f-70882344a185\",\n \"requestId\": \"0196a24f-0bbc-7026-a0b3-710e403dbd9b\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"SETTING\",\n \"ACCOUNT\",\n \"PROFILE\"\n ],\n \"createdAt\": {\n \"epoch\": 1746479811,\n \"formatted\": \"05/05/2025 - 18:16:51\"\n },\n \"updatedAt\": {\n \"epoch\": 1759772343,\n \"formatted\": \"06/10/2025 - 14:39:03\"\n },\n \"name\": \"Stratax\",\n \"domain\": \"app-hml.stratax.com.br\",\n \"accountsTotal\": 10,\n \"usersTotal\": 1\n }\n }\n },\n \"stateTaxes\": [\n {\n \"taxPayer\": {\n \"code\": \"1\",\n \"description\": \"CONTRIBUINTE COM INSCRICAO\"\n },\n \"typeTaxPayer\": {\n \"code\": \"0\",\n \"description\": \"NORMAL\"\n },\n \"stateDocument\": \"150810656117\",\n \"UF\": \"SP\",\n \"suframa\": null,\n \"crtEspecial\": [\n {\n \"code\": \"027\",\n \"description\": \"ISSQN - MICROEMPRESARIO E EMPRESA DE PEQUENO PORTE (ME EPP)\"\n }\n ],\n \"cscId\": null,\n \"cscToken\": null,\n \"startDate\": {\n \"epoch\": 1743547918,\n \"formatted\": \"01/04/2025 - 19:51:58\"\n },\n \"endDate\": null\n }\n ]\n }\n }\n}"},{"id":"61716594-31d2-426a-9146-ff985a5786ca","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/{requestId, remoteId, chNFe}?xmlFormatResponse=JSON&metadata=false","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["invoices","{requestId, remoteId, chNFe}"],"query":[{"key":"xmlFormatResponse","value":"JSON","description":"JSON or XML"},{"key":"metadata","value":"false","description":"If \"xmlFormatResponse\" equals JSON, inform false or true"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"},{"id":"8bc02f33-9676-49a2-a218-f78192a57c2a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/{requestId, remoteId, chNFe}?xmlFormatResponse=JSON&metadata=false","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["invoices","{requestId, remoteId, chNFe}"],"query":[{"key":"xmlFormatResponse","value":"JSON","description":"JSON or XML"},{"key":"metadata","value":"false","description":"If \"xmlFormatResponse\" equals JSON, inform false or true"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"4621c220-c49a-4226-9b81-b5acec87ed38","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/invoices/{requestId, remoteId, chNFe}?xmlFormatResponse=JSON&metadata=false","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["invoices","{requestId, remoteId, chNFe}"],"query":[{"key":"xmlFormatResponse","value":"JSON","description":"JSON or XML"},{"key":"metadata","value":"false","description":"If \"xmlFormatResponse\" equals JSON, inform false or true"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"46083d6e-f85c-40a8-a2de-49cd0c25a8eb"}],"id":"d03b7e51-3b53-4ad2-9297-9eab30479999","description":"

Subsidiaries accredited as issuers of invoices can perform invoice authorizations for any document model supported by the platform, as well as their cancellation, correction and disabling events in a single endpoint. What changes is the event code:

To \"authorize\" an invoice you must send an event code equal to \"999998\". The document model must be informed in the body of the request payload.
\n
For \"correction\" of an invoice you must send event code equal to \"110110\". It is only allowed to correct a document model equal to 55 - NF-e.
\n
To \"cancel\" an invoice you must send an event code equal to \"110111\" (for normal cancellation) or \"110112\" (for replacement cancellation). Cancellation by substitution is only allowed if the document model is equal to 65 - NFC-e and the type of issue (tpEmis) is equal to 1 - Normal.
\n
For “manifestation” of an invoice as its recipient, you must send an event code equal to “210210” (aware), “210200” (realized), “210220” (unknown) or “210240” (unrealized). Manifestation events are only allowed if the document model is equal to 55 - NF-e and each manifestation event will only be allowed once, so the last one will be the definitive one.
\n
To \"disable\" an invoice number, you must send an event code equal to \"999999\" (Disablement). Disablement events are only allowed if the invoice number is no longer usable.
\n

Before making a call to this endpoint, it is mandatory (i) to have the company registered with a valid digital certificate; (ii) have the subsidiary registered with correct CNPJ and IE data and (iii) have the issue series registered with the subsidiary.

\n","_postman_id":"d03b7e51-3b53-4ad2-9297-9eab30479999"}],"id":"261600f9-2c6b-4999-8882-989ddf7aa186","description":"

Subsidiaries registered on the platform can manage, in a single location, all tax documents issued by them or by third parties against them. The invoice module offers endless possibilities for customers who wish to centrally manage all their electronic tax documents. Before using it, check if:

There is already a registered company with a valid digital certificate;
\n
There is already a subsidiary registered in this company;
\n
There are already tax issuance series registered in this subsidiary;
\n
There is already a terminal registered in this subsidiary. In this case, only if you are going to use the Agent SDK installed locally in your software (e.g. POS, ERP, etc.).
\n

\n","_postman_id":"261600f9-2c6b-4999-8882-989ddf7aa186"},{"name":"rules engine","item":[{"name":"bases","item":[{"name":"rule base","id":"d54398f8-18aa-4adf-90bd-30f74a318777","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"required, boolean\",\n \"label\": \"required, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{accountId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
accountId	This is the accountId where your rule base will be registered. It is required, must be a string, and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases","{accountId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"9e0ea808-8537-4ca0-87df-44f08d2451af","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"required, boolean\",\n \"label\": \"required, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{accountId}"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Rule base registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"b0d0f00a-6be9-47b5-82a3-b84c3b0dd145","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"required, boolean\",\n \"label\": \"required, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{accountId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"label\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"7da43031-3821-4a61-8e35-caf8420e9851","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"required, boolean\",\n \"label\": \"required, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{accountId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"64c08cc2-9d1f-4044-8703-ff1b89bd0fea","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"required, boolean\",\n \"label\": \"required, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{accountId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"a6cf9ecf-e363-429a-a7d8-cc665a08ddf7","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"required, boolean\",\n \"label\": \"required, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{accountId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"accountId\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"}],"_postman_id":"d54398f8-18aa-4adf-90bd-30f74a318777"},{"name":"rule base (list)","id":"2e411dda-22dd-48e8-9b00-8cba4ba6d3c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases?page=1&limit=50&sort=asc&orderBy&q","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, label, createdAt, updatedAt, enabled

\n","type":"text/plain"},"key":"orderBy","value":null},{"description":{"content":"

Search by: baseId, label

\n","type":"text/plain"},"key":"q","value":null}],"variable":[]}},"response":[{"id":"fd625951-b117-44a6-afa1-f9c4b0597803","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases?page=1&limit=50&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {}\n ]\n}"},{"id":"dfb8ea15-083f-4e92-9743-a7fa920bae70","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases?page=1&limit=50&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"abcfe768-ea9c-4aaf-b494-0d97f1ec5a70","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases?page=1&limit=50&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"2e411dda-22dd-48e8-9b00-8cba4ba6d3c2"},{"name":"rule base (detail)","id":"ad76fa87-8499-4618-a36e-080f86a3a224","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases","{baseId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"32aa0ef7-2267-4b09-92d8-e170aeadeb2a","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Account updated successfully\"\n}"},{"id":"9178204f-549a-4c3b-a037-4c542397395d","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"ded70055-b785-4db2-bfc9-a10a28bc7189","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"1fa7727b-cf7e-4033-92c9-c784554cd4b7","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"a4e271ba-4b4b-4bc6-8e15-19ccae2b3ec9"},{"name":"rule base","id":"25aaf00a-3305-48fc-ac1b-b71b3a115394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases","{baseId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"980445a0-469a-4ad5-973c-b3629ef06913","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Rule base removed successfully\"\n}"},{"id":"48715fa1-3a2a-4c11-86f4-8b67ba30c3e7","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"374d12df-f46c-4018-99ff-df067267e50a","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"3a9cbcdc-51e2-40d5-ba9c-7386179de929","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"25aaf00a-3305-48fc-ac1b-b71b3a115394"}],"id":"05bb461d-f480-44e7-95fa-76600efe280f","_postman_id":"05bb461d-f480-44e7-95fa-76600efe280f","description":""},{"name":"subscriptions","item":[{"name":"public bases (list)","id":"0f47df70-6024-4732-b373-e52c64ac2a39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/public?page=1&limit=50&sort=asc&orderBy&q","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases","public"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, label, createdAt, updatedAt, enabled

\n","type":"text/plain"},"key":"orderBy","value":null},{"description":{"content":"

Search by: baseId, label

\n","type":"text/plain"},"key":"q","value":null}],"variable":[]}},"response":[{"id":"d6d3abb8-b8d5-4977-af27-8de117f66069","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases?page=1&limit=50&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {}\n ]\n}"},{"id":"25b40334-248f-4a26-9039-6b65448ac94b","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases?page=1&limit=50&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"e5123066-f602-41ba-938a-695632c7e3e0","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases?page=1&limit=50&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"0f47df70-6024-4732-b373-e52c64ac2a39"},{"name":"subscribe","id":"70be9cfa-c56a-46f8-8849-9444d5cd8eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/subscribe/{baseId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
accountId	This is the accountId where your rule base will be registered. It is required, must be a string, and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","subscribe","{baseId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"e9234bc5-55c4-4cdc-bed9-a9a6d477f1b8","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/subscribe/{baseId}"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Subscriptions registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"6cf6f0f2-8a37-4139-bd09-85a41f05310b","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/subscribe/{baseId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"accountId\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"2f3d10f0-4957-4005-b2e3-68187432787e","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/subscribe/{baseId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"e12b9b97-990d-4022-b837-191956f855d1","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/subscribe/{baseId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"0f9da56c-907f-424b-b808-d3fcc93b2a53","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accountId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/subscribe/{baseId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"accountId\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"}],"_postman_id":"70be9cfa-c56a-46f8-8849-9444d5cd8eac"},{"name":"subscribe (list)","id":"2c0a2afd-f115-4099-ad7e-87fdb2f9c135","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/{baseId}?page=1&limit=10&sort=asc&orderBy&q","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases","subscribe","{baseId}"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"limit","value":"10"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, label, createdAt, updatedAt, enabled

\n","type":"text/plain"},"key":"orderBy","value":null},{"description":{"content":"

Search by: baseId, label

\n","type":"text/plain"},"key":"q","value":null}],"variable":[]}},"response":[{"id":"1e7ee89f-36c3-4ffc-b196-5b4bc6736c97","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/{baseId}?page=1&limit=10&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases","subscribe","{baseId}"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"10","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {}\n ]\n}"},{"id":"18261043-30ce-4962-adb7-87c80971a507","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/{baseId}?page=1&limit=10&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases","subscribe","{baseId}"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"10","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b861c6d9-ef9c-412f-9f31-aa9bf6b5e32d","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"logoBase64\": \"string\",\n \"iconBase64\": \"string\",\n \"headquarterAccountId\": \"string\",\n \"enabled\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/{baseId}?page=1&limit=10&sort=asc&orderBy&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["rules-engine","bases","subscribe","{baseId}"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"10","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":null,"description":"Order by: id, label, createdAt, updatedAt, enabled"},{"key":"q","value":null,"description":"Search by: baseId, label"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"2c0a2afd-f115-4099-ad7e-87fdb2f9c135"},{"name":"subscribe","id":"ef8e3a7b-1bcc-4e55-931f-0f7e12526ad5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"status\": \"APPROVED or DENIED\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/status/{subscriberId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases","subscribe","status","{subscriberId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"dbeac884-87bf-41d2-8aa5-9cb54ef765e2","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/status/{subscriberId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Account updated successfully\"\n}"},{"id":"ec9ba533-c1a3-481e-9692-c4c09e36122e","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/status/{subscriberId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"a88bccfc-09d6-430a-9f61-509ed1ac27be","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/status/{subscriberId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"722d7492-a6b5-4ea8-87e8-391ab2a99b23","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/subscribe/status/{subscriberId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"ef8e3a7b-1bcc-4e55-931f-0f7e12526ad5"},{"name":"subscribe","id":"3b81b39e-2fc0-4f51-87c9-3b8e7ca20139","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","bases","{baseId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"4825fa58-a7b9-4a07-b061-e344bd3bf217","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Rule base removed successfully\"\n}"},{"id":"906aea73-6383-4208-aef0-4ce602821266","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"55613385-20af-45f0-a464-f6c0db167082","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"b1230171-9c71-44ab-a79f-1a520bc98cce","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/bases/{baseId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"3b81b39e-2fc0-4f51-87c9-3b8e7ca20139"}],"id":"49e13eaa-ca4d-448a-962b-738842c7f78d","_postman_id":"49e13eaa-ca4d-448a-962b-738842c7f78d","description":""},{"name":"rules","item":[{"name":"rules","id":"6ddef05e-11a1-44d3-b693-372788538893","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"required, boolean\",\n \"label\": \"required, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
accountId	This is the accountId where your rule base will be registered. It is required, must be a string, and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","rules","{baseId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"289cbf04-45a9-4112-a7ac-8b6fa80901c4","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"onConflict\": \"optional, string\",\n \"validateVariables\": \"optional, boolean\",\n \"userEmail\": \"optional, string\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"keyWords\": [\n \"optional, string\"\n ],\n \"legalBase\": [\n {\n \"name\": \"optional, string\",\n \"url\": \"optional, string\"\n }\n ],\n \"custom\": [\n {\n \"variable\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ],\n \"conditions\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": [\n \"required (at least one), string\"\n ]\n }\n ],\n \"consequences\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": \"required (at least one), string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Rule base registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"0a5c901a-a5e6-4449-8790-cce3a038f300","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"onConflict\": \"optional, string\",\n \"validateVariables\": \"optional, boolean\",\n \"userEmail\": \"optional, string\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"keyWords\": [\n \"optional, string\"\n ],\n \"legalBase\": [\n {\n \"name\": \"optional, string\",\n \"url\": \"optional, string\"\n }\n ],\n \"custom\": [\n {\n \"variable\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ],\n \"conditions\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": [\n \"required (at least one), string\"\n ]\n }\n ],\n \"consequences\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": \"required (at least one), string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"label\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"3d62444f-d68c-40ec-a6c9-eed7543054ca","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"onConflict\": \"optional, string\",\n \"validateVariables\": \"optional, boolean\",\n \"userEmail\": \"optional, string\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"keyWords\": [\n \"optional, string\"\n ],\n \"legalBase\": [\n {\n \"name\": \"optional, string\",\n \"url\": \"optional, string\"\n }\n ],\n \"custom\": [\n {\n \"variable\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ],\n \"conditions\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": [\n \"required (at least one), string\"\n ]\n }\n ],\n \"consequences\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": \"required (at least one), string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"2bbac59d-0883-43b0-af85-e5e5aed53da2","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"onConflict\": \"optional, string\",\n \"validateVariables\": \"optional, boolean\",\n \"userEmail\": \"optional, string\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"keyWords\": [\n \"optional, string\"\n ],\n \"legalBase\": [\n {\n \"name\": \"optional, string\",\n \"url\": \"optional, string\"\n }\n ],\n \"custom\": [\n {\n \"variable\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ],\n \"conditions\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": [\n \"required (at least one), string\"\n ]\n }\n ],\n \"consequences\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": \"required (at least one), string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"c61410bb-76db-48c1-9cf6-93c3d213b5c9","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"onConflict\": \"optional, string\",\n \"validateVariables\": \"optional, boolean\",\n \"userEmail\": \"optional, string\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"keyWords\": [\n \"optional, string\"\n ],\n \"legalBase\": [\n {\n \"name\": \"optional, string\",\n \"url\": \"optional, string\"\n }\n ],\n \"custom\": [\n {\n \"variable\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ],\n \"conditions\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": [\n \"required (at least one), string\"\n ]\n }\n ],\n \"consequences\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": \"required (at least one), string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"accountId\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"},{"id":"f70b75df-cc5d-4787-a7a8-fe8de34acc03","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"startDate\": \"required, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"endDate\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"onConflict\": \"optional, string\",\n \"validateVariables\": \"optional, boolean\",\n \"userEmail\": \"optional, string\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"keyWords\": [\n \"optional, string\"\n ],\n \"legalBase\": [\n {\n \"name\": \"optional, string\",\n \"url\": \"optional, string\"\n }\n ],\n \"custom\": [\n {\n \"variable\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ],\n \"conditions\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": [\n \"required (at least one), string\"\n ]\n }\n ],\n \"consequences\": [\n {\n \"variable\": \"required (at least one), string\",\n \"value\": \"required (at least one), string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {}\n ]\n}"}],"_postman_id":"6ddef05e-11a1-44d3-b693-372788538893"},{"name":"rules (list)","id":"55492bce-b65d-4fb7-bbff-604d50658d42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/list","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","rules","{baseId}","list"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"418233c5-7593-4f17-804d-538d1d4af725","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 100,\n \"page\": 1,\n \"filters\": [\n {\n \"name\": \"NFe.infNFe.emit.enderEmit.UF\",\n \"values\": [\n \"optional, string\"\n ]\n },\n {\n \"name\": \"NFe.infNFe.emit.CRT\",\n \"values\": [\n \"optional, string\"\n ]\n },\n {\n \"name\": \"NFe.infNFe.det.prod.CFOP\",\n \"values\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {}\n ]\n}"},{"id":"2c99d463-550f-4d40-8455-d2e84f82be43","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 100,\n \"page\": 1,\n \"filters\": [\n {\n \"name\": \"NFe.infNFe.emit.enderEmit.UF\",\n \"values\": [\n \"optional, string\"\n ]\n },\n {\n \"name\": \"NFe.infNFe.emit.CRT\",\n \"values\": [\n \"optional, string\"\n ]\n },\n {\n \"name\": \"NFe.infNFe.det.prod.CFOP\",\n \"values\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"dd357bd4-970d-4141-92ed-9d839890d92d","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"limit\": 100,\n \"page\": 1,\n \"filters\": [\n {\n \"name\": \"NFe.infNFe.emit.enderEmit.UF\",\n \"values\": [\n \"optional, string\"\n ]\n },\n {\n \"name\": \"NFe.infNFe.emit.CRT\",\n \"values\": [\n \"optional, string\"\n ]\n },\n {\n \"name\": \"NFe.infNFe.det.prod.CFOP\",\n \"values\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/list"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"55492bce-b65d-4fb7-bbff-604d50658d42"},{"name":"rules (detail)","id":"acfbc583-806e-4556-8c70-8c60e15715e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","rules","{baseId}","{rulesId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"5a15c0ad-2bac-4e96-802d-bfe150f5dbf5","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Account updated successfully\"\n}"},{"id":"e83b1129-35cb-4535-8586-cbc16a456cba","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"8fe78d08-48ac-4ae0-9c15-3335fe1a26e2","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"742b27d7-488c-4935-9011-a72f44ef10c6","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"remoteId\": \"optional, string\",\n \"public\": \"optional, boolean\",\n \"label\": \"optional, string\",\n \"userEmail\": \"optional, string\",\n \"standard\": [\n {\n \"attribute\": \"optional, string\",\n \"name\": \"optional, string\",\n \"description\": \"optional, string\",\n \"value\": \"optional, string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"fd1bd347-e77b-4062-8b50-d835fb3c8230"},{"name":"rules","id":"c0522760-312f-450d-8114-e9a82e0cc5cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","rules","{baseId}","{rulesId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"d8dd3c7f-664f-4b74-98ac-36d00917fbd9","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Rule base removed successfully\"\n}"},{"id":"5135d86e-903e-4ee1-9a65-de8f871cf140","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"cff6ae14-53b4-4d30-90d8-f9a473ff1caa","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"60e92193-a393-4b61-a0cc-23198dbd1956","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/rules/{baseId}/{rulesId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"c0522760-312f-450d-8114-e9a82e0cc5cc"}],"id":"7806b45f-a4f9-42b0-b11c-8d29d5d4abbf","_postman_id":"7806b45f-a4f9-42b0-b11c-8d29d5d4abbf","description":""},{"name":"evaluate (scenarios)","item":[{"name":"evaluate (scenarios)","id":"48df5886-b0a4-44a4-b5bf-23b70942537f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/evaluate","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Attribute`	`Details`
accountId	This is the accountId where your rule base will be registered. It is required, must be a string, and the entered content must be a valid UUID.
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
label	This is the label that identifies the rulebase. It is mandatory, it must be a string and the inserted content can't exceed 60 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["rules-engine","evaluate"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"ee8c34a2-d410-41de-947c-c97d3f5385ab","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"headers\": {\n \"type\": \"optional, string\",\n \"accountId\": \"optional, string\",\n \"remoteId\": \"optional, string\",\n \"terminalNumber\": \"só quando originar do agent\",\n \"date\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"singleObjectIn\": [\n \"NFe.infNFe.det.imposto.ICMS\",\n \"NFe.infNFe.det.imposto.ICMSUFDest\",\n \"NFe.infNFe.det.imposto.IPI\",\n \"NFe.infNFe.det.imposto.II\",\n \"NFe.infNFe.det.imposto.PIS\",\n \"NFe.infNFe.det.imposto.PISST\",\n \"NFe.infNFe.det.imposto.COFINS\",\n \"NFe.infNFe.det.imposto.COFINSST\",\n \"NFe.infNFe.det.imposto.ISSQN\",\n \"NFe.infNFe.det.imposto.IBSCBSSel\"\n ]\n },\n \"payload\": {\n \"scenario\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/evaluate"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Rule base registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"af39b801-169e-4a73-b1fb-a6e0bf8ea045","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"headers\": {\n \"type\": \"optional, string\",\n \"accountId\": \"optional, string\",\n \"remoteId\": \"optional, string\",\n \"terminalNumber\": \"só quando originar do agent\",\n \"date\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"singleObjectIn\": [\n \"NFe.infNFe.det.imposto.ICMS\",\n \"NFe.infNFe.det.imposto.ICMSUFDest\",\n \"NFe.infNFe.det.imposto.IPI\",\n \"NFe.infNFe.det.imposto.II\",\n \"NFe.infNFe.det.imposto.PIS\",\n \"NFe.infNFe.det.imposto.PISST\",\n \"NFe.infNFe.det.imposto.COFINS\",\n \"NFe.infNFe.det.imposto.COFINSST\",\n \"NFe.infNFe.det.imposto.ISSQN\",\n \"NFe.infNFe.det.imposto.IBSCBSSel\"\n ]\n },\n \"payload\": {\n \"scenario\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/evaluate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"label\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"3849bf46-8ddc-48d5-8266-c73a22095ba7","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"headers\": {\n \"type\": \"optional, string\",\n \"accountId\": \"optional, string\",\n \"remoteId\": \"optional, string\",\n \"terminalNumber\": \"só quando originar do agent\",\n \"date\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"singleObjectIn\": [\n \"NFe.infNFe.det.imposto.ICMS\",\n \"NFe.infNFe.det.imposto.ICMSUFDest\",\n \"NFe.infNFe.det.imposto.IPI\",\n \"NFe.infNFe.det.imposto.II\",\n \"NFe.infNFe.det.imposto.PIS\",\n \"NFe.infNFe.det.imposto.PISST\",\n \"NFe.infNFe.det.imposto.COFINS\",\n \"NFe.infNFe.det.imposto.COFINSST\",\n \"NFe.infNFe.det.imposto.ISSQN\",\n \"NFe.infNFe.det.imposto.IBSCBSSel\"\n ]\n },\n \"payload\": {\n \"scenario\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/evaluate"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"f06373c4-02f0-4844-99ee-8815529cba88","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"headers\": {\n \"type\": \"optional, string\",\n \"accountId\": \"optional, string\",\n \"remoteId\": \"optional, string\",\n \"terminalNumber\": \"só quando originar do agent\",\n \"date\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"singleObjectIn\": [\n \"NFe.infNFe.det.imposto.ICMS\",\n \"NFe.infNFe.det.imposto.ICMSUFDest\",\n \"NFe.infNFe.det.imposto.IPI\",\n \"NFe.infNFe.det.imposto.II\",\n \"NFe.infNFe.det.imposto.PIS\",\n \"NFe.infNFe.det.imposto.PISST\",\n \"NFe.infNFe.det.imposto.COFINS\",\n \"NFe.infNFe.det.imposto.COFINSST\",\n \"NFe.infNFe.det.imposto.ISSQN\",\n \"NFe.infNFe.det.imposto.IBSCBSSel\"\n ]\n },\n \"payload\": {\n \"scenario\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/evaluate"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"2f3ead5d-442a-41d9-99ec-aa2b1dfd88a7","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"headers\": {\n \"type\": \"optional, string\",\n \"accountId\": \"optional, string\",\n \"remoteId\": \"optional, string\",\n \"terminalNumber\": \"só quando originar do agent\",\n \"date\": \"optional, string and UTC format (YYYY-MM-DDThh:mm:ss.SSSZ)\",\n \"singleObjectIn\": [\n \"NFe.infNFe.det.imposto.ICMS\",\n \"NFe.infNFe.det.imposto.ICMSUFDest\",\n \"NFe.infNFe.det.imposto.IPI\",\n \"NFe.infNFe.det.imposto.II\",\n \"NFe.infNFe.det.imposto.PIS\",\n \"NFe.infNFe.det.imposto.PISST\",\n \"NFe.infNFe.det.imposto.COFINS\",\n \"NFe.infNFe.det.imposto.COFINSST\",\n \"NFe.infNFe.det.imposto.ISSQN\",\n \"NFe.infNFe.det.imposto.IBSCBSSel\"\n ]\n },\n \"payload\": {\n \"scenario\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/rules-engine/evaluate"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"accountId\",\n \"messages\": [\n \"Not found\"\n ]\n }\n ]\n}"}],"_postman_id":"48df5886-b0a4-44a4-b5bf-23b70942537f"}],"id":"5afb8812-4f39-4422-9fa1-5b124448357b","_postman_id":"5afb8812-4f39-4422-9fa1-5b124448357b","description":""}],"id":"730b4a9f-42a1-41fc-a9ea-4bc435744dde","description":"

Users use the Omnitax Platform rules engine to record business rules that can be consumed by people (via API or via user application) or software (via API or via SDK) in order to ensure compliance and operational governance in time real, both online and offline.

A practical example of using the rules engine happens when the user registers a rule defining which taxes should be calculated (and how they should be calculated) every time a certain commercial operation takes place. Thus, every time the predicted scenario happens, the ContabilOne Platform rule engine will automatically assign the tax defined in the rule by the user who created it. A rule, therefore, can be understood as a logical entity that defines what must be done if a certain scenario happens.

To register a rule, it is necessary to have access to an account (\"accountId\") previously registered on the platform and this account must have at least one \"rules base\" (portfolio where rules are placed) registered. Each account can simultaneously manage up to 3 rule base versions, but only one of them can be effectively in use as a current base. When registering a rule, you can determine in which rule base (\"baseId\") it will be registered. If you do not indicate the base, the rule will be registered in the base that is in use (current base). For security reasons, removing the current rule base is not allowed.

When registering a rule, it is possible that the platform rejects your request because it understands that there is a conflict with another rule already registered in the same rule base of your account. This conflict will be determined when (i) the validity period (\"startDate\" and \"endDate\"), (ii) the condition variables (\"conditions\") and (iii) base (\"baseId\") of the new rule are equal to the another existing rule. If there is a conflict, the platform will return an HTTP status code \"409 - Conflict\" informing the conflicting rule ID, which indicates that it will be necessary to resolve the conflict to register the new rule. You can resolve the conflict by defining a new rule base for your new rule, deleting the conflicting rule, or ending the old rule's lifetime. It is also possible to resolve the conflict automatically by informing the variable \"onConflict\" with the value \"replace\" in the payload for creating the new rule. By doing so, the platform will automatically eliminate the conflict using the date and time of the event as the final validity (\"endDate\") of the old rule and initial validity (\"startDate') of the new rule, ignoring the \"startDate\" (mandatory) entered in the rule registration payload. Thus, the two rules will remain registered, each with an expiration date.

Every rule must have at least one \"condition\" and one \"consequence\". The conditions serve to indicate in which business scenario the application of the rule will be evaluated. The more conditions, the more specific the rule. The \"consequences\", in turn, serve to determine the result of applying the rule.

To inform the \"conditions\" of a rule, it is necessary to declare a valid \"variable\" name (existing in the platform), a valid \"operator\" (currently we only accept \"equals\") and a list of possible \"values\" for this variable always as an array of strings. The reading of the conditions will always be of type \"and\", that is, variable \"A\" and variable \"B\", etc. Note some examples:

Example of how to enter conditions in a rule creation payload:

{\n    \"conditions\": [\n        {\n            \"variable\": \"NFe.infNFe.emit.enderEmit.UF\",\n            \"operator\": \"equals\",\n            \"value\": [\n                \"002\"\n            ]\n        },\n        {\n            \"variable\": \"NFe.infNFe.det.prod.NCM\",\n            \"operator\": \"equals\",\n            \"value\": [\n                \"84715010\",\n                \"6301*\"\n            ]\n        }\n    ],\n    \"consequences\": []\n}\n\n

To inform the \"consequences\" of a rule, it is necessary to declare a valid \"variable\" name (existing on the platform) and its respective \"value\", which must be unique, not a list. The reading of the consequences will also be of type \"and\", that is, variable \"A\" and variable \"B\", etc. The values assigned to the consequence variables can be informed explicitly or through an expression based on ContabilOne's own syntax, with infinite possibilities. Note some examples:

Example of a consequence variable whose value was explicitly determined. This expression should read: The value of the variable \"NFe.infNFe.det.prod.CFOP\" will be \"6551\".

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.det.prod.CFOP\",\n            \"value\": \"6551\"\n        }\n    ]\n}\n\n

Example of a consequence variable whose value was explicitly determined, but with content with so many special characters that it is difficult to define where the string begins and ends. Precisely for this reason, strings must be surrounded by single quotes (') and, if single quotes (') or double quotes (\") are informed within the content of the expression, the number of necessary escapes (\\) must be inserted, as example below, specifically in the words \"PROCON-RJ\" (1st escape) and 'CONDECON' (2nd escape).

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.infAdic.infCpl\",\n            \"value\": \"'Tributos Aprox. 0.00 (Lei Federal 12.741/2012) Fonte:IBPT \\\"PROCON-RJ\\\": tel. 151 End. Av. Rio Branco, 25 - 5 andar, Centro/RJ. \\\\'CODECON\\\\': tel. 0800 282 7060 End. R. da Alfandega, 8 - Centro/RJ)'\"\n        }\n    ]\n}\n\n

Example of a consequence variable whose value was determined by an expression referring to the value declared in another existing variable (i) in the payload of the scenario request that will be evaluated or (ii) in the rule that will be applied to it. If it is not possible to find the value of the referenced variable, \"0\" or \"0%\" will be assigned, in the case of percentages. This expression should read: The value of the variable \"NFe.infNFe.det.imposto.ICMS.ICMS10.orig\" (referring) will be the same value declared in the variable \"NFe.infNFe.det.imposto.ICMS.orig\" ( referenced).

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.det.imposto.ICMS.ICMS10.orig\",\n            \"value\": \"NFe.infNFe.det.imposto.ICMS.orig\"\n        }\n    ]\n}\n\n

Example of consequence variable whose value was determined by an expression of conditional existence of a certain variable in the payload of the scenario request that will be evaluated. The reading of this expression should be: The value of the variable \"NFe.infNFe.dest.indIEDest\" will be \"9\" if the variable \"NFe.infNFe.dest.CPF\" is informed in the payload of the scenario request that will be evaluated or will be \" null\" if the variable \"NFe.infNFe.dest.CPF\" is not informed in the payload of the scenario request that will be evaluated.

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.dest.indIEDest\",\n            \"value\": \"EXISTS(NFe.infNFe.dest.CPF):9:null\"\n        }\n    ]\n}\n\n

Example of a consequence variable whose value was determined by a simple mathematical expression. This expression should read: The value of the variable \"NFe.infNFe.det.imposto.ICMS.ICMS10.vICMS\" will be the result of multiplying the values declared in the variables \"NFe.infNFe.det.imposto.ICMS.ICMS10.vBC \" and \"NFe.infNFe.det.imposto.ICMS.ICMS10.pICMS\".

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.det.imposto.ICMS.ICMS10.vICMS\",\n            \"value\": \"(NFe.infNFe.det.imposto.ICMS.ICMS10.vBC*NFe.infNFe.det.imposto.ICMS.ICMS10.pICMS)\"\n        }\n    ]\n}\n\n

Example of a consequence variable whose value was determined by a conditional mathematical expression. The reading of this expression should be: The value of the variable \"NFe.infNFe.det.prod.vProd\" will be 81.19 if the value of the variable \"NFe.infNFe.det.prod.vUnCom\" informed in the payload of the scenario request that will be evaluated is less than or equal to 81.19 or it will be the result of multiplying the values declared in the variables \"NFe.infNFe.det.prod.vUnCom\" and \"NFe.infNFe.det.prod.qCom\" if the value of the variable \"NFe.infNFe. det.prod.vUnCom\" informed in the payload of the scenario request that will be evaluated is greater than 81.19.

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.det.prod.vProd\",\n            \"value\": \"NFe.infNFe.det.prod.vUnCom<=81.19:81.19:(NFe.infNFe.det.prod.vUnCom*NFe.infNFe.det.prod.qCom)\"\n        }\n    ]\n}\n\n

Example of a consequence variable whose value was determined by an expression that defines the number of decimals and rounding of numeric values. The reading of this expression should be: The value of the variable \"NFe.infNFe.det.prod.vUnCom\" will be the value informed in the payload of the scenario request, which will be evaluated rounded to 4 decimals. Thus, if the value entered in the request payload has more decimals than specified in the rule, the number will be rounded to the 4 decimals defined in the rule (Example: if the value entered is 12.34526456, it will be transformed into 12.3453). If the value entered in the request payload has fewer decimals than specified in the rule, the number of decimals will be increased to the 4 decimals defined in the rule by adding zeros to the right (Example: if the value entered is 12.34, it will be transformed at 12.3400).

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.det.prod.vUnCom\",\n            \"value\": \"FIXED(NFe.infNFe.det.prod.vUnCom,4)\"\n        }\n    ]\n}\n\n

Example of a consequence variable whose value was determined by a more complex expression that features existence functions, number of decimals and rounding, and simple math. This expression should read: The value of the variable \"NFe.infNFe.det.prod.vProd\" will be the result of multiplying the values declared in the variables \"NFe.infNFe.det.prod.vUnCom\" and \"NFe.infNFe.det .prod.qCom\" rounded to 6 decimals only if the variable \"NFe.infNFe.det.prod.vUnCom\" is informed in the payload of the calculation request. Otherwise, the value of the variable \"NFe.infNFe.det.prod.vProd\" will be 81.19 rounded to 6 decimals.

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.det.prod.vProd\",\n            \"value\": \"EXISTS(NFe.infNFe.det.prod.vUnCom): FIXED(NFe.infNFe.det.prod.vUnCom*NFe.infNFe.det.prod.qCom,6: FIXED(81.19,6)\"\n        }\n    ]\n}\n\n

Example of a consequence variable whose value was determined by a more complex expression that features conditional math functions, number of decimal places and rounding, and simple math. This expression should read: The value of the variable \"NFe.infNFe.det.prod.vProd\" will be the result of multiplying the values declared in the variables \"NFe.infNFe.det.prod.vUnCom\" and \"NFe.infNFe.det .prod.qCom\" rounded to 6 decimals only if the variable \"NFe.infNFe.det.prod.vUnCom\" informed in the payload of the calculation request has a value less than or equal to 81.19. Otherwise, the value of the variable \"NFe.infNFe.det.prod.vProd\" will be 81.19 rounded to 6 decimals.

{\n    \"conditions\": [],\n    \"consequences\": [\n        {\n            \"variable\": \"NFe.infNFe.det.prod.vProd\",\n            \"value\": \"NFe.infNFe.det.prod.vUnCom<=81.19: FIXED(NFe.infNFe.det.prod.vUnCom*NFe.infNFe.det.prod.qCom,6: FIXED(81.19,6)\"\n        }\n    ]\n}\n\n

Summary about the Rules Engine:

It is necessary to have a registered account to be able to register a rule;
\n
It is necessary to have at least one rule base registered in the account to be able to register a rule;
\n
It is necessary to use condition and consequence variables provided in the platform. If you need to create your own variable to suit your business, request it via suporte@contabilone.com;
\n
It is necessary to use dot ( . ) to separate decimal places of numbers. Example: \"1978.54\" (One thousand, nine hundred and seventy-eight integers and fifty-four decimals);
\n
It is necessary to use a colon ( : ) to separate arguments from conditional expressions \"(\"condition\" : \"if_true\" : \"if_false\") \", where: If the is true, what is in will be executed, if otherwise, what is in will be executed;
\n
It is necessary to use single quotation marks ( ' ), with escape ( \\ ) when necessary to represent strings. Example: \"'Sale of \\'Wine\\' Sweet'\";
\n
It is necessary to use the null constant (without quotes, as it is not a string), to indicate that a certain consequence must be excluded;
\n
It is allowed to use FIXED(), to determine the amount of decimals and, consequently, rounding, required in the function's second argument;
\n
It is allowed to use EXISTS() only in conditional expressions when you want to determine that the mere existence of a variable in the request payload should be considered as a function argument;
\n
It is allowed to use simple arithmetic operators ( +, -, *, / ) and organize compound expressions using parentheses. Example: (1 + 2) * 3 + (5 - 3);
\n
It is allowed to use comparison operators in conditional expressions. The available operators are: = (equal to), == (terms are considered strings), > (greater than), >= (greater than or equal to), < (less than), <= (less than or equal to) , != (different). It is worth highlighting the difference between = and ==: Using the =, values like 01 and 1 will be considered equal (since mathematically they are really equal). Using ==, values such as 01 and 1 will be considered different, as the form of the value is taken into account;
\n
Whenever possible, previous validations will detect errors that will prevent the registration of rules, the main ones being:
\n
- Detection of conflict with another existing rule in the same rule base of the account;
  \n
- Detection of incorrect expressions due to:
  \n
  - Wrong sequence of operators. Example: 5 */ 6
    \n
  - Wrong conditional construction. Example: 2 > 0 :: or :::
    \n
  - Function or operator does not exist. Example: 2 $ 2 or ABC(2,1)
    \n
  - Incorrect number of function arguments. Example: FIXED(12.43) or FIXED(15.21, 3, 4)
    \n
  - Wrong type in function argument. Example: FIXED('test', 5)
    \n
  - Missing parentheses. Example: (1+2
    \n
  - Cyclic references (variable calling itself)
    \n
  \n
- Detection of errors in the declaration of consequence attributes:
  \n
  - Conditional obligation: If a certain attribute becomes required due to the existence of another;
    \n
  - Conditional prohibition: If a given attribute becomes prohibited due to the existence of another;
    \n
  - Content: If the value entered for the attribute is valid and respects the regular expression of the public model used.
    \n
  \n
\n

If you still have questions, please contact us at suporte@contabilone.com.

\n","_postman_id":"730b4a9f-42a1-41fc-a9ea-4bc435744dde"},{"name":"webhooks","item":[{"name":"webhooks/resources (list)","id":"3a9c521b-9b19-422a-b2ca-bc3a3be8c06e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks","resources"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of item per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by label field

\n","type":"text/plain"},"key":"orderBy","value":"label"},{"description":{"content":"

Filter by: \"whitelabel\" or \"account\"

\n","type":"text/plain"},"key":"entityType","value":"account"}],"variable":[]}},"response":[{"id":"b0f1f364-f50f-42ef-8e04-c409a0384218","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks","resources"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"label","description":"Order by label field"},{"key":"entityType","value":"account","description":"Filter by: \"whitelabel\" or \"account\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"ea6a7c99-b049-42a2-81a4-8c8f470c1015","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks","resources"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"label","description":"Order by label field"},{"key":"entityType","value":"account","description":"Filter by: \"whitelabel\" or \"account\""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"c814f9bc-fee0-4cc2-9346-c7a76993023d","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/resources?page=1&limit=50&sort=asc&orderBy=label&entityType=account","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks","resources"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"label","description":"Order by label field"},{"key":"entityType","value":"account","description":"Filter by: \"whitelabel\" or \"account\""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"3a9c521b-9b19-422a-b2ca-bc3a3be8c06e"},{"name":"webhooks","id":"9045af5c-7b7b-4006-9b00-c7c90a374f0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Field`	`Details`
authType	The webhook type is required, and its value can be: API_KEY, BEARER_TOKEN, CUSTOM, or OAUTH_2.
whitelabelId	This is the whitelabelId where your webhook will be registered. It is optional, must be a string and the content entered must be a valid UUID
accountId	This is the accountId where your webhook will be registered. It is conditional, that is, it should only be informed if the token used in the call is not the token of the account itself, but of the domain to which it belongs. It must be a string and the content inserted must be a valid UUID
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
name	This is the name that best identifies the registered webhook. It is optional, must be a string and the content inserted must not exceed 60 characters
payloadUrl	This is the address (endpoint) where the webhook event will be sent. It is mandatory, must be a string and the content entered must not exceed 120 characters
contentType	This is the type of format sent in the \"Content-Type\" header where the possible values are \"JSON\" which is the default and will be sent in the webhook delivery request with the \"application/json\" header, or FORM which will use the \"application/x-www-form-urlencoded\" header in the request. It is optional, must be a string and the inserted content must not exceed 4 characters.
secret	This is the secret key to be signed and added to the \"Omnitax-Signature\" header in the Webhook request to validate that the request is coming from the Omintax server. It is optional, must be a string and the inserted content must not exceed 100 characters
authScheme	This is the HTTP authentication scheme registry. IANA maintains a list of authentication schemes, but there are other schemes offered by host services, such as Amazon AWS. Some common authentication schemes include: Basic, Bearer, Concealed, Digest, HOBA, Mutual, Negotiate / NTLM, VAPID, SCRAM, AWS4-HMAC-SHA256. It is optional, must be a string and the inserted content must not exceed 20.
token	This is the token that the webhook uses to authenticate the client API to send the request. It is optional, must be a string and the content inserted must not exceed 255 characters
tokenCustomHeaderName	This is the custom name of the header sent in the request for the token field. E.g. \"api-token\": \"TOKEN\", the default used if not specified is \"X-Api-Key\". It is optional, must be a string and the inserted content must not exceed 255 characters
formatResponse	This is the format configured for the payload that will be sent by the webhook: XML or JSON (default). It is optional, must be a string and the inserted content must be \"XML\" or \"JSON\"
oauth2Configuration.accessTokenUrl	OAuth2 acess token URL is an optional field, it must be a string.
oauth2Configuration.clientId	OAuth2 client identification token is an optional field, it must be a string.
oauth2Configuration.clientSecret	OAuth2 client secret token is an optional field, it must be a string.
resources[].label	This is the name of the Omnitax resource whose event can be sent via webhook (e.g. invoice, rules engine, accounting, subsidiary). It is mandatory, must be a string and the content provided must exist in the list of available resources obtained in \"GET/webhooks/resources\"
resources[].actions[]	This is the name of the Omnitax resource event that can be sent via webhook (e.g. invoice authorization, invoice cancellation). It is mandatory, must be a array of string and the content provided must exist in the list of available resources obtained in \"GET/webhooks/resources\"

","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"276269e4-8814-4ecb-82cd-86a5048a798c","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"required, string\",\n \"whitelabelId\": \"optional, string\",\n \"accountId\": \"conditional, string\",\n \"remoteId\": \"optional, string\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"required, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\":\"optional, string\",\n \"clientId\":\"optional, string\",\n \"clientSecret\":\"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Webhook registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"750f4ae8-7e05-4942-b7ab-8282480b8f93","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"required, string\",\n \"whitelabelId\": \"optional, string\",\n \"accountId\": \"conditional, string\",\n \"remoteId\": \"optional, string\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"required, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\":\"optional, string\",\n \"clientId\":\"optional, string\",\n \"clientSecret\":\"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"payloadUrl\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"f22fefce-1a94-41a0-af85-89c5f100f78c","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"required, string\",\n \"whitelabelId\": \"optional, string\",\n \"accountId\": \"conditional, string\",\n \"remoteId\": \"optional, string\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"required, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\":\"optional, string\",\n \"clientId\":\"optional, string\",\n \"clientSecret\":\"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"32033547-e8f7-450f-8059-648f6bc13068","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"required, string\",\n \"whitelabelId\": \"optional, string\",\n \"accountId\": \"conditional, string\",\n \"remoteId\": \"optional, string\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"required, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\":\"optional, string\",\n \"clientId\":\"optional, string\",\n \"clientSecret\":\"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"dbfc909c-c316-4cab-9674-0dafbf861f11","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"required, string\",\n \"whitelabelId\": \"optional, string\",\n \"accountId\": \"conditional, string\",\n \"remoteId\": \"optional, string\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"required, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\":\"optional, string\",\n \"clientId\":\"optional, string\",\n \"clientSecret\":\"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"required, string\",\n \"actions\": [\n \"required, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"payloadUrl\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"9045af5c-7b7b-4006-9b00-c7c90a374f0e"},{"name":"webhooks (list)","id":"4a6e3e31-6686-4e76-a5ea-b61d62bdfa9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{BACK_OFFICE_X_API_KEY}}","type":"text"},{"key":"Authorization","value":"{{AUTH_SCHEME}} {{AUTH_TOKEN}}","type":"text"},{"key":"Origin","value":"{{HOST}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=id&accountId=id&q=","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of item per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, name, createdAt or updatedAt

\n","type":"text/plain"},"key":"orderBy","value":"createdAt"},{"description":{"content":"

Filter by: whitelabelId

\n","type":"text/plain"},"key":"whitelabelId","value":"id"},{"description":{"content":"

Filter by: accountId

\n","type":"text/plain"},"key":"accountId","value":"id"},{"description":{"content":"

Search by: id, requestId, remoteId, whitelabel (id or name) or account (id or name)

\n","type":"text/plain"},"key":"q","value":""}],"variable":[]}},"response":[{"id":"2f3ad290-ccd3-4584-b9cf-78db3219430a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"yjSWnlN3Jtxj5OdJA8uAc9ZDzvV09sSg","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=id&accountId=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: id, name, createdAt or updatedAt"},{"key":"whitelabelId","value":"id","description":"Filter by: whitelabelId"},{"key":"accountId","value":"id","description":"Filter by: accountId"},{"key":"q","value":"","description":"Search by: id, requestId, remoteId, whitelabel (id or name) or account (id or name)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1745931033,\n \"formatted\": \"29/04/2025 - 09:50:33\"\n },\n \"updatedAt\": {\n \"epoch\": 1748551143,\n \"formatted\": \"29/05/2025 - 17:39:03\"\n },\n \"enabled\": true,\n \"authType\": \"\",\n \"name\": \"\",\n \"payloadUrl\": \"\",\n \"transactions\": [\n \"\"\n ],\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1748525871,\n \"formatted\": \"29/05/2025 - 10:37:51\"\n },\n \"updatedAt\": {\n \"epoch\": 1749068273,\n \"formatted\": \"04/06/2025 - 17:17:53\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 0,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1742822257,\n \"formatted\": \"24/03/2025 - 10:17:37\"\n },\n \"updatedAt\": {\n \"epoch\": 1748525871,\n \"formatted\": \"29/05/2025 - 10:37:51\"\n },\n \"name\": \"Test Whitelabel\",\n \"domain\": null,\n \"accountsTotal\": 5,\n \"usersTotal\": 0\n }\n },\n \"whitelabel\": null\n }\n ],\n \"totalItems\": 1\n}"},{"id":"b5bc4eb9-6265-495f-8f08-4b16f307602d","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=id&accountId=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: id, name, createdAt or updatedAt"},{"key":"whitelabelId","value":"id","description":"Filter by: whitelabelId"},{"key":"accountId","value":"id","description":"Filter by: accountId"},{"key":"q","value":"","description":"Search by: id, requestId, remoteId, whitelabel (id or name) or account (id or name)"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"004efb10-a73d-4c49-932c-94aca6a42a94","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=id&accountId=id&q=","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks"],"query":[{"key":"page","value":"1","description":"required, number"},{"key":"limit","value":"50","description":"required, number, limited 50 per page"},{"key":"sort","value":"asc","description":"optional, \"asc\" or \"desc\""},{"key":"orderBy","value":"createdAt","description":"optional, per \"name\", \"createdAt\", \"updatedAt\""},{"key":"whitelabelId","value":"id","description":"optional, per whitelabelId"},{"key":"accountId","value":"id","description":"optional, per accountId"},{"key":"q","value":"","description":"optional, per requestId ou remoteId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"4a6e3e31-6686-4e76-a5ea-b61d62bdfa9f"},{"name":"webhooks (detail)","id":"1b41f21a-cc99-4098-8180-25d4264326d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks","{webhookId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"fad3ef86-2749-4191-9018-8abf002e45fd","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1749070217,\n \"formatted\": \"04/06/2025 - 17:50:17\"\n },\n \"updatedAt\": {\n \"epoch\": 1749070414,\n \"formatted\": \"04/06/2025 - 17:53:34\"\n },\n \"authType\": \"\",\n \"name\": \"\",\n \"payloadUrl\": \"\",\n \"contentType\": \"\",\n \"secret\": null,\n \"authScheme\": \"\",\n \"token\": \"\",\n \"tokenCustomHeaderName\": \"\",\n \"formatResponse\": \"\",\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"whitelabel\": null,\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1748525871,\n \"formatted\": \"29/05/2025 - 10:37:51\"\n },\n \"updatedAt\": {\n \"epoch\": 1749068273,\n \"formatted\": \"04/06/2025 - 17:17:53\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 0,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1742822257,\n \"formatted\": \"24/03/2025 - 10:17:37\"\n },\n \"updatedAt\": {\n \"epoch\": 1748525871,\n \"formatted\": \"29/05/2025 - 10:37:51\"\n },\n \"name\": \"\",\n \"domain\": null,\n \"accountsTotal\": 5,\n \"usersTotal\": 0\n }\n },\n \"oauth2Configuration\": null\n }\n}"},{"id":"266b7bf4-89b5-41f4-8a8c-5759c7736734","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"fd25c5f7-e696-4bbd-b1be-78dd2b869b64","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"a7b8780f-3522-4098-b06c-172296bb09b1","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"1b41f21a-cc99-4098-8180-25d4264326d2"},{"name":"webhooks","id":"db4a17da-20b9-40f5-ad42-e9c9c864f93f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Field`	`Details`
authType	The webhook type is required, and its value can be: API_KEY, BEARER_TOKEN, CUSTOM, or OAUTH_2.
name	This is the name that best identifies the registered webhook. It is optional, must be a string and the content inserted must not exceed 60 characters.
payloadUrl	This is the address (endpoint) where the webhook event will be sent. It is required, must be a string and the content entered must not exceed 120 characters
contentType	This is the type of format sent in the \"Content-Type\" header where the possible values are \"JSON\" which is the default and will be sent in the webhook delivery request with the \"application/json\" header, or FORM which will use the \"application/x-www-form-urlencoded\" header in the request. It is optional, must be a string and the inserted content must not exceed 4 characters.
secret	This is the secret key to be signed and added to the \"Omnitax-Signature\" header in the Webhook request to validate that the request is coming from the Omintax server. It is optional, must be a string and the inserted content must not exceed 100 characters
authScheme	This is the HTTP authentication scheme registry. IANA maintains a list of authentication schemes, but there are other schemes offered by host services, such as Amazon AWS. Some common authentication schemes include: Basic, Bearer, Concealed, Digest, HOBA, Mutual, Negotiate / NTLM, VAPID, SCRAM, AWS4-HMAC-SHA256. It is optional, must be a string and the inserted content must not exceed 20.
token	This is the token that the webhook uses to authenticate the client API to send the request. It is optional, must be a string and the content inserted must not exceed 255 characters
tokenCustomHeaderName	This is the custom name of the header sent in the request for the token field. E.g. \"api-token\": \"TOKEN\", the default used if not specified is \"X-Api-Key\". It is optional, must be a string and the inserted content must not exceed 255 characters
formatResponse	This is the format configured for the payload that will be sent by the webhook: XML or JSON (default). It is optional, must be a string and the inserted content must be \"XML\" or \"JSON\"
enabled	This information defines whether resource is enabled to receive and process requests. It is optional, it must be a boolean and the informed content must be true or false
oauth2Configuration.accessTokenUrl	OAuth2 acess token URL is an optional field, it must be a string.
oauth2Configuration.clientId	OAuth2 client identification token is an optional field, it must be a string.
oauth2Configuration.clientSecret	OAuth2 client secret token is an optional field, it must be a string.
resources[].label	This is the name of the Omnitax resource whose event can be sent via webhook (e.g. invoice, rules engine, accounting, subsidiary). It is mandatory, must be a string and the content provided must exist in the list of available resources obtained in \"GET/webhooks/resources\"
resources[].actions[]	This is the name of the Omnitax resource event that can be sent via webhook (e.g. invoice authorization, invoice cancellation). It is mandatory, must be a array of string and the content provided must exist in the list of available resources obtained in \"GET/webhooks/resources\"

","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks","{webhookId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"adec0fcd-845f-4682-84c9-59bf322437c3","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"optional, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\":\"optional, string\",\n \"clientId\":\"optional, string\",\n \"clientSecret\":\"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Webhook updated successfully\"\n}"},{"id":"c4505496-f64a-4651-8474-4018081f895c","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"optional, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\": \"optional, string\",\n \"clientId\": \"optional, string\",\n \"clientSecret\": \"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"c94b3024-e13c-41c2-9df9-f13404c3faaf","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"optional, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\": \"optional, string\",\n \"clientId\": \"optional, string\",\n \"clientSecret\": \"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"11bfc185-0a80-41e2-bea9-e75a88e4a8e9","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"authType\": \"optional, string\",\n \"enabled\": \"optional, boolean\",\n \"name\": \"optional, string\",\n \"payloadUrl\": \"optional, string\",\n \"contentType\": \"optional, string\",\n \"secret\": \"optional, string\",\n \"authScheme\": \"optional, string\",\n \"token\": \"optional, string\",\n \"tokenCustomHeaderName\": \"optional, string\",\n \"formatResponse\": \"optional, string\",\n \"oauth2Configuration\": {\n \"accessTokenUrl\": \"optional, string\",\n \"clientId\": \"optional, string\",\n \"clientSecret\": \"optional, string\"\n },\n \"resources\": [\n {\n \"label\": \"optional, string\",\n \"actions\": [\n \"optional, string\"\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"db4a17da-20b9-40f5-ad42-e9c9c864f93f"},{"name":"webhooks","id":"75a47842-2e48-4001-9359-a276e7e7986f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks","{webhookId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"d4bdec81-d9f1-4e2a-a2ca-4a068f6120fe","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Webhook removed successfully\"\n}"},{"id":"83c73633-7826-40a8-b989-b93a6729eeaf","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"194f59c4-fe75-4f9a-b49d-51997282b072","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"c5531f3b-0265-4665-8d65-c7676e962be2","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/{webhookId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"75a47842-2e48-4001-9359-a276e7e7986f"},{"name":"webhooks/deliveries (list)","id":"bface274-0b91-44ea-bbbc-38d5112c02cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=whitelabelId&accountId=accountId&webhookId=webhookId&requestId=requestId&remoteId=remoteId","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks","deliveries"],"host":["{{API_DOMAIN}}"],"query":[{"description":{"content":"

Page where the search is located

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"limit","value":"50"},{"description":{"content":"

Sort by ascendant (asc) or decreasing (desc)

\n","type":"text/plain"},"key":"sort","value":"asc"},{"description":{"content":"

Order by: id, completedAt, status, createdAt or updatedAt

\n","type":"text/plain"},"key":"orderBy","value":"createdAt"},{"description":{"content":"

Filter by: whitelabel

\n","type":"text/plain"},"key":"whitelabelId","value":"whitelabelId"},{"description":{"content":"

Filter by: account

\n","type":"text/plain"},"key":"accountId","value":"accountId"},{"description":{"content":"

Filter by: webhookId

\n","type":"text/plain"},"key":"webhookId","value":"webhookId"},{"description":{"content":"

Filter by: requestId

\n","type":"text/plain"},"key":"requestId","value":"requestId"},{"description":{"content":"

Filter by: remoteId

\n","type":"text/plain"},"key":"remoteId","value":"remoteId"}],"variable":[]}},"response":[{"id":"313f947a-b65b-4f5e-8ece-9cd4e6573e0e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=whitelabelId&accountId=accountId&webhookId=webhookId&requestId=requestId&remoteId=remoteId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks","deliveries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: id, completedAt, status, createdAt or updatedAt"},{"key":"whitelabelId","value":"whitelabelId","description":"Filter by: whitelabel"},{"key":"accountId","value":"accountId","description":"Filter by: account"},{"key":"webhookId","value":"webhookId","description":"Filter by: webhookId"},{"key":"requestId","value":"requestId","description":"Filter by: requestId"},{"key":"remoteId","value":"remoteId","description":"Filter by: remoteId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"requestId\": \"\",\n \"createdAt\": {\n \"epoch\": 1744403792,\n \"formatted\": \"11/04/2025 - 17:36:32\"\n },\n \"updatedAt\": null,\n \"resource\": \"\",\n \"action\": \"\",\n \"completedAt\": {\n \"milliseconds\": 39,\n \"seconds\": 0.039,\n \"minutes\": 0.00065\n },\n \"status\": \"\",\n \"request\": {\n \"requestedAt\": {\n \"epoch\": 1744403792,\n \"formatted\": \"11/04/2025 - 17:36:32\"\n },\n \"url\": \"\"\n },\n \"response\": {\n \"responsedAt\": {\n \"epoch\": 1744403792,\n \"formatted\": \"11/04/2025 - 17:36:32\"\n },\n \"statusCode\": 200\n },\n \"webhook\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1744317214,\n \"formatted\": \"10/04/2025 - 17:33:34\"\n },\n \"updatedAt\": {\n \"epoch\": 1744403765,\n \"formatted\": \"11/04/2025 - 17:36:05\"\n },\n \"name\": \"\",\n \"payloadUrl\": \"\",\n \"contentType\": \"\",\n \"secret\": null,\n \"authScheme\": \"\",\n \"token\": \"\",\n \"tokenCustomHeaderName\": \"\",\n \"formatResponse\": \"\",\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": []\n },\n {\n \"label\": \"\",\n \"actions\": []\n }\n ],\n \"whitelabel\": null,\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1742957902,\n \"formatted\": \"25/03/2025 - 23:58:22\"\n },\n \"updatedAt\": {\n \"epoch\": 1744317071,\n \"formatted\": \"10/04/2025 - 17:31:11\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 0,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1742957398,\n \"formatted\": \"25/03/2025 - 23:49:58\"\n },\n \"updatedAt\": {\n \"epoch\": 1744319322,\n \"formatted\": \"10/04/2025 - 18:08:42\"\n },\n \"name\": \"\",\n \"domain\": null,\n \"accountsTotal\": 1,\n \"usersTotal\": 0\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"3bdbc41f-be08-4ce5-8528-4ec7448fee8a","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=whitelabelId&accountId=accountId&webhookId=webhookId&requestId=requestId&remoteId=remoteId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks","deliveries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: id, completedAt, status, createdAt or updatedAt"},{"key":"whitelabelId","value":"whitelabelId","description":"Filter by: whitelabel"},{"key":"accountId","value":"accountId","description":"Filter by: account"},{"key":"webhookId","value":"webhookId","description":"Filter by: webhookId"},{"key":"requestId","value":"requestId","description":"Filter by: requestId"},{"key":"remoteId","value":"remoteId","description":"Filter by: remoteId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"779e1241-8825-4b12-b26a-dfb111d82a45","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries?page=1&limit=50&sort=asc&orderBy=createdAt&whitelabelId=whitelabelId&accountId=accountId&webhookId=webhookId&requestId=requestId&remoteId=remoteId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["webhooks","deliveries"],"query":[{"key":"page","value":"1","description":"Page where the search is located"},{"key":"limit","value":"50","description":"Number of items per page"},{"key":"sort","value":"asc","description":"Sort by ascendant (asc) or decreasing (desc)"},{"key":"orderBy","value":"createdAt","description":"Order by: id, completedAt, status, createdAt or updatedAt"},{"key":"whitelabelId","value":"whitelabelId","description":"Filter by: whitelabel"},{"key":"accountId","value":"accountId","description":"Filter by: account"},{"key":"webhookId","value":"webhookId","description":"Filter by: webhookId"},{"key":"requestId","value":"requestId","description":"Filter by: requestId"},{"key":"remoteId","value":"remoteId","description":"Filter by: remoteId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"bface274-0b91-44ea-bbbc-38d5112c02cf"},{"name":"webhooks/deliveries (detail)","id":"8453a878-b530-46e7-bef7-d57a76c83692","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks","deliveries","{deliveryId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"d2c8782c-ee58-4bf8-b869-fe1184cd0023","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"createdAt\": {\n \"epoch\": 1744403792,\n \"formatted\": \"11/04/2025 - 17:36:32\"\n },\n \"updatedAt\": null,\n \"resource\": \"\",\n \"action\": \"\",\n \"completedAt\": {\n \"milliseconds\": 39,\n \"seconds\": 0.039,\n \"minutes\": 0.00065\n },\n \"status\": \"\",\n \"request\": {\n \"requestedAt\": {\n \"epoch\": 1744403792,\n \"formatted\": \"11/04/2025 - 17:36:32\"\n },\n \"headers\": {\n \"authorization\": \"\",\n \"content-type\": \"\",\n \"user-agent\": \"\"\n },\n \"method\": \"POST\",\n \"payload\": \"\",\n \"url\": \"\"\n },\n \"response\": {\n \"responsedAt\": {\n \"epoch\": 1744403792,\n \"formatted\": \"11/04/2025 - 17:36:32\"\n },\n \"headers\": {\n \"access-control-allow-origin\": \"*\",\n \"connection\": \"\",\n \"content-length\": \"\",\n \"content-type\": \"\",\n \"date\": \"\",\n \"etag\": \"\"\n },\n \"statusCode\": 200,\n \"payload\": \"!\"\n },\n \"webhook\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1744317214,\n \"formatted\": \"10/04/2025 - 17:33:34\"\n },\n \"updatedAt\": {\n \"epoch\": 1744403765,\n \"formatted\": \"11/04/2025 - 17:36:05\"\n },\n \"name\": \"\",\n \"payloadUrl\": \"\",\n \"contentType\": \"\",\n \"secret\": null,\n \"authScheme\": \"\",\n \"token\": \"\",\n \"tokenCustomHeaderName\": \"\",\n \"formatResponse\": \"\",\n \"resources\": [\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n },\n {\n \"label\": \"\",\n \"actions\": [\n \"\"\n ]\n }\n ],\n \"account\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [\n \"\",\n \"\"\n ],\n \"createdAt\": {\n \"epoch\": 1742957902,\n \"formatted\": \"25/03/2025 - 23:58:22\"\n },\n \"updatedAt\": {\n \"epoch\": 1744317071,\n \"formatted\": \"10/04/2025 - 17:31:11\"\n },\n \"name\": \"\",\n \"companiesTotal\": 1,\n \"usersTotal\": 0,\n \"whitelabel\": {\n \"id\": \"\",\n \"requestId\": \"\",\n \"remoteId\": null,\n \"enabled\": true,\n \"transactions\": [],\n \"createdAt\": {\n \"epoch\": 1742957398,\n \"formatted\": \"25/03/2025 - 23:49:58\"\n },\n \"updatedAt\": {\n \"epoch\": 1744319322,\n \"formatted\": \"10/04/2025 - 18:08:42\"\n },\n \"name\": \"Developer\",\n \"domain\": null,\n \"accountsTotal\": 1,\n \"usersTotal\": 0\n }\n }\n }\n }\n}"},{"id":"b1f08ce3-4353-48d7-89ce-78eab5c1d1d8","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"458a5cc8-28cb-4aa1-8b3e-384b63765451","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"f9d25ad7-07d2-4ac8-99b4-451e9aa35c06","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"8453a878-b530-46e7-bef7-d57a76c83692"},{"name":"webhooks/deliveries/redelivery","id":"bb4b22c8-8283-45f0-8274-46b9d2506c50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}/redeliver","urlObject":{"protocol":"{{PROTOCOL}}","path":["webhooks","deliveries","{deliveryId}","redeliver"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"cd7f7c91-c929-480a-80d2-10a09763f476","name":"202 Accepted","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}/redeliver"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Webhook delivery resent successfully\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"39c83b1f-ff78-444f-975d-11542b9bef9b","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}/redeliver"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Is required\"\n}"},{"id":"2f599365-7ec3-4bc8-8d4f-77e50715a119","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}/redeliver"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"445f18d3-0443-488a-b409-a707e1aaf99b","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}/redeliver"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"f4863ad6-beb2-417f-9fd4-a23204617e5b","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/webhooks/deliveries/{deliveryId}/redeliver"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"bb4b22c8-8283-45f0-8274-46b9d2506c50"}],"id":"41a6038d-3dc4-4e56-b82a-1c20a25ee6de","description":"

Users can register specific endpoints to receive messages via webhooks. These webhooks can be registered at the domain level or at the level of a specific account. It is also possible to register specific webhooks per resource (e.g. invoice, rules engine) or even per event type of a specific resource (e.g. invoice authorization events, invoice cancellation events).

\n","_postman_id":"41a6038d-3dc4-4e56-b82a-1c20a25ee6de"},{"name":"finances","item":[{"name":"transactions","item":[{"name":"transactions","id":"d2a452e1-0226-414e-9e60-48adf12eef7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Field`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
companyId	This is the companyId where your financial document will be registered. It is mandatory, must be a string and the content entered must be a valid UUID
payload.emit.federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ (Brazilian corporate tax ID), enter all 14 digits. If it is a CPF (Brazilian individual tax ID), enter all 11 digits. The federal identification document of the issuer or recipient of the document must be provided and must match the base CNPJ of the company where it is being registered.
payload.emit.xNome	This is the legal name by which the issuer of the financial document is recognized. It is optional, must be a string and cannot exceed 60 characters.
payload.emit.enderEmit.xLgr	This is the issuer address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.nro	This is the issuer address number. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.xBairro	This is the neighborhood of the issuer's address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.xCpl	This is the complement of the issuer address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.cMun	This is the IBGE code of the municipality of the issuer's address. It is optional and must be a string with a length of 7 characters.
payload.emit.enderEmit.xMun	This is the name of the municipality of the issuer's address. It is optional, must be a string and the length cannot exceed 60 characters.
payload.emit.enderEmit.UF	This is the abbreviation of the federation unit of the municipality of the issuer's address. It is optional, must be a string and the length must be 2.
payload.emit.enderEmit.CEP	This is the postal address box for the sender's address. It is optional, must be a string, and the length must be 8.
payload.emit.enderEmit.cPais	This is the country code of the issuer's address. It is optional, must be a string, and the length must be 2, 3, or 4.
payload.emit.enderEmit.xPais	This is the country name of the issuer's address. It is optional, must be a string, and the length cannot exceed 60 characters.
payload.emit.enderEmit.email	This is the issuer's contact email address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.fone	This is the issuer's contact phone number. It is optional, must be a string and cannot exceed 60 characters.
payload.dest.federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ (Brazilian corporate tax ID), enter all 14 digits. If it is a CPF (Brazilian individual tax ID), enter all 11 digits. The federal identification document of the issuer or recipient of the document must be provided and must match the base CNPJ of the company where it is being registered.
payload.dest.xNome	This is the legal name by which the recipient of the financial document is recognized. It is optional, must be a string and cannot exceed 60 characters.
payload.dest.enderDest.xLgr	This is the recipient address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.nro	This is the recipient address number. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.xBairro	This is the neighborhood of the recipient's address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.xCpl	This is the complement of the recipient address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.cMun	This is the IBGE code of the municipality of the recipient's address. It is optional and must be a string with a length of 7 characters.
payload.dest.enderDest.xMun	This is the name of the municipality of the recipient's address. It is optional, must be a string and the length cannot exceed 60 characters.
payload.dest.enderDest.UF	This is the abbreviation of the federation unit of the municipality of the recipient's address. It is optional, must be a string and the length must be 2.
payload.dest.enderDest.CEP	This is the postal address box for the recipient's address. It is optional, must be a string, and the length must be 8.
payload.dest.enderDest.cPais	This is the country code of the recipient's address. It is optional, must be a string, and the length must be 2, 3, or 4.
payload.dest.enderDest.xPais	This is the country name of the recipient's address. It is optional, must be a string, and the length cannot exceed 60 characters.
payload.dest.enderDest.email	This is the recipient's contact email address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.fone	This is the recipient's contact phone number. It is optional, must be a string and cannot exceed 60 characters.
payload.ide.nDoc	This is the unique identification number of the document that generated the financial event (invoice, contract, notes). It is optional, must be a sequence of characters and be between 1 and 60 in length.
payload.ide.dDoc	This is the date and time of generation of the document that generated the financial event (invoice, contract, notes). It is optional, must be a string and the content entered must be in UTC format.
payload.ide.dCompet	This is the period of competence of the document (period of transfer of the right or duty, regardless of whether there is actual financial movement). It is optional, must be a string and the content entered must be in the format MM/YYYY. If it is not entered, the platform will automatically assign the month of registration of the document as the period of competence.
payload.ide.description	This is a detailed description of the document.
payload.ide.finalidade	This is a purpose of the transaction that generated this financial document. If it is a document where your establishment is the recipient, it probably refers to the sale of some product or service. If it is a document where your establishment is the payer, it probably refers to the purchase of some product or service. In both cases, the purpose determines the reason for the sale (e.g. sale of training services) or the reason for the purchase (e.g. purchase of merchandise for resale, purchase of merchandise for use and consumption...). Suggestions for purpose can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=finalidade\"
payload.dup[].nDup	This is the unique identifier of the installment plan of the document that generated the financial event. It is optional, must be a string and the content entered must have up to 50 characters.
payload.dup[].dDup	This is the date the installment was generated. If not provided, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content provided must be in UTC format.
payload.dup[].dVenc	This is the installment payment due date. If not entered, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content entered must be in UTC format.
payload.dup[].vOrig	This is the original installment amount (before considering discounts and additions). It is mandatory, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vDesc	This is the value of the installment discount. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vJur	This is the interest value of the installment. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vMul	This is the amount of the installment fine. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].tPag	This is the installment payment type. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tPag\"
payload.dup[].pag.[].vPag	This is the total amount paid for the installment. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].xPag	This is the description that best identifies the payment type if the \"tPag\" attribute entered is equal to \"99\" (Others). It is optional, must be a string and be between 1 and 60 in length.
payload.dup[].pag.[].dPag	This is the date of the installment payment. If not informed, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content informed must be in UTC format.
payload.dup[].pag.[].CNPJPag	This is the federal document of jurisdiction under which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is optional and must be a string.
payload.dup[].pag.[].UFPag	This is the abbreviation of the federal unit of the jurisdiction over which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. It is optional and must be a string with length 2.
payload.dup[].pag.[].card.tpIntegra	This is the code for the payment method integration type. It is optional, must be a string and the value provided must be \"1\" (TEF) or \"2\" (POS).
payload.dup[].pag.[].card.CNPJ	Enter the federal document of the acquirer who authorized the electronic payment. It is optional, must be a sequence of characters and the amount entered must have 14 digits.
payload.dup[].pag.[].card.tBand	This is the type of card flag used for installment payments. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tBand\"
payload.dup[].pag.[].card.cAut	This is the payment authorization code generated by the acquirer who authorized the electronic payment. It is optional, must be a string and the value entered must be between 1 and 20 characters long.
payload.impostos.vCBS	This is the CBS value. It is optional, must be a number, and the information provided must contain up to 13 whole digits with 2 decimals.
payload.impostos.vIBS	This is the IBS value. It is optional, must be a number, and the information provided must contain up to 13 integer digits with 2 decimals.
payload.impostos.vIS	This is the IS value. It is optional, must be a number, and the information provided must contain up to 13 integer digits with 2 decimals.
payload.impostos.vISSRet	This is the amount of ISSQN retained. It is optional, must be a number and the content informed must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetPIS	This is the amount of PIS withheld. It is optional, it must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetCOFINS	This is the amount of COFINS withheld. It is optional, must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetCSLL	This is the CSLL amount retained. It is optional, must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.impostos.vIRRF	This is the amount of IR withheld. It is optional, it must be a number and the content informed must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetPrev	This is the amount of INSS withheld. It is optional, it must be a number and the content informed must have up to 13 whole numbers with 2 decimals.
payload.impostos.vIOF	This is the amount of IOF withheld. It is optional, must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.infAdic[].xCampo	This is the field identification (name of your preference) to record additional, complementary information about the financial document. It is optional, it must be a string and the length must be at most 20 characters
payload.infAdic[].xTexto	This is detailed text (description) to record additional, complementary information about the financial document. It is conditional, that is, it should only be informed if \"payload.infAdic[].xCampo\" is informed, otherwise, do not inform. It must be a string and the length must be at most 20 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","transactions"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"75075c10-8fee-49f6-a367-ae3461161fe9","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"yjSWnlN3Jtxj5OdJA8uAc9ZDzvV09sSg","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"07eefad7-9da7-4e66-8bf7-d5bdb130f693","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"federalDocument\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"601044ef-e0a9-4a1f-b832-1504f4962036","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"6e67e6f1-2945-4f38-bdd8-e005c4ff8241","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"8b10efa2-0391-4919-a793-30235731c807","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"companyId\",\n \"messages\": [\n \"Not Found\"\n ]\n }\n ]\n}"},{"id":"e81f3f74-09ac-45c4-b6e5-f6e9b20e1f1e","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"nDoc\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"d2a452e1-0226-414e-9e60-48adf12eef7e"},{"name":"transactions (list)","id":"69d841bc-27ea-4998-8727-b9e898f0023c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions?page=1&limit=50&companyId=&subsidiaryId&q&sort=asc","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","transactions"],"host":["{{API_DOMAIN}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"companyId","value":""},{"key":"subsidiaryId","value":null},{"key":"q","value":null},{"key":"sort","value":"asc"}],"variable":[]}},"response":[{"id":"8b97aa2e-52d0-4f59-a91b-a43744208c4f","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions?page=1&limit=50&sort=asc&companyId=&subsidiaryId&q","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","transactions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"companyId","value":""},{"key":"subsidiaryId","value":null},{"key":"q","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"emit\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"enderEmit\": {\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"UF\": \"\",\n \"CEP\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\",\n \"email\": \"\",\n \"fone\": \"\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"enderEmit\": {\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"UF\": \"\",\n \"CEP\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\",\n \"email\": \"\",\n \"fone\": \"\"\n }\n },\n \"ide\": {\n \"nDoc\": \"\",\n \"qDup\": \"\",\n \"vOrig\": \"\",\n \"vDesc\": \"\",\n \"vJur\": \"\",\n \"vMul\": \"\",\n \"vPag\": \"\",\n \"status\": \"\",\n \"dDoc\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"dCompet\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"description\": \"\"\n },\n \"dup\": [\n {\n \"id\": \"\",\n \"nDup\": \"\",\n \"dDup\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"dVenc\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"vOrig\": \"\",\n \"vDesc\": \"\",\n \"vJur\": \"\",\n \"vMul\": \"\",\n \"status\": \"\",\n \"pag\": [\n {\n \"id\": \"\",\n \"tPag\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"vPag\": \"\",\n \"xPag\": \"\",\n \"dPag\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"CNPJPag\": \"\",\n \"UFPag\": \"\",\n \"card\": {\n \"tpIntegra\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"CNPJ\": \"\",\n \"tBand\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cAut\": \"\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"\",\n \"vIBS\": \"\",\n \"vIS\": \"\",\n \"vISSRet\": \"\",\n \"vRetPIS\": \"\",\n \"vRetCOFINS\": \"\",\n \"vRetCSLL\": \"\",\n \"vIRRF\": \"\",\n \"vRetPrev\": \"\",\n \"vIOF\": \"\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"\",\n \"xTexto\": \"\",\n \"base64\": \"\",\n \"url\": \"\"\n }\n ],\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"f0eeff52-9b3c-4a65-9c6b-1927d9a9d568","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions?page=1&limit=50&companyId=&subsidiaryId&q&sort=asc","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","transactions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"companyId","value":""},{"key":"subsidiaryId","value":null},{"key":"q","value":null},{"key":"sort","value":"asc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"8c2b3fe7-73f1-4df6-ac39-5d98dbfa1362","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions?page=1&limit=50&companyId=&subsidiaryId&q&sort=asc","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","transactions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"companyId","value":""},{"key":"subsidiaryId","value":null},{"key":"q","value":null},{"key":"sort","value":"asc"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"69d841bc-27ea-4998-8727-b9e898f0023c"},{"name":"transactions (detail)","id":"82a9a936-3ae7-4add-aac9-816d5eaf3a7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","transactions","{transactionId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"c78ac502-9b51-4678-ae1c-f826789ff96a","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"emit\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"enderEmit\": {\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"UF\": \"\",\n \"CEP\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\",\n \"email\": \"\",\n \"fone\": \"\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"\",\n \"xNome\": \"\",\n \"enderEmit\": {\n \"xLgr\": \"\",\n \"nro\": \"\",\n \"xCpl\": \"\",\n \"xBairro\": \"\",\n \"cMun\": \"\",\n \"xMun\": \"\",\n \"UF\": \"\",\n \"CEP\": \"\",\n \"cPais\": \"\",\n \"xPais\": \"\",\n \"email\": \"\",\n \"fone\": \"\"\n }\n },\n \"ide\": {\n \"nDoc\": \"\",\n \"qDup\": \"\",\n \"vOrig\": \"\",\n \"vDesc\": \"\",\n \"vJur\": \"\",\n \"vMul\": \"\",\n \"vPag\": \"\",\n \"status\": \"\",\n \"dDoc\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"dCompet\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"description\": \"\"\n },\n \"dup\": [\n {\n \"id\": \"\",\n \"nDup\": \"\",\n \"dDup\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"dVenc\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"vOrig\": \"\",\n \"vDesc\": \"\",\n \"vJur\": \"\",\n \"vMul\": \"\",\n \"status\": \"\",\n \"pag\": [\n {\n \"id\": \"\",\n \"tPag\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"vPag\": \"\",\n \"xPag\": \"\",\n \"dPag\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"CNPJPag\": \"\",\n \"UFPag\": \"\",\n \"card\": {\n \"tpIntegra\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"CNPJ\": \"\",\n \"tBand\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cAut\": \"\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"\",\n \"vIBS\": \"\",\n \"vIS\": \"\",\n \"vISSRet\": \"\",\n \"vRetPIS\": \"\",\n \"vRetCOFINS\": \"\",\n \"vRetCSLL\": \"\",\n \"vIRRF\": \"\",\n \"vRetPrev\": \"\",\n \"vIOF\": \"\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"\",\n \"xTexto\": \"\",\n \"base64\": \"\",\n \"url\": \"\"\n }\n ],\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n}"},{"id":"439349b5-7bce-49a5-9ec6-d764c0142ac4","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"231c2df4-dcab-4cfd-9b8a-21bd69c9d6bb","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"e730eea9-dba3-4cda-a4c2-ae1c1c1900d7","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"82a9a936-3ae7-4add-aac9-816d5eaf3a7f"},{"name":"transactions","id":"902a711c-68d3-4ec8-8505-c9fb61c7a1eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}","description":"

`Field`	`Details`
payload.emit.federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ (Brazilian corporate tax ID), enter all 14 digits. If it is a CPF (Brazilian individual tax ID), enter all 11 digits. The federal identification document of the issuer or recipient of the document must be provided and must match the company's base CNPJ where it is being registered. It can only be edited if it is a third-party federal document that is not compatible with the company's base CNPJ.
payload.emit.xNome	This is the legal name by which the issuer of the financial document is recognized. It is optional, must be a string and cannot exceed 60 characters.
payload.emit.enderEmit.xLgr	This is the issuer address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.nro	This is the issuer address number. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.xBairro	This is the neighborhood of the issuer's address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.xCpl	This is the complement of the issuer address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.cMun	This is the IBGE code of the municipality of the issuer's address. It is optional and must be a string with a length of 7 characters.
payload.emit.enderEmit.xMun	This is the name of the municipality of the issuer's address. It is optional, must be a string and the length cannot exceed 60 characters.
payload.emit.enderEmit.UF	This is the abbreviation of the federation unit of the municipality of the issuer's address. It is optional, must be a string and the length must be 2.
payload.emit.enderEmit.CEP	This is the postal address box for the sender's address. It is optional, must be a string, and the length must be 8.
payload.emit.enderEmit.cPais	This is the country code of the issuer's address. It is optional, must be a string, and the length must be 2, 3, or 4.
payload.emit.enderEmit.xPais	This is the country name of the issuer's address. It is optional, must be a string, and the length cannot exceed 60 characters.
payload.emit.enderEmit.email	This is the issuer's contact email address. It is optional, must be a string, and cannot exceed 60 characters.
payload.emit.enderEmit.fone	This is the issuer's contact phone number. It is optional, must be a string and cannot exceed 60 characters.
payload.dest.federalDocument	This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ (Brazilian corporate tax ID), enter all 14 digits. If it is a CPF (Brazilian individual tax ID), enter all 11 digits. The federal identification document of the issuer or recipient of the document must be provided and must match the company's base CNPJ where it is being registered. It can only be edited if it is a third-party federal document that is not compatible with the company's base CNPJ.
payload.dest.xNome	This is the legal name by which the recipient of the financial document is recognized. It is optional, must be a string and cannot exceed 60 characters.
payload.dest.enderDest.xLgr	This is the recipient address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.nro	This is the recipient address number. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.xBairro	This is the neighborhood of the recipient's address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.xCpl	This is the complement of the recipient address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.cMun	This is the IBGE code of the municipality of the recipient's address. It is optional and must be a string with a length of 7 characters.
payload.dest.enderDest.xMun	This is the name of the municipality of the recipient's address. It is optional, must be a string and the length cannot exceed 60 characters.
payload.dest.enderDest.UF	This is the abbreviation of the federation unit of the municipality of the recipient's address. It is optional, must be a string and the length must be 2.
payload.dest.enderDest.CEP	This is the postal address box for the recipient's address. It is optional, must be a string, and the length must be 8.
payload.dest.enderDest.cPais	This is the country code of the recipient's address. It is optional, must be a string, and the length must be 2, 3, or 4.
payload.dest.enderDest.xPais	This is the country name of the recipient's address. It is optional, must be a string, and the length cannot exceed 60 characters.
payload.dest.enderDest.email	This is the recipient's contact email address. It is optional, must be a string, and cannot exceed 60 characters.
payload.dest.enderDest.fone	This is the recipient's contact phone number. It is optional, must be a string and cannot exceed 60 characters.
payload.ide.nDoc	This is the unique identification number of the document that generated the financial event (invoice, contract, notes). It is optional, must be a sequence of characters and be between 1 and 60 in length.
payload.ide.dDoc	This is the date and time of generation of the document that generated the financial event (invoice, contract, notes). It is optional, must be a string and the content entered must be in UTC format.
payload.ide.dCompet	This is the period of competence of the document (period of transfer of the right or duty, regardless of whether there is actual financial movement). It is optional, must be a string and the content entered must be in the format MM/YYYY. If it is not entered, the platform will automatically assign the month of registration of the document as the period of competence.
payload.ide.description	This is a detailed description of the document.
payload.ide.finalidade	This is a purpose of the transaction that generated this financial document. If it is a document where your establishment is the recipient, it probably refers to the sale of some product or service. If it is a document where your establishment is the payer, it probably refers to the purchase of some product or service. In both cases, the purpose determines the reason for the sale (e.g. sale of training services) or the reason for the purchase (e.g. purchase of merchandise for resale, purchase of merchandise for use and consumption...). Suggestions for purpose can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=finalidade\"
payload.dup[].nDup	This is the unique identifier of the installment plan of the document that generated the financial event. It is optional, must be a string and the content entered must have up to 50 characters.
payload.dup[].dDup	This is the date the installment was generated. If not provided, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content provided must be in UTC format.
payload.dup[].dVenc	This is the installment payment due date. If not entered, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content entered must be in UTC format.
payload.dup[].vOrig	This is the original installment amount (before considering discounts and additions). It is mandatory, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vDesc	This is the value of the installment discount. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vJur	This is the interest value of the installment. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vMul	This is the amount of the installment fine. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].tPag	This is the installment payment type. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tPag\"
payload.dup[].pag.[].vPag	This is the total amount paid for the installment. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].xPag	This is the description that best identifies the payment type if the \"tPag\" attribute entered is equal to \"99\" (Others). It is optional, must be a string and be between 1 and 60 in length.
payload.dup[].pag.[].dPag	This is the date of the installment payment. If not informed, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content informed must be in UTC format.
payload.dup[].pag.[].CNPJPag	This is the federal document of jurisdiction under which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is optional and must be a string.
payload.dup[].pag.[].UFPag	This is the abbreviation of the federal unit of the jurisdiction over which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. It is optional and must be a string with length 2.
payload.dup[].pag.[].card.tpIntegra	This is the code for the payment method integration type. It is optional, must be a string and the value provided must be \"1\" (TEF) or \"2\" (POS).
payload.dup[].pag.[].card.CNPJ	Enter the federal document of the acquirer who authorized the electronic payment. It is optional, must be a sequence of characters and the amount entered must have 14 digits.
payload.dup[].pag.[].card.tBand	This is the type of card flag used for installment payments. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tBand\"
payload.dup[].pag.[].card.cAut	This is the payment authorization code generated by the acquirer who authorized the electronic payment. It is optional, must be a string and the value entered must be between 1 and 20 characters long.
payload.impostos.vCBS	This is the CBS value. It is optional, must be a number, and the information provided must contain up to 13 whole digits with 2 decimals.
payload.impostos.vIBS	This is the IBS value. It is optional, must be a number, and the information provided must contain up to 13 integer digits with 2 decimals.
payload.impostos.vIS	This is the IS value. It is optional, must be a number, and the information provided must contain up to 13 integer digits with 2 decimals.
payload.impostos.vISSRet	This is the amount of ISSQN retained. It is optional, must be a number and the content informed must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetPIS	This is the amount of PIS withheld. It is optional, it must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetCOFINS	This is the amount of COFINS withheld. It is optional, must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetCSLL	This is the CSLL amount retained. It is optional, must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.impostos.vIRRF	This is the amount of IR withheld. It is optional, it must be a number and the content informed must have up to 13 whole numbers with 2 decimals.
payload.impostos.vRetPrev	This is the amount of INSS withheld. It is optional, it must be a number and the content informed must have up to 13 whole numbers with 2 decimals.
payload.impostos.vIOF	This is the amount of IOF withheld. It is optional, must be a number and the content entered must have up to 13 whole numbers with 2 decimals.
payload.infAdic[].xCampo	This is the field identification (name of your preference) to record additional, complementary information about the financial document. It is optional, it must be a string and the length must be at most 20 characters
payload.infAdic[].xTexto	This is detailed text (description) to record additional, complementary information about the financial document. It is conditional, that is, it should only be informed if \"payload.infAdic[].xCampo\" is informed, otherwise, do not inform. It must be a string and the length must be at most 20 characters.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","transactions","{transactionId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"c60aca95-fa71-4e8d-b60b-5f94e6a3cca6","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"yjSWnlN3Jtxj5OdJA8uAc9ZDzvV09sSg","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api-sandbox.omnitax.ai/finances/transactions/{transactionId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction updated successfully\"\n}"},{"id":"0365a0a1-744c-4d13-a7fa-ac7c903cae7c","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"9d0cee78-cfb4-49a9-a494-0e8dab04a046","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"84b52bdb-b554-49ae-b95b-ac0f22287619","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"emit\": {\n \"federalDocument\": \"conditional (required if not dest.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderEmit\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"dest\": {\n \"federalDocument\": \"conditional (required if not emit.federalDocument specified), string\",\n \"xNome\": \"optional, string\",\n \"enderDest\": {\n \"xLgr\": \"optional, string\",\n \"nro\": \"optional, string\",\n \"xCpl\": \"optional, string\",\n \"xBairro\": \"optional, string\",\n \"cMun\": \"optional, string\",\n \"xMun\": \"optional, string\",\n \"UF\": \"optional, string\",\n \"CEP\": \"optional, string\",\n \"cPais\": \"optional, string\",\n \"xPais\": \"optional, string\",\n \"email\": \"optional, string\",\n \"fone\": \"optional, string\"\n }\n },\n \"ide\": {\n \"nDoc\": \"optional, string\",\n \"dDoc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dCompet\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"description\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"finalidade\": \"optional, string\"\n },\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"optional, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ],\n \"imposto\": {\n \"vCBS\": \"optional, number\",\n \"vIBS\": \"optional, number\",\n \"vIS\": \"optional, number\",\n \"vISSRet\": \"optional, number\",\n \"vRetPIS\": \"optional, number\",\n \"vRetCOFINS\": \"optional, number\",\n \"vRetCSLL\": \"optional, number\",\n \"vIRRF\": \"optional, number\",\n \"vRetPrev\": \"optional, number\",\n \"vIOF\": \"optional, number\"\n },\n \"infAdic\": [\n {\n \"xCampo\": \"optional, string\",\n \"xTexto\": \"conditional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"902a711c-68d3-4ec8-8505-c9fb61c7a1eb"},{"name":"transactions","id":"145db3f4-c578-4742-a53d-073bfabce638","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","transactions","{transactionId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"2551dc5a-ec2f-4909-aa9f-76b3f8de70c8","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Transaction removed successfully\"\n}"},{"id":"24efb97d-abcf-4866-8b4d-141f8f21fb72","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b2b8cadf-c166-4133-9262-65e1e0a9b9c6","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"28c50547-add5-4ba6-bfda-10116e61dd78","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/transactions/{transactionId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"145db3f4-c578-4742-a53d-073bfabce638"}],"id":"507462a2-3c0e-4d87-bab5-1e99285b8d02","description":"

This is the set of endpoints that allows the management of financial transactions.

\n","_postman_id":"507462a2-3c0e-4d87-bab5-1e99285b8d02"},{"name":"installments","item":[{"name":"dup","id":"c73156fc-dc1e-4b3a-a6ea-01907f113056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{transactionId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Field`	`Details`
payload.dup[].nDup	This is the unique identifier of the installment plan of the document that generated the financial event. It is optional, must be a string and the content entered must have up to 50 characters.
payload.dup[].dDup	This is the date the installment was generated. If not provided, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content provided must be in UTC format.
payload.dup[].dVenc	This is the installment payment due date. If not entered, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content entered must be in UTC format.
payload.dup[].vOrig	This is the original installment amount (before considering discounts and additions). It is mandatory, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vDesc	This is the value of the installment discount. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vJur	This is the interest value of the installment. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vMul	This is the amount of the installment fine. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].tPag	This is the installment payment type. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tPag\"
payload.dup[].pag.[].vPag	This is the total amount paid for the installment. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].xPag	This is the description that best identifies the payment type if the \"tPag\" attribute entered is equal to \"99\" (Others). It is optional, must be a string and be between 1 and 60 in length.
payload.dup[].pag.[].dPag	This is the date of the installment payment. If not informed, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content informed must be in UTC format.
payload.dup[].pag.[].CNPJPag	This is the federal document of jurisdiction under which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is optional and must be a string.
payload.dup[].pag.[].UFPag	This is the abbreviation of the federal unit of the jurisdiction over which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. It is optional and must be a string with length 2.
payload.dup[].pag.[].card.tpIntegra	This is the code for the payment method integration type. It is optional, must be a string and the value provided must be \"1\" (TEF) or \"2\" (POS).
payload.dup[].pag.[].card.CNPJ	Enter the federal document of the acquirer who authorized the electronic payment. It is optional, must be a sequence of characters and the amount entered must have 14 digits.
payload.dup[].pag.[].card.tBand	This is the type of card flag used for installment payments. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tBand\"
payload.dup[].pag.[].card.cAut	This is the payment authorization code generated by the acquirer who authorized the electronic payment. It is optional, must be a string and the value entered must be between 1 and 20 characters long.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","dup","{transactionId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"f3cc9981-cc15-4b1c-a6ab-3cbd6033d7b1","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{transactionId}"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Installment registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"1ac3f76b-57c9-4b5e-a2c8-e1171980804d","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{transactionId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"federalDocument\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"b53a3393-bafd-42ed-87b0-300365998e72","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{transactionId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"2b5ffe2b-9188-494c-84a5-c699c3388824","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{transactionId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"1366d22b-5e69-4003-b6ec-e7d869424d4f","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{transactionId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"},{"id":"33fb6d7c-dea8-4921-b3f8-aa636b295eed","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": [\n {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{transactionId}"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"nDup\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"c73156fc-dc1e-4b3a-a6ea-01907f113056"},{"name":"dup (list)","id":"68c589c4-62b9-4eff-8c47-f72856087fd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup?page=1&limit=50&sort=asc&transactionId","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","dup"],"host":["{{API_DOMAIN}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"transactionId","value":null}],"variable":[]}},"response":[{"id":"e7cce66b-1b4b-4d1f-bc96-ed925a2b55d0","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup?page=1&limit=50&sort=asc&transactionId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","dup"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"transactionId","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"nDup\": \"\",\n \"dDup\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"dVenc\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"vOrig\": \"\",\n \"vDesc\": \"\",\n \"vJur\": \"\",\n \"vMul\": \"\",\n \"status\": \"\",\n \"transactions\": [\n \"\"\n ],\n \"pag\": [\n {\n \"id\": \"\",\n \"tPag\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"vPag\": \"\",\n \"xPag\": \"\",\n \"dPag\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"CNPJPag\": \"\",\n \"UFPag\": \"\",\n \"card\": {\n \"tpIntegra\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"CNPJ\": \"\",\n \"tBand\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cAut\": \"\"\n }\n }\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"d9b6762f-b5ec-4ab0-8d47-40d185244367","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup?page=1&limit=50&sort=asc&transactionId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","dup"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"transactionId","value":null}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"493428d9-f6e7-4abe-901a-bc4fc1aa40e9","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup?page=1&limit=50&sort=asc&transactionId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","dup"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"transactionId","value":null}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"68c589c4-62b9-4eff-8c47-f72856087fd0"},{"name":"dup (detail)","id":"42a885a8-a651-41b0-b9e7-fc7387786b75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","dup","{dupId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"e1d04bf7-5274-484c-a89f-a271dc1ca33b","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"nDup\": \"\",\n \"dDup\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"dVenc\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"vOrig\": \"\",\n \"vDesc\": \"\",\n \"vJur\": \"\",\n \"vMul\": \"\",\n \"status\": \"\",\n \"transactions\": [\n \"\"\n ],\n \"pag\": [\n {\n \"id\": \"\",\n \"tPag\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"vPag\": \"\",\n \"xPag\": \"\",\n \"dPag\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"CNPJPag\": \"\",\n \"UFPag\": \"\",\n \"card\": {\n \"tpIntegra\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"CNPJ\": \"\",\n \"tBand\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cAut\": \"\"\n }\n }\n ]\n }\n}"},{"id":"5f210ace-7115-40b0-8e28-9eaee78d2235","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b01389e2-e3b6-492e-8a2c-88f67a37aac6","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ccfc0eb6-5611-4dc3-8807-c753bee8d991","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"42a885a8-a651-41b0-b9e7-fc7387786b75"},{"name":"dup","id":"a331710f-1c63-4e21-9106-c288eb4f73a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Field`	`Details`
payload.dup[].nDup	This is the unique identifier of the installment plan of the document that generated the financial event. It is optional, must be a string and the content entered must have up to 50 characters.
payload.dup[].dDup	This is the date the installment was generated. If not provided, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content provided must be in UTC format.
payload.dup[].dVenc	This is the installment payment due date. If not entered, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content entered must be in UTC format.
payload.dup[].vOrig	This is the original installment amount (before considering discounts and additions). It is mandatory, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vDesc	This is the value of the installment discount. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vJur	This is the interest value of the installment. It is optional, must be a number and the content entered must have up to 13 integers with 2 decimals.
payload.dup[].vMul	This is the amount of the installment fine. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].tPag	This is the installment payment type. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tPag\"
payload.dup[].pag.[].vPag	This is the total amount paid for the installment. It is optional, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.dup[].pag.[].xPag	This is the description that best identifies the payment type if the \"tPag\" attribute entered is equal to \"99\" (Others). It is optional, must be a string and be between 1 and 60 in length.
payload.dup[].pag.[].dPag	This is the date of the installment payment. If not informed, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content informed must be in UTC format.
payload.dup[].pag.[].CNPJPag	This is the federal document of jurisdiction under which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is optional and must be a string.
payload.dup[].pag.[].UFPag	This is the abbreviation of the federal unit of the jurisdiction over which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. It is optional and must be a string with length 2.
payload.dup[].pag.[].card.tpIntegra	This is the code for the payment method integration type. It is optional, must be a string and the value provided must be \"1\" (TEF) or \"2\" (POS).
payload.dup[].pag.[].card.CNPJ	Enter the federal document of the acquirer who authorized the electronic payment. It is optional, must be a sequence of characters and the amount entered must have 14 digits.
payload.dup[].pag.[].card.tBand	This is the type of card flag used for installment payments. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tBand\"
payload.dup[].pag.[].card.cAut	This is the payment authorization code generated by the acquirer who authorized the electronic payment. It is optional, must be a string and the value entered must be between 1 and 20 characters long.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","dup","{dupId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"9adc50c7-a4f1-4f4a-84a4-f4794308a279","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Installment updated successfully\"\n}"},{"id":"51dcc4c6-895b-40e5-b322-e7fcd9e3eea8","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"f2630e03-f620-4d4b-834f-f13eaee43cdc","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"c2c58c32-21bf-46ef-a8fb-5d6036aac54e","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"dup\": {\n \"nDup\": \"optional, string\",\n \"dDup\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"dVenc\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"vOrig\": \"required, number\",\n \"vDesc\": \"optional, number\",\n \"vJur\": \"optional, number\",\n \"vMul\": \"optional, number\",\n \"pag\": [\n {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"a331710f-1c63-4e21-9106-c288eb4f73a4"},{"name":"dup","id":"2963fc35-9517-4b38-b148-ae49699892c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","dup","{dupId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"aad3c5da-6d46-499b-a2e4-5bb381ba156a","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Installment removed successfully\"\n}"},{"id":"042c7912-a99b-49de-b3d7-df3bab026063","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"d329a6ec-eb5d-4c45-845e-08951ef15890","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"de63c9f7-7938-4ed7-b252-dccb190be830","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/dup/{dupId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"2963fc35-9517-4b38-b148-ae49699892c0"}],"id":"bc646473-0ac1-4755-a990-890d25f09e36","description":"

This is the set of endpoints that allows the management of installments of a financial transaction.

\n","_postman_id":"bc646473-0ac1-4755-a990-890d25f09e36"},{"name":"payment","item":[{"name":"pag","id":"28a7a562-ed49-4744-bc2b-872cd0aed398","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{dupId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Field`	`Details`
payload.pag.[].tPag	This is the installment payment type. It is required, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tPag\"
payload.pag.[].vPag	This is the total amount paid for the installment. It is required, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.pag.[].xPag	This is the description that best identifies the payment type if the \"tPag\" attribute entered is equal to \"99\" (Others). It is optional, must be a string and be between 1 and 60 in length.
payload.pag.[].dPag	This is the date of the installment payment. If not informed, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content informed must be in UTC format.
payload.pag.[].CNPJPag	This is the federal document of jurisdiction under which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is optional and must be a string.
payload.pag.[].UFPag	This is the abbreviation of the federal unit of the jurisdiction over which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. It is optional and must be a string with length 2.
payload.pag.[].card.tpIntegra	This is the code for the payment method integration type. It is optional, must be a string and the value provided must be \"1\" (TEF) or \"2\" (POS).
payload.pag.[].card.CNPJ	Enter the federal document of the acquirer who authorized the electronic payment. It is optional, must be a sequence of characters and the amount entered must have 14 digits.
payload.pag.[].card.tBand	This is the type of card flag used for installment payments. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tBand\"
payload.pag.[].card.cAut	This is the payment authorization code generated by the acquirer who authorized the electronic payment. It is optional, must be a string and the value entered must be between 1 and 20 characters long.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","pag","{dupId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"0ef926f8-8459-47e2-8cb1-a917b84c56b0","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": [\n {\n \"tPag\": \"required, string\",\n \"vPag\": \"required, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{dupId}"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"f5413a73-f875-40b8-87b3-33a4a9d1b942","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": [\n {\n \"tPag\": \"required, string\",\n \"vPag\": \"required, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{dupId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"tPag\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"e7d045d8-e261-4b46-9409-d65d8253a836","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": [\n {\n \"tPag\": \"required, string\",\n \"vPag\": \"required, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{dupId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"8e69b5d5-b9e5-4500-8a40-b77cd3d72b44","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": [\n {\n \"tPag\": \"required, string\",\n \"vPag\": \"required, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{dupId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"31d75357-25ce-41e8-aaa3-921c015dad5d","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": [\n {\n \"tPag\": \"required, string\",\n \"vPag\": \"required, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{dupId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"28a7a562-ed49-4744-bc2b-872cd0aed398"},{"name":"pag (list)","id":"8802ee34-4891-4dcd-a8f8-5217f6b5f2e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag?page=1&limit=50&sort=asc&dupId","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","pag"],"host":["{{API_DOMAIN}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"dupId","value":null}],"variable":[]}},"response":[{"id":"62873b8e-b4da-4b08-b9f6-4939ce4ebd63","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"yjSWnlN3Jtxj5OdJA8uAc9ZDzvV09sSg","type":"text"}],"url":{"raw":"https://api-sandbox.omnitax.ai/finances/pag?page=1&limit=50&sort=asc&dupId","protocol":"https","host":["api-sandbox","omnitax","ai"],"path":["finances","pag"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"dupId","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"tPag\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"vPag\": \"\",\n \"xPag\": \"\",\n \"dPag\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"CNPJPag\": \"\",\n \"UFPag\": \"\",\n \"card\": {\n \"tpIntegra\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"CNPJ\": \"\",\n \"tBand\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cAut\": \"\"\n },\n \"transactions\": [\n \"\"\n ]\n }\n ],\n \"totalItems\": 1\n}"},{"id":"e38db635-849b-445f-beef-ad2b54db4cf3","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag?page=1&limit=50&sort=asc&dupId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","pag"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"dupId","value":null}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"4dcb9ea7-6178-4dda-a6cc-88481d6ffbd1","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag?page=1&limit=50&sort=asc&dupId","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["finances","pag"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"dupId","value":null}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"8802ee34-4891-4dcd-a8f8-5217f6b5f2e2"},{"name":"pag (detail)","id":"d8384ed9-982c-4325-897c-10f7fe55b20e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","pag","{pagId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"bb655d43-71c2-453e-94c3-e2774ca02124","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"yjSWnlN3Jtxj5OdJA8uAc9ZDzvV09sSg","type":"text"}],"url":"https://api-sandbox.omnitax.ai/finances/pag/{pagId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"tPag\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"vPag\": \"\",\n \"xPag\": \"\",\n \"dPag\": {\n \"epoch\": 1758286075,\n \"formatted\": \"19/09/2025 - 09:47:55\"\n },\n \"CNPJPag\": \"\",\n \"UFPag\": \"\",\n \"card\": {\n \"tpIntegra\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"CNPJ\": \"\",\n \"tBand\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cAut\": \"\"\n },\n \"transactions\": [\n \"\"\n ]\n }\n}"},{"id":"4b28af44-d7a3-4420-8c3a-633f4dc9b61b","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b9983ebc-0e64-48b5-905e-08e37f4d51ee","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"342ebe9f-d227-40c2-a9c2-1b68c80210ea","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"d8384ed9-982c-4325-897c-10f7fe55b20e"},{"name":"pag","id":"d7741e3d-d771-4933-ac3f-8b00e8234484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`Field`	`Details`
payload.pag.[].tPag	This is the installment payment type. It is required, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tPag\"
payload.pag.[].vPag	This is the total amount paid for the installment. It is required, must be a number and the content provided must have up to 13 integers with 2 decimals.
payload.pag.[].xPag	This is the description that best identifies the payment type if the \"tPag\" attribute entered is equal to \"99\" (Others). It is optional, must be a string and be between 1 and 60 in length.
payload.pag.[].dPag	This is the date of the installment payment. If not informed, the platform will automatically assign the date it was registered on the platform. It is optional, must be a string and the content informed must be in UTC format.
payload.pag.[].CNPJPag	This is the federal document of jurisdiction under which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. This is the unique federal identification number for companies or individuals in Brazil. If it is a CNPJ, enter the 14 digits that have the same first 8 digits registered with the company. If it is a CPF, enter the 11 digits exactly as registered with the company. It is optional and must be a string.
payload.pag.[].UFPag	This is the abbreviation of the federal unit of the jurisdiction over which the payment was made when the payment occurred in a jurisdiction other than that issued by the tax document. It is optional and must be a string with length 2.
payload.pag.[].card.tpIntegra	This is the code for the payment method integration type. It is optional, must be a string and the value provided must be \"1\" (TEF) or \"2\" (POS).
payload.pag.[].card.CNPJ	Enter the federal document of the acquirer who authorized the electronic payment. It is optional, must be a sequence of characters and the amount entered must have 14 digits.
payload.pag.[].card.tBand	This is the type of card flag used for installment payments. It is optional, must be a string and the content provided must be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA-TAX-INFO&sortKey=tBand\"
payload.pag.[].card.cAut	This is the payment authorization code generated by the acquirer who authorized the electronic payment. It is optional, must be a string and the value entered must be between 1 and 20 characters long.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","pag","{pagId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"c9409d11-5be8-45de-b662-4d4ab95996bc","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment updated successfully\"\n}"},{"id":"4a21c052-f0c9-457d-9ad4-7d42c0443880","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b1023a84-c2fa-490c-9b98-5ad77017bcc1","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"dd735b94-0347-4fb1-be76-5389ec4c8d31","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"payload\": {\n \"pag\": {\n \"tPag\": \"optional, string\",\n \"vPag\": \"optional, number\",\n \"xPag\": \"optional, string\",\n \"dPag\": \"optional, string and UTC Format: YYYY-MM-DDThh:mm:ss.SSSZ\",\n \"CNPJPag\": \"optional, string\",\n \"UFPag\": \"optional, string\",\n \"card\": {\n \"tpIntegra\": \"optional, string\",\n \"CNPJ\": \"optional, string\",\n \"tBand\": \"optional, string\",\n \"cAut\": \"optional, string\"\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"d7741e3d-d771-4933-ac3f-8b00e8234484"},{"name":"pag","id":"b211e391-9fd4-4297-9082-66801ded89ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["finances","pag","{pagId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"6b5615a6-07cd-404a-913f-8bb1803a3274","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Payment removed successfully\"\n}"},{"id":"0d11cdcc-676c-4383-a3b9-0b2ce0454c73","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"4d7d4b96-2ae2-406f-b02d-e67d4371af08","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"bc8f894f-d48a-42b9-99cd-e2d31ab558a7","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/finances/pag/{pagId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"b211e391-9fd4-4297-9082-66801ded89ce"}],"id":"bb12b230-3054-42f5-adb0-26bb771f2239","description":"

This is the set of endpoints that allows the management of installment payments for a financial transaction.

\n","_postman_id":"bb12b230-3054-42f5-adb0-26bb771f2239"}],"id":"f1ee43fb-bf9a-4775-996f-dd1940e73cc0","description":"

Users can register financial documents (accounts payable or accounts receivable) for a previously selected company as long as the issuer or recipient of the financial document is previously registered as a subsidiary of the company.

\n","_postman_id":"f1ee43fb-bf9a-4775-996f-dd1940e73cc0"},{"name":"products","item":[{"name":"products","id":"c407f591-e360-492c-8400-56c99fa8f561","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products","description":"

`field`	`Details`
companyId	This is the companyId where your product will be registered. It is mandatory, must be a string and the content entered must be a valid UUID
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
tpProd	This is the code that defines the type of product, whether goods (enter 0) or service (enter 1). It is mandatory and must be a string.
orig	This is the code that defines the origin of the product, whether national or imported. It is mandatory, must be a string and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=orig\"
tpIntermedio	This is the indicator of the form of intermediation of the import of a product, whether of the type of goods or service. It is mandatory when the \"orig\" field is equal to 1, 2, 3, 8 or 10 and should not be informed in other cases. It must be a string and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey= tpIntermedio\"
xProd	This is the detailed description of the product, whether it is a goods or service. It is mandatory and must be a string with a length between 1 and 120.
cProd	This is the company's internal code for unique product identification, whether it is a product or service. It is mandatory and must be a string with a length between 1 and 60.
cProdPreceding	This is an internal code previously used by the company to uniquely identify the product, whether it is a goods or service. It is optional and must be a string with a length between 1 and 60.
cEAN	This is the unique GTIN (Global Trade Item Number) code to identify the product. It is optional and must be a string with lengths of 8, 12, 13, 14 or the literal \"SEM GTIN\".
cEANTrib	This is the unique taxable GTIN (Global Trade Item Number) code to identify the product. It is optional and must be a string with lengths of 8, 12, 13, 14 or the literal \"SEM GTIN\".
NCM	This is the NCM (Common Nomenclature of Mercosur) code used by the company for the product. It is mandatory and must be a character sequence with 8 elements (if tpProd = '0' - merchandise) or 2 elements (if tpProd = '1' - service). Valid values can be obtained at \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=NCM\".
uCom	This is the commercial unit of measurement for the product, whether it is a goods or services type. It is mandatory, it must be a string with a length between 1 and 6 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=medida\"
qCom	This is the commercial quantity of the product, whether it is a goods or services. It is mandatory and must be a string with a length between 1 and 11 integers and between 1 and 4 decimals.
vUnCom	This is the commercial unit value of the product, whether it is a goods or a service. It is mandatory and must be a string with a length 13 integers and up to 2 decimals
uTrib	This is the taxable unit of measurement for the product, whether it is a goods or services type. It is optional, it must be a string with a length between 1 and 6 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=medida\"
qTrib	This is the taxable quantity of the product, whether it is a goods or services type. It is optional and must be a string with a length between 1 and 11 integers and between 1 and 4 decimals.
vUnTrib	This is the taxable unit value of the product, whether it is a goods or services type. It is optional and must be a string with a length 13 integers and up to 2 decimals
serv.cNBS	This is the NBS (Brazilian Nomenclature of Services) code of the product. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 9 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cNBS\"
serv.cListServ	This is the service code according to the Brazilian Federal Complementary Law No. 116/2003. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 5 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribNac\"
serv.cServico	This is the service code according to the Municipal Law. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 5 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribNac\"
serv.cTribMun	This is the service code according to the Municipal Law. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 3 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribMun\"
serv.cTribNac	This is the service code according to Federal Law. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 6 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribNac\"
merc.specificProd	This is the product specificity indicator. It is mandatory and can only be entered if the \"tpProd\" field is equal to \"0\" (goods). It should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=specificProd\"
merc.EXTIPI	This is the NCM (Mercosur Common Nomenclature) exception code for the product. It is optional and must be a string with a length of 2 or 3.
merc.NVE	This is the NVE (Nomenclature of Customs and Statistical Values) code of the product. It is optional, but can only be informed if the \"NCM\" field is also informed. It must be an array of objects with a limit of 8 items and a format for each item must have two uppercase letters and 4 digits, for example: \"AA0001\"
merc.CEST	This is the CEST code (Tax Substitution Specifier Code) of the product. It is optional, but can only be informed if the \"NCM\" field is also informed. It must be a string with a length of 7 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CEST\"
merc.CNPJFab	This is the federal document that identifies the manufacturer of the product, regardless of whether or not this manufacturer belongs to the company where the product will be registered. It is optional, can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if the \"tpProd\" field is equal to \"1\" (service). It must be a string with a length between 1 and 20.
merc.marca	This is the brand of the goods. It is optional, it can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string with a length between 1 and 256.
merc.tipoEmbalagem	This is the type of packaging used in the goods. It is optional, can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tipoEmbalagem\"
merc.materialEmbalagem	This is the predominant material used in the packaging of the goods. It is optional, can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and should not be informed if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=materialEmbalagem\"
merc.cSelo	This is the regulatory control seal of the goods. It is optional, can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and should not be informed if \"tpProd\" is equal to \"1\" (service). It must be a string with a length between 1 and 60.
merc.qSelo	This is the quantity of regulatory control seals for the goods available to the company. It is optional and can only be entered if the \"cSelo\" field is also entered. It must be a string with a length between 1 and 12.
merc.nRECOPI	This is the National System for Registration and Control of Immunized Paper Transactions (RECOPI) number of the product. It is optional, can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if the \"tpProd\" field is equal to \"1\" (service). It must be a string with a length of 20.
merc.uInv	This is the unit of measurement of the product for stock and inventory control purposes. It is optional, but can only be entered if the \"tpProd\" field is equal to \"0\" (goods). It should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string with lengths between 1 and 6
merc.fatConv	This is the conversion factor from the commercial unit of measurement to the product inventory unit of measurement. It is optional, but can only be entered if the \"uInv\" field is also entered. It must be an string with up to 4 decimals.
merc.indProp	This is the control and ownership indicator of the product in stock. It is optional and can only be entered if the \"tpProd\" field is equal to \"0\" (goods). It should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=indProp\"
merc.rastro.nLote	This is the batch number of the product subject to traceability. It is optional, it can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and it cannot be informed if the \"tpProd\" field is equal to \"1\" (services). As it may be required by the regulatory body in invoices involving medicines (\"specificProd\" = 2), it is recommended that it be filled in. It must be a string with a length between 1 and 20.
merc.rastro.qLote	This is the batch quantity of the product subject to traceability. It is mandatory when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string with a length of up to 8 whole numbers and up to 3 decimals.
merc.rastro.dFab	This is the manufacturing date of the product batch subject to traceability. It is mandatory when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string in the format \"YYYY-MM-DD\"
merc.rastro.dVal	This is the expiration date of the product batch subject to traceability. It is mandatory when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string in the format \"YYYY-MM-DD\"
merc.rastro.cAgreg	This is the batch aggregation code of the product subject to traceability. It is optional when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string with a size between 1 and 20.
merc.med.cProdANVISA	This is the product registration number at ANVISA. It is mandatory when the \"specificProd\" field is equal to 2 (medicines) and should not be informed in other cases. It must be a string with a length between 1 and 20 and must be filled in with the literal \"ISENTO\" in the case of a medicine exempted from registration with ANVISA.
merc.med.xMotivoIsencao	This is the reason for the product's exemption from registration at ANVISA. It is mandatory only when the \"cProdANVISA\" field is equal to \"ISENTO\" and should not be entered in other cases. It is recommended to enter the number of the decision that exempts the product, such as the number of the ANVISA Board Resolution (RDC). It should be a string with a length between 1 and 255.
merc.med.vPMC	This is the maximum price that should be charged to the consumer, as defined by the regulatory agency. It is mandatory only when the \"cProdANVISA\" field is and should not be entered in other cases. It should be a string with a length of up to 13 integers and up to 2 decimals
merc.med.tipoMed	This is the type of drug defined by the regulatory agency. It is optional, but should only be informed when the \"cProdANVISA\" field is also informed and should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tipoMed\"
merc.med.listaMed	This is the drug classification list defined by the regulatory agency. It is optional, but should only be informed when the \"cProdANVISA\" field is also informed and should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=listaMed\"
merc.comb.cProdANP	This is the product code in the ANP. It is mandatory when the \"specificProd\" field is equal to 4 (Fuel). It should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cProdANP\"
merc.comb.pGLP	This is the percentage (in decimal, values from 0 to 100) of petroleum-derived LPG in the LPG product. It is optional, but can only be entered when \"cProdANP\" field is also entered. It must be a string with a length of up to 3 integers and up to 4 decimals.
merc.comb.pGNn	This is the percentage (in decimal, values from 0 to 100) of National Natural Gas - GLGNn in the LPG product. It is optional, but can only be informed when \"cProdANP\" field is also informed. It must be a string with a length of up to 3 integers and up to 4 decimals.
merc.comb.pGNi	This is the percentage (in decimal, values from 0 to 100) of Imported Natural Gas - GLGNi in the LPG product. It is optional, but can only be informed when \"cProdANP\" field is also informed. It must be a string with a length of up to 3 integers and up to 4 decimals.
merc.comb.vPart	This is the output value per kilo without ICMS of the product. It is optional, but can only be informed when the \"cProdANP\" field informed is equal to \"210203001\". It must be a string with up to 13 integers and up to 2 decimals.
merc.comb.CODIF	This is the CODIF provided by the state of the federation that uses the tax deferral control system in operations with AEAC – Anhydrous Ethyl Alcohol Fuel. It is optional, but can only be entered when the \"cProdANP\" field is also entered. It must be a string with a length of up to 1 and 21.
merc.arma.tpArma	This is the type of weapon defined by the regulatory body. It is mandatory when the \"specificProd\" field is equal to 3 (weapon). It should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpArma\"
merc.arma.nSerie	This is the weapon's manufacturing serial number. It is mandatory when the \"tpArma\" field is entered. It should not be entered in other cases. It must be a string with a length between 1 and 15.
merc.arma.nCano	This is the gun barrel number. It is mandatory when the \"tpArma\" field is entered. It should not be entered in other cases. It must be a string with a length between 1 and 15.
merc.arma.descr	This is the detailed description of the weapon's identification. It is mandatory when the \"tpArma\" field is entered. It should not be provided in other cases. It must be a string with a length between 1 and 256.
merc.veic.tpOp	This is the identifier of the type of vehicle commercial operation. It is mandatory when the \"specificProd\" field is equal to 1 (vehicle) and should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpOp\"
merc.veic.chassi	This is the vehicle's chassis number (VIN - Vehicle Identification Code). It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with a length equal to 17
merc.veic.cCor	This is the company's internal color code. It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 4
merc.veic.xCor	This is the description of the company's internal color code. It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 40
merc.veic.pot	This is the power (in HP) of the vehicle. It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 4
merc.veic.cilin	This is the vehicle's capacity (in cylinder capacity). It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 4
merc.veic.pesoL	This is the weight vehicle weight in tonnes. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string containing up to 9 integers and up to 4 decimals
merc.veic.pesoB	This is the gross vehicle weight in tonnes. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string containing up to 9 integers and up to 4 decimals
merc.veic.nSerie	This is the vehicle serial number. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with a length between 1 and 9
merc.veic.tpComb	This is the vehicle's fuel type. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the provided content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpComb\"
merc.veic.nMotor	This is the vehicle's engine number. It is required when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with length between 1 and 21
merc.veic.CMT	This is the maximum towing capacity of the vehicle in tonnes. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string containing up to 9 integers and up to 4 decimals
merc.veic.dist	This is the wheelbase of the vehicle. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with length between 1 and 4
merc.veic.anoMod	This is the model year of the vehicle. It is required when the \"tpOp\" field is entered and should not be entered otherwise. It must be a string in the format YYYY
merc.veic.anoFab	This is the year of manufacture of the vehicle. It is required when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string in the format YYYY
merc.veic.tpPint	This is the vehicle paint type. It is required when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with length 1
merc.veic.tpVeic	This is the vehicle type. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpVeic\"
merc.veic.espVeic	This is the vehicle type. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=espVeic\"
merc.veic.VIN	This is the VIN (Vehicle Identification Code) code of the vehicle. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the provided content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=VIN\"
merc.veic.condVeic	This is the vehicle condition. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=condVeic\"
merc.veic.cMod	This is the vehicle make and model code according to RENAVAM. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content must be between 1 and 6
merc.veic.cCorDENATRAN	This is the vehicle color code according to DENATRAN. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cCorDENATRAN\"
merc.veic.lota	This is the maximum capacity of the vehicle, i.e. the maximum number of seated passengers allowed, including the driver. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content must be between 1 and 3
merc.veic.tpRest	This is the vehicle restriction type code. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpRest\"
participants.federalDocument	This is the unique federal document that identifies the product supplier. It is optional and can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and should not be informed if \"tpProd\" is equal to \"1\" (service). It must be a string with a length between 1 and 60.
participants.cProd	This is the unique internal code that identifies the product within the supplier company. Should only be provided if the \"participants.federalDocument\" field is provided. It must be a string with length between 1 and 60
participants.cEAN	This is the product's unique Global Trade Item Number (GTIN) (formerly known as EAN code or barcode) within the supplier company. Should only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with lengths of 8, 12, 13, 14 or, if there is no GTIN, the literal \"SEM GTIN\" must be entered
participants.NCM	This is the NCM (Common Nomenclature of Mercosur) code for the product within the supplier company.Should only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with length 2 or 8
participants.EXTIPI	This is the NCM (Mercosur Common Nomenclature) exception code for the product within the supplier company. Can only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with length 2 or 3
participants.CEST	This is the CEST code (Tax Substitution Specifier Code) of the product within the supplier company. Cant only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with length 7
images.imageBase64	This is the product image. It is optional and can only be provided if the \"tpProd\" field is equal to \"0\" (commodity) and should not be provided if \"tpProd\" is equal to \"1\" (service). It must be provided as a string and the content in base64
images.highlighted	This is the indication that the respective product image should be considered as the main one, that is, the one that best portrays the product. It is mandatory if the \"commodity.images.imageBase64\" field is informed. It is a boolean
images.title	This is the title, or name, of the product image. It is required if the \"commodity.images.imageBase64\" field is specified. It must be a string with a length between 1 and 60
images.description	This is the detailed description of the product image. It is required if the \"commodity.images.imageBase64\" field is provided. It must be a string with length between 1 and 120
tags	These are tags that can identify specific product features. It is optional and must be a string object

","urlObject":{"protocol":"{{PROTOCOL}}","path":["products"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"885a20d5-00fb-4322-8406-bc8f3b226d91","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ZjmMe0B75mOItRzETed0FpBRy3pSmfId","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n },\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ],\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api-homologation.omnitax.ai/products"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"product registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"8ed3bb11-27ea-42f5-8ba0-79a9a306127c","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n },\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ],\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"orig\",\n \"messages\": [\n \"Is required\"\n ]\n }\n ]\n}"},{"id":"8be1d627-4126-4d3b-b136-935218ea3124","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n },\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ],\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"fa418da3-e61d-4ebf-b362-35af19d7dee5","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n },\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ],\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"0c09a175-59f7-4cdf-9754-5fb00a46c9da","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n },\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ],\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"companyId\",\n \"messages\": [\n \"Not Found\"\n ]\n }\n ]\n}"},{"id":"dc870b17-c8d2-48eb-a902-3a05fc105bc3","name":"409 Conflict","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"required, string\",\n \"remoteId\": \"optional, string\",\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n },\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ],\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"field\": \"cProd\",\n \"messages\": [\n \"Already exists\"\n ]\n }\n ]\n}"}],"_postman_id":"c407f591-e360-492c-8400-56c99fa8f561"},{"name":"products/list","id":"241a8814-66ad-4547-9f88-6830c4984a45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/list","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","list"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"8c8aebd9-6d92-4aa8-a8d8-0a6370c68a12","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"ZjmMe0B75mOItRzETed0FpBRy3pSmfId","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"\",\n \"limit\": 10,\n \"page\": 1,\n \"filters\": [\n {\n \"name\": \"xProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cEAN\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"NCM\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"serv.cNBS\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"serv.cListServ\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"serv.cTribMun\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"serv.cTribNac\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.CEST\",\n \"type\": \"term\",\n \"values\": [\n \"0901.21\"\n ]\n },\n {\n \"name\": \"merc.rastro.nLote\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.med.cProdANVISA\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.comb.cProdANP\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.veic.chassi\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.arma.nSerie\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.participants.id\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.participants.federalDocument\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.participants.cProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"merc.participants.cEAN\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"createdAt\",\n \"type\": \"range\",\n \"start\": \"AAAA-MM-DDThh:mm:ss.SSSZ\",\n \"end\": \"AAAA-MM-DDThh:mm:ss.SSSZ\"\n },\n {\n \"name\": \"updatedAt\",\n \"type\": \"range\",\n \"start\": \"AAAA-MM-DDThh:mm:ss.SSSZ\",\n \"end\": \"AAAA-MM-DDThh:mm:ss.SSSZ\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api-homologation.omnitax.ai/products/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"createdAt\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"updatedAt\": {\n \"epoch\": 1717006881,\n \"formatted\": \"29/05/2024 - 15:21:21\"\n },\n \"companyId\": \"\",\n \"tpProd\": \"\",\n \"orig\": \"\",\n \"tpIntermedio\": \"\",\n \"xProd\": \"\",\n \"cProd\": \"\",\n \"cProdPreceding\": \"\",\n \"cEAN\": \"\",\n \"cEANTrib\": \"\",\n \"NCM\": \"\",\n \"uCom\": \"\",\n \"qCom\": \"\",\n \"vUnCom\": \"\",\n \"uTrib\": \"\",\n \"qTrib\": \"\",\n \"vUnTrib\": \"\",\n \"serv\": {\n \"cNBS\": \"\",\n \"cListServ\": \"\",\n \"cServico\": \"\",\n \"cTribMun\": \"\",\n \"cTribNac\": \"\"\n },\n \"merc\": {\n \"specificProd\": \"\",\n \"NVE\": [\n \"\"\n ],\n \"EXTIPI\": \"\",\n \"CEST\": \"\",\n \"CNPJFab\": \"\",\n \"marca\": \"\",\n \"tipoEmbalagem\": \"\",\n \"materialEmbalagem\": \"\",\n \"cSelo\": \"\",\n \"qSelo\": \"\",\n \"nRECOPI\": \"\",\n \"uInv\": \"\",\n \"fatConv\": \"\",\n \"indProp\": \"\",\n \"rastro\": [\n {\n \"nLote\": \"\",\n \"qLote\": \"\",\n \"dFab\": \"\",\n \"dVal\": \"\",\n \"cAgreg\": \"\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"\",\n \"xMotivoIsencao\": \"\",\n \"vPMC\": \"\",\n \"tipoMed\": \"\",\n \"listaMed\": \"\"\n },\n \"comb\": {\n \"cProdANP\": \"\",\n \"pGLP\": \"\",\n \"pGNn\": \"\",\n \"pGNi\": \"\",\n \"vPart\": \"\",\n \"CODIF\": \"\"\n },\n \"arma\": {\n \"tpArma\": \"\",\n \"nSerie\": \"\",\n \"nCano\": \"\",\n \"descr\": \"\"\n },\n \"veic\": {\n \"tpOp\": \"\",\n \"chassi\": \"\",\n \"cCor\": \"\",\n \"xCor\": \"\",\n \"pot\": \"\",\n \"cilin\": \"\",\n \"pesoL\": \"\",\n \"pesoB\": \"\",\n \"nSerie\": \"\",\n \"tpComb\": \"\",\n \"nMotor\": \"\",\n \"CMT\": \"\",\n \"dist\": \"\",\n \"anoMod\": \"\",\n \"anoFab\": \"\",\n \"tpPint\": \"\",\n \"tpVeic\": \"\",\n \"espVeic\": \"\",\n \"VIN\": \"\",\n \"condVeic\": \"\",\n \"cMod\": \"\",\n \"cCorDENATRAN\": \"\",\n \"lota\": \"\",\n \"tpRest\": \"\"\n },\n \"participants\": [\n {\n \"federalDocument\": \"\",\n \"cProd\": \"\",\n \"cEAN\": \"\",\n \"NCM\": \"\",\n \"EXTIPI\": \"\",\n \"CEST\": \"\"\n }\n ],\n \"images\": [\n {\n \"highlighted\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"imageBase64\": \"\"\n }\n ]\n },\n \"tags\": [\n \"\"\n ],\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"d5778235-4e39-4a48-ad69-d44304f547e3","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"\",\n \"subsidiaryId\": \"\",\n \"limit\": 10,\n \"page\": 1,\n \"filters\": [\n {\n \"name\": \"xProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cEAN\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"NCM\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"CEST\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cNBS\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cListSer\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cTribMun\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cTribNac\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"rastro.nLote\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"med.cProdANVISA\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"comb.cProdANP\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"veic.chassi\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"arma.nSerie\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.participantId\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.federalDocument\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.cProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.cEAN\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"createdAt\",\n \"type\": \"range\",\n \"values\": [\n {\n \"start\": \"2022-10-01T00:00:00\",\n \"end\": \"2022-10-05T23:59:59\"\n }\n ]\n },\n {\n \"name\": \"updatedAt\",\n \"type\": \"range\",\n \"values\": [\n {\n \"start\": \"2022-10-01T00:00:00\",\n \"end\": \"2022-10-05T23:59:59\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/list"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"3e48a654-05d7-40bf-a662-6836e57b7842","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"companyId\": \"\",\n \"subsidiaryId\": \"\",\n \"limit\": 10,\n \"page\": 1,\n \"filters\": [\n {\n \"name\": \"xProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cEAN\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"NCM\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"CEST\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cNBS\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cListSer\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cTribMun\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"cTribNac\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"rastro.nLote\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"med.cProdANVISA\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"comb.cProdANP\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"veic.chassi\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"arma.nSerie\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.participantId\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.federalDocument\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.cProd\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"participants.cEAN\",\n \"type\": \"term\",\n \"values\": [\n \"\"\n ]\n },\n {\n \"name\": \"createdAt\",\n \"type\": \"range\",\n \"values\": [\n {\n \"start\": \"2022-10-01T00:00:00\",\n \"end\": \"2022-10-05T23:59:59\"\n }\n ]\n },\n {\n \"name\": \"updatedAt\",\n \"type\": \"range\",\n \"values\": [\n {\n \"start\": \"2022-10-01T00:00:00\",\n \"end\": \"2022-10-05T23:59:59\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/list"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"241a8814-66ad-4547-9f88-6830c4984a45"},{"name":"products (detail)","id":"0f62bcf9-90fe-488a-a4dd-c22d5925dd8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}?metadata=true","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}"],"host":["{{API_DOMAIN}}"],"query":[{"key":"metadata","value":"true"}],"variable":[]}},"response":[{"id":"ffdb2a66-2c69-4fc5-a5d1-4a7a16f4ecdf","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"ZjmMe0B75mOItRzETed0FpBRy3pSmfId","type":"text"}],"url":{"raw":"https://api-sandbox.omnitax.ai/products/{productId}?metadata=true","protocol":"https","host":["api-sandbox","omnitax","ai"],"path":["products","{productId}"],"query":[{"key":"metadata","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": {\n \"id\": \"\",\n \"requestId\": \"c1c8b729-057e-4b81-a24c-2472d7681e83\",\n \"remoteId\": null,\n \"createdAt\": {\n \"epoch\": 1717005038,\n \"formatted\": \"29/05/2024 - 14:50:38\"\n },\n \"updatedAt\": {\n \"epoch\": 1717006881,\n \"formatted\": \"29/05/2024 - 15:21:21\"\n },\n \"companyId\": \"\",\n \"tpProd\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"orig\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"tpIntermedio\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"xProd\": \"\",\n \"cProd\": \"\",\n \"cProdPreceding\": \"\",\n \"cEAN\": \"\",\n \"cEANTrib\": \"\",\n \"NCM\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"uCom\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"qCom\": \"\",\n \"vUnCom\": \"\",\n \"uTrib\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"qTrib\": \"\",\n \"vUnTrib\": \"\",\n \"serv\": {\n \"cNBS\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cListServ\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cServico\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cTribMun\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cTribNac\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n },\n \"merc\": {\n \"specificProd\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"NVE\": [\n \"\"\n ],\n \"CEST\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"EXTIPI\": \"\",\n \"CNPJFab\": \"\",\n \"marca\": \"\",\n \"tipoEmbalagem\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"materialEmbalagem\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cSelo\": \"\",\n \"qSelo\": \"\",\n \"nRECOPI\": \"\",\n \"uInv\": \"\",\n \"fatConv\": \"\",\n \"indProp\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"rastro\": [\n {\n \"nLote\": \"\",\n \"qLote\": \"\",\n \"dFab\": \"\",\n \"dVal\": \"\",\n \"cAgreg\": \"\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"\",\n \"xMotivoIsencao\": \"\",\n \"vPMC\": \"\",\n \"tipoMed\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"listaMed\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n },\n \"comb\": {\n \"cProdANP\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"pGLP\": \"\",\n \"pGNn\": \"\",\n \"pGNi\": \"\",\n \"vPart\": \"\",\n \"CODIF\": \"\"\n },\n \"arma\": {\n \"tpArma\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"nSerie\": \"\",\n \"nCano\": \"\",\n \"descr\": \"\"\n },\n \"veic\": {\n \"tpOp\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"chassi\": \"\",\n \"cCor\": \"\",\n \"xCor\": \"\",\n \"pot\": \"\",\n \"cilin\": \"\",\n \"pesoL\": \"\",\n \"pesoB\": \"\",\n \"nSerie\": \"\",\n \"tpComb\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"nMotor\": \"\",\n \"CMT\": \"\",\n \"dist\": \"\",\n \"anoMod\": \"\",\n \"anoFab\": \"\",\n \"tpPint\": \"\",\n \"tpVeic\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"espVeic\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"VIN\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"condVeic\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"cMod\": \"\",\n \"cCorDENATRAN\": {\n \"code\": \"\",\n \"description\": \"\"\n },\n \"lota\": \"\",\n \"tpRest\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n },\n \"participants\": [\n {\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"cProd\": \"\",\n \"cEAN\": \"\",\n \"NCM\": \"\",\n \"EXTIPI\": \"\",\n \"CEST\": \"\"\n }\n ],\n \"images\": [\n {\n \"id\": \"\",\n \"highlighted\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"imageBase64\": \"\"\n }\n ]\n },\n \"tags\": [\n \"\"\n ],\n \"enabled\": true,\n \"transactions\": [\n \"\"\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n}"},{"id":"d75a47ff-8b74-45e5-99eb-e85263492e4b","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}?metadata=true","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}"],"query":[{"key":"metadata","value":"true"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"efdec822-65ec-44e1-a63b-11dfff2408e9","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}?metadata=true","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}"],"query":[{"key":"metadata","value":"true"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"4b9be89e-dfa0-4a4e-a417-aff1d67b85f8","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}?metadata=true","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}"],"query":[{"key":"metadata","value":"true"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"0f62bcf9-90fe-488a-a4dd-c22d5925dd8e"},{"name":"products","id":"3e943d4d-9dc4-486b-9e0e-10f04f4bfab6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}","description":"

`field`	`Details`
remoteId	This is the own control code generated and managed exclusively by the requester to uniquely identify each request made by him to the platform. It is optional, it must be a string, and can't exceed 256 characters.
tpProd	This is the code that defines the type of product, whether goods (enter 0) or service (enter 1). It is mandatory and must be a string.
orig	This is the code that defines the origin of the product, whether national or imported. It is mandatory, must be a string and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=orig\"
tpIntermedio	This is the indicator of the form of intermediation of the import of a product, whether of the type of goods or service. It is mandatory when the \"orig\" field is equal to 1, 2, 3, 8 or 10 and should not be informed in other cases. It must be a string and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey= tpIntermedio\"
xProd	This is the detailed description of the product, whether it is a goods or service. It is mandatory and must be a string with a length between 1 and 120.
cProd	This is the company's internal code for unique product identification, whether it is a product or service. It is mandatory and must be a string with a length between 1 and 60.
cProdPreceding	This is an internal code previously used by the company to uniquely identify the product, whether it is a goods or service. It is optional and must be a string with a length between 1 and 60.
cEAN	This is the unique GTIN (Global Trade Item Number) code to identify the product. It is optional and must be a string with lengths of 8, 12, 13, 14 or the literal \"SEM GTIN\".
cEANTrib	This is the unique taxable GTIN (Global Trade Item Number) code to identify the product. It is optional and must be a string with lengths of 8, 12, 13, 14 or the literal \"SEM GTIN\".
NCM	This is the NCM (Common Nomenclature of Mercosur) code used by the company for the product. It is mandatory and must be a character sequence with 8 elements (if tpProd = '0' - merchandise) or 2 elements (if tpProd = '1' - service). Valid values can be obtained at \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=NCM\".
uCom	This is the commercial unit of measurement for the product, whether it is a goods or services type. It is mandatory, it must be a string with a length between 1 and 6 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=medida\"
qCom	This is the commercial quantity of the product, whether it is a goods or services. It is mandatory and must be a string with a length between 1 and 11 integers and between 1 and 4 decimals.
vUnCom	This is the commercial unit value of the product, whether it is a goods or a service. It is mandatory and must be a string with a length 13 integers and up to 2 decimals
uTrib	This is the taxable unit of measurement for the product, whether it is a goods or services type. It is optional, it must be a string with a length between 1 and 6 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=medida\"
qTrib	This is the taxable quantity of the product, whether it is a goods or services type. It is optional and must be a string with a length between 1 and 11 integers and between 1 and 4 decimals.
vUnTrib	This is the taxable unit value of the product, whether it is a goods or services type. It is optional and must be a string with a length 13 integers and up to 2 decimals
serv.cNBS	This is the NBS (Brazilian Nomenclature of Services) code of the product. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 9 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cNBS\"
serv.cListServ	This is the service code according to the Brazilian Federal Complementary Law No. 116/2003. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 5 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribNac\"
serv.cServico	This is the service code according to the Municipal Law. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 5 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribNac\"
serv.cTribMun	This is the service code according to the Municipal Law. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 3 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribMun\"
serv.cTribNac	This is the service code according to Federal Law. It is optional if the \"tpProd\" field is equal to \"1\" (service) and should not be informed if the \"tpProd\" field is equal to \"0\" (goods). It must be a string with a length of 6 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cTribNac\"
merc.specificProd	This is the product specificity indicator. It is mandatory and can only be entered if the \"tpProd\" field is equal to \"0\" (goods). It should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=specificProd\"
merc.NCM	This is the NCM (Mercosur Common Nomenclature) code used by the company for the product. It is mandatory and must be a string of characters with a length equal to 8. Possible valid values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=NCM\".
merc.EXTIPI	This is the NCM (Mercosur Common Nomenclature) exception code for the product. It is optional and must be a string with a length of 2 or 3.
merc.NVE	This is the NVE (Nomenclature of Customs and Statistical Values) code of the product. It is optional, but can only be informed if the \"NCM\" field is also informed. It must be an array of objects with a limit of 8 items and a format for each item must have two uppercase letters and 4 digits, for example: \"AA0001\"
merc.CEST	This is the CEST code (Tax Substitution Specifier Code) of the product. It is optional, but can only be informed if the \"NCM\" field is also informed. It must be a string with a length of 7 and the possible values can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=CEST\"
merc.CNPJFab	This is the federal document that identifies the manufacturer of the product, regardless of whether or not this manufacturer belongs to the company where the product will be registered. It is optional, can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if the \"tpProd\" field is equal to \"1\" (service). It must be a string with a length between 1 and 20.
merc.marca	This is the brand of the goods. It is optional, it can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string with a length between 1 and 256.
merc.tipoEmbalagem	This is the type of packaging used in the goods. It is optional, can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tipoEmbalagem\"
merc.materialEmbalagem	This is the predominant material used in the packaging of the goods. It is optional, can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and should not be informed if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=materialEmbalagem\"
merc.cSelo	This is the regulatory control seal of the goods. It is optional, can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and should not be informed if \"tpProd\" is equal to \"1\" (service). It must be a string with a length between 1 and 60.
merc.qSelo	This is the quantity of regulatory control seals for the goods available to the company. It is optional and can only be entered if the \"cSelo\" field is also entered. It must be a string with a length between 1 and 12.
merc.nRECOPI	This is the National System for Registration and Control of Immunized Paper Transactions (RECOPI) number of the product. It is optional, can only be entered if the \"tpProd\" field is equal to \"0\" (goods) and should not be entered if the \"tpProd\" field is equal to \"1\" (service). It must be a string with a length of 20.
merc.uInv	This is the unit of measurement of the product for stock and inventory control purposes. It is optional, but can only be entered if the \"tpProd\" field is equal to \"0\" (goods). It should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string with lengths between 1 and 6
merc.fatConv	This is the conversion factor from the commercial unit of measurement to the product inventory unit of measurement. It is optional, but can only be entered if the \"uInv\" field is also entered. It must be an string with up to 4 decimals.
merc.indProp	This is the control and ownership indicator of the product in stock. It is optional and can only be entered if the \"tpProd\" field is equal to \"0\" (goods). It should not be entered if \"tpProd\" is equal to \"1\" (service). It must be a string and possible values can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=indProp\"
merc.rastro.nLote	This is the batch number of the product subject to traceability. It is optional, it can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and it cannot be informed if the \"tpProd\" field is equal to \"1\" (services). As it may be required by the regulatory body in invoices involving medicines (\"specificProd\" = 2), it is recommended that it be filled in. It must be a string with a length between 1 and 20.
merc.rastro.qLote	This is the batch quantity of the product subject to traceability. It is mandatory when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string with a length of up to 8 whole numbers and up to 3 decimals.
merc.rastro.dFab	This is the manufacturing date of the product batch subject to traceability. It is mandatory when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string in the format \"YYYY-MM-DD\"
merc.rastro.dVal	This is the expiration date of the product batch subject to traceability. It is mandatory when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string in the format \"YYYY-MM-DD\"
merc.rastro.cAgreg	This is the batch aggregation code of the product subject to traceability. It is optional when the \"nLote\" field is informed and cannot be informed when the \"nLote\" field is not informed. It must be a string with a size between 1 and 20.
merc.med.cProdANVISA	This is the product registration number at ANVISA. It is mandatory when the \"specificProd\" field is equal to 2 (medicines) and should not be informed in other cases. It must be a string with a length between 1 and 20 and must be filled in with the literal \"ISENTO\" in the case of a medicine exempted from registration with ANVISA.
merc.med.xMotivoIsencao	This is the reason for the product's exemption from registration at ANVISA. It is mandatory only when the \"cProdANVISA\" field is equal to \"ISENTO\" and should not be entered in other cases. It is recommended to enter the number of the decision that exempts the product, such as the number of the ANVISA Board Resolution (RDC). It should be a string with a length between 1 and 255.
merc.med.vPMC	This is the maximum price that should be charged to the consumer, as defined by the regulatory agency. It is mandatory only when the \"cProdANVISA\" field is and should not be entered in other cases. It should be a string with a length of up to 13 integers and up to 2 decimals
merc.med.tipoMed	This is the type of drug defined by the regulatory agency. It is optional, but should only be informed when the \"cProdANVISA\" field is also informed and should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tipoMed\"
merc.med.listaMed	This is the drug classification list defined by the regulatory agency. It is optional, but should only be informed when the \"cProdANVISA\" field is also informed and should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=listaMed\"
merc.comb.cProdANP	This is the product code in the ANP. It is mandatory when the \"specificProd\" field is equal to 4 (Fuel). It should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cProdANP\"
merc.comb.pGLP	This is the percentage (in decimal, values from 0 to 100) of petroleum-derived LPG in the LPG product. It is optional, but can only be entered when \"cProdANP\" field is also entered. It must be a string with a length of up to 3 integers and up to 4 decimals.
merc.comb.pGNn	This is the percentage (in decimal, values from 0 to 100) of National Natural Gas - GLGNn in the LPG product. It is optional, but can only be informed when \"cProdANP\" field is also informed. It must be a string with a length of up to 3 integers and up to 4 decimals.
merc.comb.pGNi	This is the percentage (in decimal, values from 0 to 100) of Imported Natural Gas - GLGNi in the LPG product. It is optional, but can only be informed when \"cProdANP\" field is also informed. It must be a string with a length of up to 3 integers and up to 4 decimals.
merc.comb.vPart	This is the output value per kilo without ICMS of the product. It is optional, but can only be informed when the \"cProdANP\" field informed is equal to \"210203001\". It must be a string with up to 13 integers and up to 2 decimals.
merc.comb.CODIF	This is the CODIF provided by the state of the federation that uses the tax deferral control system in operations with AEAC – Anhydrous Ethyl Alcohol Fuel. It is optional, but can only be entered when the \"cProdANP\" field is also entered. It must be a string with a length of up to 1 and 21.
merc.arma.tpArma	This is the type of weapon defined by the regulatory body. It is mandatory when the \"specificProd\" field is equal to 3 (weapon). It should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpArma\"
merc.arma.nSerie	This is the weapon's manufacturing serial number. It is mandatory when the \"tpArma\" field is entered. It should not be entered in other cases. It must be a string with a length between 1 and 15.
merc.arma.nCano	This is the gun barrel number. It is mandatory when the \"tpArma\" field is entered. It should not be entered in other cases. It must be a string with a length between 1 and 15.
merc.arma.descr	This is the detailed description of the weapon's identification. It is mandatory when the \"tpArma\" field is entered. It should not be provided in other cases. It must be a string with a length between 1 and 256.
merc.veic.tpOp	This is the identifier of the type of vehicle commercial operation. It is mandatory when the \"specificProd\" field is equal to 1 (vehicle) and should not be informed in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpOp\"
merc.veic.chassi	This is the vehicle's chassis number (VIN - Vehicle Identification Code). It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with a length equal to 17
merc.veic.cCor	This is the company's internal color code. It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 4
merc.veic.xCor	This is the description of the company's internal color code. It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 40
merc.veic.pot	This is the power (in HP) of the vehicle. It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 4
merc.veic.cilin	This is the vehicle's capacity (in cylinder capacity). It is mandatory when the \"tpOp\" field is informed and should not be informed in other cases. It must be a string with a length between 1 and 4
merc.veic.pesoL	This is the weight vehicle weight in tonnes. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string containing up to 9 integers and up to 4 decimals
merc.veic.pesoB	This is the gross vehicle weight in tonnes. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string containing up to 9 integers and up to 4 decimals
merc.veic.nSerie	This is the vehicle serial number. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with a length between 1 and 9
merc.veic.tpComb	This is the vehicle's fuel type. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the provided content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpComb\"
merc.veic.nMotor	This is the vehicle's engine number. It is required when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with length between 1 and 21
merc.veic.CMT	This is the maximum towing capacity of the vehicle in tonnes. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string containing up to 9 integers and up to 4 decimals
merc.veic.dist	This is the wheelbase of the vehicle. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with length between 1 and 4
merc.veic.anoMod	This is the model year of the vehicle. It is required when the \"tpOp\" field is entered and should not be entered otherwise. It must be a string in the format YYYY
merc.veic.anoFab	This is the year of manufacture of the vehicle. It is required when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string in the format YYYY
merc.veic.tpPint	This is the vehicle paint type. It is required when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string with length 1
merc.veic.tpVeic	This is the vehicle type. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpVeic\"
merc.veic.espVeic	This is the vehicle type. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=espVeic\"
merc.veic.VIN	This is the VIN (Vehicle Identification Code) code of the vehicle. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the provided content can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=VIN\"
merc.veic.condVeic	This is the vehicle condition. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=condVeic\"
merc.veic.cMod	This is the vehicle make and model code according to RENAVAM. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content must be between 1 and 6
merc.veic.cCorDENATRAN	This is the vehicle color code according to DENATRAN. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained in \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=cCorDENATRAN\"
merc.veic.lota	This is the maximum capacity of the vehicle, i.e. the maximum number of seated passengers allowed, including the driver. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content must be between 1 and 3
merc.veic.tpRest	This is the vehicle restriction type code. It is mandatory when the \"tpOp\" field is entered and should not be entered in other cases. It must be a string and the content provided can be obtained from \"GET/metadata?page=1&limit=50&partitionKey=BRA_TAX_INFO&sortKey=tpRest\"
participants.federalDocument	This is the unique federal document that identifies the product supplier. It is optional and can only be informed if the \"tpProd\" field is equal to \"0\" (goods) and should not be informed if \"tpProd\" is equal to \"1\" (service). It must be a string with a length between 1 and 60.
participants.cProd	This is the unique internal code that identifies the product within the supplier company. Should only be provided if the \"participants.federalDocument\" field is provided. It must be a string with length between 1 and 60
participants.cEAN	This is the product's unique Global Trade Item Number (GTIN) (formerly known as EAN code or barcode) within the supplier company. Should only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with lengths of 8, 12, 13, 14 or, if there is no GTIN, the literal \"SEM GTIN\" must be entered
participants.NCM	This is the NCM (Common Nomenclature of Mercosur) code for the product within the supplier company.Should only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with length 2 or 8
participants.EXTIPI	This is the NCM (Mercosur Common Nomenclature) exception code for the product within the supplier company. Can only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with length 2 or 3
participants.CEST	This is the CEST code (Tax Substitution Specifier Code) of the product within the supplier company. Cant only be provided if the \"participants.federalDocument\" field is provided. In this case, it must be a string with length 7
images.imageBase64	This is the product image. It is optional and can only be provided if the \"tpProd\" field is equal to \"0\" (commodity) and should not be provided if \"tpProd\" is equal to \"1\" (service). It must be provided as a string and the content in base64
images.highlighted	This is the indication that the respective product image should be considered as the main one, that is, the one that best portrays the product. It is mandatory if the \"commodity.images.imageBase64\" field is informed. It is a boolean
images.title	This is the title, or name, of the product image. It is required if the \"commodity.images.imageBase64\" field is specified. It must be a string with a length between 1 and 60
images.description	This is the detailed description of the product image. It is required if the \"commodity.images.imageBase64\" field is provided. It must be a string with length between 1 and 120
tags	These are tags that can identify specific product features. It is optional and must be a string object
enabled	This information defines whether your products is enabled to receive and process requests. It is optional, must be a boolean and the content provided must be true or false.

","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"90903378-2002-4ddf-b196-69da19700049","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"ZjmMe0B75mOItRzETed0FpBRy3pSmfId","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n }\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api-homologation.omnitax.ai/products/{productId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product updated successfully\"\n}"},{"id":"5a76e60f-0acc-41b9-bfd1-ac128da68a44","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n }\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"d1e00ec3-5780-42bf-81ed-d301bda53e88","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n }\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"32b39f7e-2b39-4518-b148-e1aa011f86cc","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"tpProd\": \"required, string\",\n \"orig\": \"required, string\",\n \"tpIntermedio\": \"conditional, string\",\n \"xProd\": \"required, string\",\n \"cProd\": \"required, string\",\n \"cProdPreceding\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"cEANTrib\": \"optional, string\",\n \"NCM\": \"required, string\",\n \"uCom\": \"required, string\",\n \"qCom\": \"required, string\",\n \"vUnCom\": \"required, string\",\n \"uTrib\": \"optional, string\",\n \"qTrib\": \"optional, string\",\n \"vUnTrib\": \"optional, string\",\n \"serv\": {\n \"cNBS\": \"conditional, string\",\n \"cListServ\": \"conditional, string\",\n \"cServico\": \"conditional, string\",\n \"cTribMun\": \"conditional, string\",\n \"cTribNac\": \"conditional, string\"\n },\n \"merc\": {\n \"specificProd\": \"conditional, string\",\n \"EXTIPI\": \"optional, string\",\n \"NVE\": [\n \"conditional, string\"\n ],\n \"CEST\": \"conditional, string\",\n \"CNPJFab\": \"conditional, string\",\n \"marca\": \"conditional, string\",\n \"tipoEmbalagem\": \"conditional, string\",\n \"materialEmbalagem\": \"conditional, string\",\n \"cSelo\": \"conditional, string\",\n \"qSelo\": \"conditional, string\",\n \"nRECOPI\": \"conditional, string\",\n \"uInv\": \"conditional, string\",\n \"fatConv\": \"conditional, string\",\n \"indProp\": \"conditional, string\",\n \"rastro\": [\n {\n \"nLote\": \"conditional, string\",\n \"qLote\": \"conditional, string\",\n \"dFab\": \"conditional, string\",\n \"dVal\": \"conditional, string\",\n \"cAgreg\": \"conditional, string\"\n }\n ],\n \"med\": {\n \"cProdANVISA\": \"conditional, string\",\n \"xMotivoIsencao\": \"conditional, string\",\n \"vPMC\": \"conditional, string\",\n \"tipoMed\": \"conditional, string\",\n \"listaMed\": \"conditional, string\"\n },\n \"comb\": {\n \"cProdANP\": \"conditional, string\",\n \"pGLP\": \"conditional, string\",\n \"pGNn\": \"conditional, string\",\n \"pGNi\": \"conditional, string\",\n \"vPart\": \"conditional, string\",\n \"CODIF\": \"conditional, string\"\n },\n \"arma\": [\n {\n \"tpArma\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"nCano\": \"conditional, string\",\n \"descr\": \"conditional, string\"\n }\n ],\n \"veic\": {\n \"tpOp\": \"conditional, string\",\n \"chassi\": \"conditional, string\",\n \"cCor\": \"conditional, string\",\n \"xCor\": \"conditional, string\",\n \"pot\": \"conditional, string\",\n \"cilin\": \"conditional, string\",\n \"pesoL\": \"conditional, string\",\n \"pesoB\": \"conditional, string\",\n \"nSerie\": \"conditional, string\",\n \"tpComb\": \"conditional, string\",\n \"nMotor\": \"conditional, string\",\n \"CMT\": \"conditional, string\",\n \"dist\": \"conditional, string\",\n \"anoMod\": \"conditional, string\",\n \"anoFab\": \"conditional, string\",\n \"tpPint\": \"conditional, string\",\n \"tpVeic\": \"conditional, string\",\n \"espVeic\": \"conditional, string\",\n \"VIN\": \"conditional, string\",\n \"condVeic\": \"conditional, string\",\n \"cMod\": \"conditional, string\",\n \"cCorDENATRAN\": \"conditional, string\",\n \"lota\": \"conditional, string\",\n \"tpRest\": \"conditional, string\"\n }\n },\n \"tags\": [\n \"optional, string\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"3e943d4d-9dc4-486b-9e0e-10f04f4bfab6"},{"name":"products","id":"534b6a65-4e7d-439c-a947-9b4408e72898","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"fbe978cc-5979-4b48-b2c5-9654ac201cc4","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product removed successfully\"\n}"},{"id":"32993b0b-838c-4e1c-80bc-2a4d5c00b65d","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"5a7feee6-ac14-40b3-809d-9e3fa3187674","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"289616c1-40b0-4756-bca5-4ef152a54a99","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"534b6a65-4e7d-439c-a947-9b4408e72898"},{"name":"products/company","id":"58ff5058-d24c-4a50-893c-84dea3be5944","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/company/{companyId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","company","{companyId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"eaa53f8c-2750-44c6-9bac-7b6a94c98daf","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/company/{companyId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Products removed successfully\"\n}"},{"id":"14c24186-0148-4d15-b7f8-e3822f694bc0","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/company/{companyId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"1754badf-a730-4f48-98ed-3035cac46193","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/company/{companyId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"74df05de-2d3e-4e54-903f-ce95f29661f2","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/company/{companyId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"58ff5058-d24c-4a50-893c-84dea3be5944"},{"name":"products/images","id":"2d60ca4d-58f6-4953-b653-3112e25ae014","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","images"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"43fbcf58-fe1b-4419-bd45-63abbac1cda0","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Image registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"4d6abc55-7675-42c9-a6ce-eee9b144dba2","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"b3016a9a-3973-44c3-9c98-ed1770a1559d","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"46ba1d62-fc49-4267-9e7c-3c102f35deb7","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"images\": [\n {\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"2d60ca4d-58f6-4953-b653-3112e25ae014"},{"name":"products/images (list)","id":"81206c18-c5ca-4e8a-b4e7-f88eaed4c28e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images?page=1&limit=50","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","images"],"host":["{{API_DOMAIN}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"680e57c4-2b51-4ff3-94e4-e7a2b7d7ebbd","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"GrkiNZsKIwQEcXpY1vNJQhKlPsfVWUnT","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-sandbox.omnitax.ai/products/{productId}/images?page=1&limit=50","protocol":"https","host":["api-sandbox","omnitax","ai"],"path":["products","{productId}","images"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"images\": [\n {\n \"id\": \"\",\n \"highlighted\": true,\n \"title\": \"\",\n \"description\": \"\",\n \"imageBase64\": \"\"\n }\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"36ee9487-2e88-4376-a1dc-fc7bd7fe1eef","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images?page=1&limit=50","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}","images"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"3312dff2-4757-4868-ab37-158972c0b0bd","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images?page=1&limit=50","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}","images"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ddb85727-4565-4e8a-aba4-45f445023506","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"highlighted\": true,\n \"title\": \"\",\n \"description\": \"\",\n \"imageBase64\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images?page=1&limit=50","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}","images"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"81206c18-c5ca-4e8a-b4e7-f88eaed4c28e"},{"name":"products/images","id":"61b70680-6961-4cc4-bef0-0576dea5e5a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","images","{imageId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"67db3811-8dad-4599-acb8-1e7ff268213f","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Image updated successfully\"\n}"},{"id":"0404ea12-2309-4560-bfc4-e2ba696d3724","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"7ea24e86-d13a-46c8-9ff2-cab5a4b676b6","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"fa0cb521-79f6-4381-bbed-b88ae538f86c","name":"404 Not Found","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"highlighted\": \"optional, boolean\",\n \"title\": \"optional, string\",\n \"description\": \"optional, string\",\n \"imageBase64\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"61b70680-6961-4cc4-bef0-0576dea5e5a4"},{"name":"products/images","id":"6e6701aa-4132-46b4-960d-3d108ec40d86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","images","{imageId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"07fdf635-aa0d-4f65-a45a-36d0e6d2ef86","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Image removed successfully\"\n}"},{"id":"5b3f878d-3743-4d3d-824f-e9eb4a62eb59","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"d14924ec-1771-4e4c-b5a1-648c32eb1950","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"00fed421-4275-43b2-a750-0220196840bc","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"highlighted\": true,\n \"title\": \"\",\n \"description\": \"\",\n \"imageBase64\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/images/{imageId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"6e6701aa-4132-46b4-960d-3d108ec40d86"},{"name":"products/participants","id":"211aac72-8127-4d66-82c7-bbc30c1ac50d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","participants"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"39d2181a-3774-44db-9f3a-7a981949f19e","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Participant registered with success\",\n \"id\": \"f398be01-62c1-4248-93db-7d659ab97491\"\n}"},{"id":"36d2d43d-a662-4881-a7ee-68496c959f5f","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"cf2fa291-9974-4616-acde-282ff0c623e2","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"e821e31d-e686-4e78-9578-40f6fd6da983","name":"404 Not Found","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"merc\": {\n \"participants\": [\n {\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"211aac72-8127-4d66-82c7-bbc30c1ac50d"},{"name":"products/participants","id":"675a9bad-64b6-4606-ab44-341a4cfdf133","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants?page=1&limit=50","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","participants"],"host":["{{API_DOMAIN}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}],"variable":[]}},"response":[{"id":"580152c3-5e09-45df-8a73-b48d58ab9abc","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants?page=1&limit=50","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}","participants"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"participants\": [\n {\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"cProd\": \"\",\n \"cEAN\": \"\",\n \"NCM\": \"\",\n \"EXTIPI\": \"\",\n \"CEST\": \"\"\n }\n ],\n \"company\": {\n \"subsidiariesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"federalDocument\": \"\",\n \"name\": \"\",\n \"account\": {\n \"companiesTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"whitelabel\": {\n \"accountsTotal\": 0,\n \"usersTotal\": 0,\n \"id\": \"\",\n \"name\": \"\",\n \"domain\": \"\"\n }\n }\n }\n }\n ],\n \"totalItems\": 1\n}"},{"id":"d3d37525-4fa9-4d6c-a10a-60c3eea8fbee","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants?page=1&limit=50","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}","participants"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"5c3732d9-81c1-4013-bafd-f0de68b9a31e","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants?page=1&limit=50","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}","participants"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"40c215a4-7b75-42d7-b9d6-329860f415ed","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"highlighted\": true,\n \"title\": \"\",\n \"description\": \"\",\n \"imageBase64\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants?page=1&limit=50","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["products","{productId}","participants"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"675a9bad-64b6-4606-ab44-341a4cfdf133"},{"name":"products/participants","id":"fdb2056a-d93b-43ea-bfb0-fec727f2be90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","participants","{participantId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"e633a40f-0e1c-4ba7-a591-04c5200779b6","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Participant updated successfully\"\n}"},{"id":"5925ed8a-18e1-4a8a-8dc4-8d5cafc3a7ef","name":"401 Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"0a3fa154-b7f2-4189-9cca-6d9cae3d283d","name":"403 Forbidden","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"ff3a7280-c106-42c0-b40c-c3a0a503089a","name":"404 Not Found","originalRequest":{"method":"PATCH","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"federalDocument\": \"optional, string\",\n \"cProd\": \"optional, string\",\n \"cEAN\": \"optional, string\",\n \"NCM\": \"optional, string\",\n \"EXTIPI\": \"optional, string\",\n \"CEST\": \"optional, string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"fdb2056a-d93b-43ea-bfb0-fec727f2be90"},{"name":"products/participants","id":"0e6de083-722a-460a-b847-001284be821a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}","urlObject":{"protocol":"{{PROTOCOL}}","path":["products","{productId}","participants","{participantId}"],"host":["{{API_DOMAIN}}"],"query":[],"variable":[]}},"response":[{"id":"805f60db-f81e-4906-a524-f4b31e84fee1","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:04:10 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"577"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"ec7fa0b1-22de-46af-91bf-b01621b92d89"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"x-amz-apigw-id","value":"c6EuoEvJIAMEjzg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71b2a-1c64439c2e426e9e30d7d432;Parent=5fba23192d49236b;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Participant removed successfully\"\n}"},{"id":"b1780c3d-18ce-4640-91fe-31c467b1ac67","name":"401 Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"f887eb49-601b-4d9b-96ef-98caa4917815","name":"403 Forbidden","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 10:54:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a0d79a99-4b6a-458a-9864-66f6391859fc"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6DQdE-soAMEcOQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c718cf-4b4913e00a74049e177139c9;Parent=7af0b2486a32fc30;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"547e5e56-9286-4149-aba8-bdf70806fb67","name":"410 Gone","originalRequest":{"method":"DELETE","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"highlighted\": true,\n \"title\": \"\",\n \"description\": \"\",\n \"imageBase64\": \"\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{PROTOCOL}}://{{API_DOMAIN}}/products/{productId}/participants/{participantId}"},"status":"Gone","code":410,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 22 Aug 2024 11:09:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"51"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"a585d32f-a170-46bd-8736-8faebaa77215"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"c6FdOGQtIAMEOgw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-66c71c54-6dc353b61266580120584f45;Parent=37ef11bcf7cc54eb;Sampled=0;lineage=f74861cf:0"},{"key":"Access-Control-Allow-Credentials","value":"true"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Gone\"\n}"}],"_postman_id":"0e6de083-722a-460a-b847-001284be821a"}],"id":"431acbaf-c7a2-4f71-ab05-c91bd24cf407","description":"

Endpoints for managing product catalog, stock and inventories

Users can register products with a previously selected company. Registration can be done directly or by importing an electronic tax document supported by the platform. Product identification data, especially \"cProd\" and \"cEAN\", must be entered from the perspective of the company that owns the product, as they will be entered in its tax and accounting records. In order for the platform to be able to perform the automatic association (FROM: Supplier Code | TO: Company Code), it is recommended that, when registering a product, you also enter the data that identifies it to the supplier.

\n","_postman_id":"431acbaf-c7a2-4f71-ab05-c91bd24cf407"},{"name":"metadata","item":[{"name":"metadata (list)","id":"afed5811-971c-4c53-be95-c8668a54eb1e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":"{{PROTOCOL}}://{{API_DOMAIN}}/metadata?page=1&limit=50&sort=asc&orderBy=createdAt&partitionKey=ZIPCODE&sortKey=SP&code=01043000&attributesToFilter=zipCode&q=69902449","urlObject":{"protocol":"{{PROTOCOL}}","path":["metadata"],"host":["{{API_DOMAIN}}"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"50"},{"key":"sort","value":"asc"},{"key":"orderBy","value":"createdAt"},{"key":"partitionKey","value":"ZIPCODE"},{"key":"sortKey","value":"SP"},{"key":"code","value":"01043000"},{"key":"attributesToFilter","value":"zipCode"},{"key":"q","value":"69902449"}],"variable":[]}},"response":[{"id":"2a8c8337-d657-422c-9e72-291d0fa49913","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/metadata?page=1&limit=50&sort=asc&orderBy=createdAt&partitionKey=ZIPCODE&sortKey=SP&attributesToFilter=zipCode&q=69902449","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["metadata"],"query":[{"key":"page","value":"1","description":"page (required)"},{"key":"limit","value":"50","description":"limit (required)"},{"key":"sort","value":"asc","description":"sort (optional) - asc or desc"},{"key":"orderBy","value":"createdAt","description":"orderBy (optional) - createdAt, updatedAt"},{"key":"partitionKey","value":"ZIPCODE","description":"required: e.g \"BRA_TAX_INFO\", \"ZIPCODE\""},{"key":"sortKey","value":"SP","description":"required: e.g \"codQualif\", \"SP\""},{"key":"attributesToFilter","value":"zipCode","description":"optional: filter per attributes"},{"key":"q","value":"69902449","description":"optional: filter per attirbutes"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": [\n {\n \"id\": \"\",\n \"createdAt\": {\n \"epoch\": 1739364078,\n \"formatted\": \"12/02/2025 - 09:41:18\"\n },\n \"updatedAt\": null,\n \"partitionKey\": \"\",\n \"sortKey\": \"\",\n \"public\": true,\n \"uniqueAttribute\": \"\",\n \"attributes\": {}\n }\n ],\n \"totalItems\": 1\n}"},{"id":"08ce9396-33f3-40f3-9ec0-91357d1dd7c2","name":"401 Unauthorized","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/metadata?page=1&limit=50&sort=asc&orderBy=createdAt&partitionKey=ZIPCODE&sortKey=SP&attributesToFilter=zipCode&q=69902449","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["metadata"],"query":[{"key":"page","value":"1","description":"page (required)"},{"key":"limit","value":"50","description":"limit (required)"},{"key":"sort","value":"asc","description":"sort (optional) - asc or desc"},{"key":"orderBy","value":"createdAt","description":"orderBy (optional) - createdAt, updatedAt"},{"key":"partitionKey","value":"ZIPCODE","description":"required: e.g \"BRA_TAX_INFO\", \"ZIPCODE\""},{"key":"sortKey","value":"SP","description":"required: e.g \"codQualif\", \"SP\""},{"key":"attributesToFilter","value":"zipCode","description":"optional: filter per attributes"},{"key":"q","value":"69902449","description":"optional: filter per attributes"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"},{"id":"695bca5b-115a-4ac1-89fc-9f1a7e8743f9","name":"403 Forbidden","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/metadata?page=1&limit=50&sort=asc&orderBy=createdAt&partitionKey=ZIPCODE&sortKey=SP&attributesToFilter=zipCode&q=69902449","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["metadata"],"query":[{"key":"page","value":"1","description":"page (required)"},{"key":"limit","value":"50","description":"limit (required)"},{"key":"sort","value":"asc","description":"sort (optional) - asc or desc"},{"key":"orderBy","value":"createdAt","description":"orderBy (optional) - createdAt, updatedAt"},{"key":"partitionKey","value":"ZIPCODE","description":"required: e.g \"BRA_TAX_INFO\", \"ZIPCODE\""},{"key":"sortKey","value":"SP","description":"required: e.g \"codQualif\", \"SP\""},{"key":"attributesToFilter","value":"zipCode","description":"optional: filter per attributes"},{"key":"q","value":"69902449","description":"optional: filter per attributes"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"},{"id":"f074e06f-830e-4a35-a426-32c1ff694c3b","name":"404 Not found","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{X_API_KEY}}","type":"text"}],"url":{"raw":"{{PROTOCOL}}://{{API_DOMAIN}}/metadata?page=1&limit=50&sort=asc&orderBy=createdAt&partitionKey=ZIPCODE&sortKey=SP&attributesToFilter=zipCode&q=69902449","protocol":"{{PROTOCOL}}","host":["{{API_DOMAIN}}"],"path":["metadata"],"query":[{"key":"page","value":"1","description":"page (required)"},{"key":"limit","value":"50","description":"limit (required)"},{"key":"sort","value":"asc","description":"sort (optional) - asc or desc"},{"key":"orderBy","value":"createdAt","description":"orderBy (optional) - createdAt, updatedAt"},{"key":"partitionKey","value":"ZIPCODE","description":"required: e.g \"BRA_TAX_INFO\", \"ZIPCODE\""},{"key":"sortKey","value":"SP","description":"required: e.g \"codQualif\", \"SP\""},{"key":"attributesToFilter","value":"zipCode","description":"optional: filter per attributes"},{"key":"q","value":"69902449","description":"optional: filter per attributes"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not Found\"\n}"}],"_postman_id":"afed5811-971c-4c53-be95-c8668a54eb1e"}],"id":"eaaacc52-6659-4366-b622-d119389dae35","description":"

This is the metadata resource that you can use to retrieve relevant information for use in our platform or in any system of your choice.

Metadata consists of detailed information about countries, currencies, states, municipalities, streets by zip code, and other information, especially tax information, that can be used for various purposes without having to maintain it in your proprietary systems.

In the table below, we list all the search possibilities that can be performed using the metadata resource.

The \"partitionKey\" field identifies where the information was recorded in our database, while \"sortKey\" identifies the type of information recorded in that \"partitionKey\". Both are required when performing a search.

If you need to further specify your search, provide the \"attributesToFilter\" parameter with the name of the field you want to search, and the \"q\" parameter defines the value you want to filter.

For example:

To list all addresses in the state of SP, Brazil, you can search for /metadata/partitionKey=ZIPCODE&sortKey=SP
\n
To list only the address of a ZIP code in the state of SP, Brazil, you can search for
/metadata/partitionKey=ZIPCODE&sortKey=SP&attributesToFilter=zipCode&q=69902449
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

`partitionKey`	`sortKey`	`Details`
GLOBAL	COUNTRIES	List all countries in the world
GLOBAL	CURRENCIES	List all world currencies by country
STATES	BRA	Lists all states of a country. Currently we only list the states of Brazil.
CITIES	BRA	Lists all municipalities in a country. Currently we only list municipalities in Brazil. You can enter \"BRA\" to list all states in Brazil or the state abbreviation (e.g. \"SP\") to list only municipalities in a state.
ZIPCODE	SP	List zip codes by state. If you want to specifically filter the address of a single zip code, provide the \"attributesToFilter\" parameter with the name of the field you want to search for, and the \"q\" parameter defines the value you want to filter on. Example: metadata/partitionKey=ZIPCODE&sortKey=SP&attributesToFilter=zipCode&q=69902449
BRA-TAX-INFO	CNAE	Lists all existing economic activity codes in Brazil.
TDB

","_postman_id":"eaaacc52-6659-4366-b622-d119389dae35"}],"event":[{"listen":"prerequest","script":{"id":"e40d0a62-7527-4102-93b7-7214df9e3f7d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"40eecb48-2495-4be6-9f95-081bbb541110","type":"text/javascript","exec":[""]}}]}