{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"19bb1eea-e6fb-45b7-8ba5-f700c1ec9954","name":"Taxhall - API Documentation","description":"**Platform**\n\nWe 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.\n\n**The step-by-step guide to safe and sustainable integration:**\n\n**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:\n\n- <u><b>Entities</b></u>\n    \n    - **whitelabel**\n        \n    - whitelabel.**accounts**\n        \n    - whitelabel.accounts.**companies**\n        \n    - whitelabel.accounts.companies.**subsidiaries**\n        \n\nAll other basic registrations are organized in light of these 4 main contexts.\n\n**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.\n\n**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.\n\n**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.\n\n**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.\n\n**6.** Develop the payload of your request in Json format following the following additional guidelines:\n\n- 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    \n- If you want to edit a field by removing the existing content in it, inform the field followed by the literal null;\n    \n- Do not report duplicate fields, as the treatment implemented by the API is to use the last field read in the payload;\n    \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    \n- Respect limit of up to 50 items per page, in the case of resource listing endpoints\n    \n\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.\n\n**8.** If you still need help, or even if you encounter strange behavior in your tests or behavior that doesn't match what's documented, don't hesitate to contact us by sending an email to your sales representative or our support team.\n\nWe will be delighted to serve you.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18492219","team":2817704,"collectionId":"19bb1eea-e6fb-45b7-8ba5-f700c1ec9954","publishedId":"2sBXiesa6o","public":true,"publicUrl":"https://api-doc.taxhall.gruposkill.com.br","privateUrl":"https://go.postman.co/documentation/18492219-19bb1eea-e6fb-45b7-8ba5-f700c1ec9954","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"000080"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/50726425-c7a4-41a8-a045-727d9ce04acb/dGF4aGFsbCBhenVsLnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"000080"}},{"name":"light","logo":"https://content.pstmn.io/d46f09b3-ade7-44e3-84cb-de0ef1efe245/dGF4aGFsbCBhenVsLnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"000080"}}]}},"version":"8.10.1","publishDate":"2026-03-18T10:24:13.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/d46f09b3-ade7-44e3-84cb-de0ef1efe245/dGF4aGFsbCBhenVsLnBuZw==","logoDark":"https://content.pstmn.io/50726425-c7a4-41a8-a045-727d9ce04acb/dGF4aGFsbCBhenVsLnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b2aacb7e7fc229a8060679c348f06a76a69d131c2038a49771756975254fca79","favicon":"https://gruposkill.com.br/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-doc.taxhall.gruposkill.com.br/view/metadata/2sBXiesa6o"}