Retorna a nota pelo id, com o status atual e o resultado do último processamento
(processingDetail). Use para acompanhar o status quando não usa webhooks.
GET
/
v1
/
service-invoices
/
{id}
Obter NFS-e
curl --request GET \ --url https://api.spedy.com.br/v1/service-invoices/{id} \ --header 'X-Api-Key: <api-key>'
Cada campo informado substitui o valor da regra fiscal da empresa; os campos omitidos continuam vindo da regra, que só se aplica quando o tomador ou o intermediário é estrangeiro.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Spedy","colors":{"primary":"#D93E8D","light":"#E86FA9","dark":"#B8306F"},"logo":{"light":"https://mintcdn.com/spedy/CpHdCXrsn8ll8Rr3/logo/spedy-logo.svg?fit=max\u0026auto=format\u0026n=CpHdCXrsn8ll8Rr3\u0026q=85\u0026s=43e536c2f0fa8572a8a4da15adf08d0c","dark":"https://mintcdn.com/spedy/CpHdCXrsn8ll8Rr3/logo/spedy-logo-dark.svg?fit=max\u0026auto=format\u0026n=CpHdCXrsn8ll8Rr3\u0026q=85\u0026s=eaec6c012f09b7d3e1643ea02e6387f5"},"favicon":"https://mintcdn.com/spedy/CpHdCXrsn8ll8Rr3/favicon.png?fit=max\u0026auto=format\u0026n=CpHdCXrsn8ll8Rr3\u0026q=85\u0026s=1e180a55941d6290ba0722b79cffc6a3","api":{"playground":{"display":"interactive"}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://docs.spedy.com.br/llms.txt","label":"llms.txt"},{"href":"https://status.spedy.com.br","label":"Status"},{"href":"https://sandbox-app.spedy.com.br/","label":"Sandbox"}],"primary":{"type":"button","label":"Produção","href":"https://app.spedy.com.br"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/spedy","instagram":"https://www.instagram.com/spedyoficial"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"spedy","hasAudioNarration":false,"actualSubdomain":"spedy","customDomains":["docs.spedy.com.br"],"gitSource":{"type":"github","owner":"spedy-br","repo":"spedy-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6af30f7c2f20aabdfd4762e6","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":97},{"language":"default","tag":"Endpoints","count":95},{"language":"default","tag":"Guias","count":20},{"language":"default","tag":"Comece aqui","count":20},{"language":"default","tag":"NF-e","count":18},{"language":"default","tag":"Webhooks","count":17},{"language":"default","tag":"NFC-e","count":15},{"language":"default","tag":"NFS-e","count":13},{"language":"default","tag":"Empresas","count":9},{"language":"default","tag":"Emissão","count":7}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"suporte@spedy.com.br"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"municipios-nfse.css","content":".mn-root{--mn-primary: #D93E8D;--mn-primary-10: rgb(217 62 141 / .1);--mn-strong: #1D181B;--mn-body: #454042;--mn-muted: #565154;--mn-faint: #767174;--mn-border: #F4EFF2;--mn-border-strong: #E5E0E2;--mn-surface: #fff;--mn-soft: #FAF8F9;--mn-code-text: #1D181B;--mn-key: #B8306F;--mn-str: #0F766E;--mn-num: #1E40AF;--mn-lit: #7C3AED;--mn-yes-bg: #ECFDF5;--mn-yes-fg: #047857;--mn-no-fg: #A5A0A2;--mn-note-bg: #EFF6FF;--mn-note-bd: #BFDBFE;--mn-note-fg: #1E40AF;--mn-method-bg: #DCFCE7;--mn-method-fg: #166534;--mn-mono: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;color:var(--mn-body);margin:24px 0 40px}.dark .mn-root{--mn-primary: #E86FA9;--mn-primary-10: rgb(232 111 169 / .12);--mn-strong: #E5E0E2;--mn-body: #A5A0A2;--mn-muted: #A5A0A2;--mn-faint: #858083;--mn-border: #2B2729;--mn-border-strong: #3A3538;--mn-surface: #0D0B0E;--mn-soft: #161316;--mn-code-text: #D4D4D4;--mn-key: #F0A3C8;--mn-str: #7DD3C0;--mn-num: #93C5FD;--mn-lit: #C4B5FD;--mn-yes-bg: rgb(16 185 129 / .12);--mn-yes-fg: #6EE7B7;--mn-no-fg: #5A5558;--mn-note-bg: rgb(30 64 175 / .2);--mn-note-bd: #1E3A8A;--mn-note-fg: #93C5FD;--mn-method-bg: rgb(22 101 52 / .3);--mn-method-fg: #86EFAC}#content-container:has(.mn-root){max-width:1280px}.mn-root *{box-sizing:border-box}.mn-root button,.mn-root input,.mn-root select{font:inherit;color:inherit}.mn-faint{color:var(--mn-faint);font-weight:500}.mn-finder{display:flex;gap:12px;flex-wrap:wrap;margin-bottom:24px}.mn-field{position:relative;flex:1;min-width:240px}.mn-field>svg{position:absolute;left:14px;top:13px;color:var(--mn-faint)}.mn-field input{width:100%;height:44px;padding:0 14px 0 40px;border:1px solid var(--mn-border-strong);border-radius:12px;background:var(--mn-surface);outline:none;font-size:15px}.mn-field input:focus,.mn-uf:focus{border-color:var(--mn-primary);box-shadow:0 0 0 3px var(--mn-primary-10)}.mn-uf{height:44px;padding:0 14px;border:1px solid var(--mn-border-strong);border-radius:12px;background:var(--mn-surface);outline:none;font-size:15px}.mn-dropdown{position:absolute;top:50px;left:0;right:0;z-index:20;background:var(--mn-surface);border:1px solid var(--mn-border-strong);border-radius:16px;box-shadow:0 12px 32px rgb(0 0 0 / .08);padding:6px;max-height:360px;overflow:auto}.mn-opt{display:flex;align-items:center;gap:12px;width:100%;padding:8px 10px;border:0;background:none;border-radius:12px;text-align:left;cursor:pointer}.mn-opt>span:first-child{display:flex;flex-direction:column}.mn-hl{background:var(--mn-soft)}.mn-opt-name{color:var(--mn-strong);font-size:15px;line-height:22px}.mn-opt-meta{font:12px/16px var(--mn-mono);color:var(--mn-faint)}.mn-opt-prov{margin-left:auto;font-size:12px;color:var(--mn-muted);text-align:right}.mn-dd-empty{padding:14px;font-size:14px;color:var(--mn-faint)}.mn-dd-foot{padding:8px 12px;margin-top:4px;font-size:12px;color:var(--mn-faint);border-top:1px solid var(--mn-border)}.mn-city-head{display:flex;align-items:flex-start;justify-content:space-between;gap:16px;flex-wrap:wrap;padding-bottom:20px;margin-bottom:24px;border-bottom:1px solid var(--mn-border)}.mn-city-name{font-size:24px;line-height:32px;font-weight:600;letter-spacing:-.4px;color:var(--mn-strong);margin:0}.mn-city-meta{margin-top:4px;font:13px/20px var(--mn-mono);color:var(--mn-faint)}.mn-chips{display:flex;gap:8px;flex-wrap:wrap}.mn-chip{display:inline-flex;align-items:center;font-size:13px;line-height:20px;font-weight:500;padding:3px 10px;border-radius:999px;border:1px solid var(--mn-border-strong)}.mn-chip-primary{color:var(--mn-primary);background:var(--mn-primary-10);border-color:transparent}.mn-callout{display:flex;gap:12px;padding:14px 18px;margin-bottom:24px;border-radius:16px;border:1px solid var(--mn-note-bd);background:var(--mn-note-bg);font-size:14px;line-height:24px}.mn-callout svg{color:var(--mn-note-fg);margin-top:4px;flex:none}.mn-callout strong{color:var(--mn-strong);font-weight:600}.mn-providers{display:flex;gap:4px;flex-wrap:wrap;margin-bottom:24px;border-bottom:1px solid var(--mn-border-strong)}.mn-provider{display:inline-flex;flex-direction:column;align-items:flex-start;gap:2px;text-align:left;padding:10px 14px;margin-bottom:-1px;border:0;border-bottom:2px solid transparent;background:none;cursor:pointer}.mn-provider:hover .mn-provider-name{color:var(--mn-strong)}.mn-provider:focus-visible{outline:none;box-shadow:inset 0 0 0 2px var(--mn-primary-10);border-radius:8px 8px 0 0}.mn-provider.mn-active{border-bottom-color:var(--mn-primary)}.mn-provider-name{font-size:15px;line-height:22px;font-weight:600;color:var(--mn-muted)}.mn-provider.mn-active .mn-provider-name{color:var(--mn-primary)}.mn-provider-method{font-size:13px;line-height:18px;font-weight:500;color:var(--mn-muted)}.mn-provider-applies{font-size:13px;line-height:18px;color:var(--mn-faint)}@media (max-width: 640px){.mn-providers{flex-wrap:nowrap}.mn-provider{flex:1;flex-direction:column;align-items:flex-start;gap:0;padding:8px 10px}}.mn-grid{display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 1.15fr);gap:32px;align-items:start}@media (max-width: 1100px){.mn-grid{grid-template-columns:minmax(0, 1fr)}}.mn-section-title{font-size:14px;line-height:20px;font-weight:600;color:var(--mn-strong);margin:0 0 12px}.mn-card{border:1px solid var(--mn-border);border-radius:16px;margin-bottom:20px}.mn-card-head{border-radius:15px 15px 0 0;padding:10px 16px;font-size:12px;line-height:20px;font-weight:600;letter-spacing:.04em;text-transform:uppercase;color:var(--mn-muted);background:var(--mn-soft);border-bottom:1px solid var(--mn-border)}.mn-row{display:flex;align-items:center;justify-content:space-between;gap:12px;padding:9px 16px;font-size:14px;line-height:22px;border-bottom:1px solid var(--mn-border)}.mn-row:last-child{border-bottom:0}.mn-row-label{display:flex;flex-direction:column}.mn-row-title{display:inline-flex;align-items:center;gap:6px}.mn-help{position:relative;display:inline-flex}.mn-help-btn{display:grid;place-items:center;padding:2px;border:0;border-radius:999px;background:none;color:var(--mn-faint);cursor:help}.mn-help-btn:hover,.mn-help-btn:focus-visible{color:var(--mn-primary);outline:none}.mn-help-btn:focus-visible{box-shadow:0 0 0 2px var(--mn-primary-10)}.mn-tip{display:none;position:absolute;z-index:30;left:50%;bottom:calc(100% + 8px);transform:translateX(-50%);width:280px;padding:10px 12px;border-radius:10px;background:var(--mn-strong);color:var(--mn-surface);font-size:13px;line-height:19px;font-weight:400;box-shadow:0 8px 24px rgb(0 0 0 / .18);pointer-events:none}.mn-help:hover .mn-tip,.mn-help:focus-within .mn-tip{display:block}@media (max-width: 640px){.mn-row{position:relative}.mn-help{position:static}.mn-tip{left:8px;right:8px;width:auto;transform:none}}.mn-row-key{font:12px/16px var(--mn-mono);color:var(--mn-faint)}.mn-pill{flex:none;display:inline-flex;align-items:center;gap:4px;font-size:12px;line-height:18px;font-weight:500;padding:2px 8px;border-radius:999px}.mn-pill-yes{background:var(--mn-yes-bg);color:var(--mn-yes-fg)}.mn-pill-no{color:var(--mn-no-fg)}.mn-pill-val{background:var(--mn-primary-10);color:var(--mn-primary)}.mn-pill-neutral{background:var(--mn-soft);color:var(--mn-muted);box-shadow:inset 0 0 0 1px var(--mn-border-strong)}.mn-pills{display:flex;flex-wrap:wrap;gap:4px}.mn-row-stack{flex-direction:column;align-items:flex-start;gap:6px}.mn-code{position:sticky;top:140px;border:1px solid var(--mn-border);border-radius:14px;overflow:hidden;background:var(--mn-soft)}@media (max-width: 1100px){.mn-code{position:static}}.mn-code-tabs{display:flex;align-items:center;gap:4px;padding:6px 8px 0;border-bottom:1px solid var(--mn-border)}.mn-code-title{padding:8px 10px;font-size:13px;line-height:18px;font-weight:500;color:var(--mn-primary)}.mn-icon-btn{margin-left:auto;display:grid;place-items:center;padding:6px;border:0;border-radius:8px;background:none;color:var(--mn-muted);cursor:pointer}.mn-icon-btn:hover{background:var(--mn-border)}.mn-endpoint{display:flex;align-items:center;gap:8px;padding:10px 16px;font-size:13px;color:var(--mn-muted);border-bottom:1px solid var(--mn-border)}.mn-endpoint code{font-family:var(--mn-mono)}.mn-method{font-size:11px;line-height:16px;font-weight:600;padding:2px 6px;border-radius:6px;background:var(--mn-method-bg);color:var(--mn-method-fg)}.mn-pre{margin:0;padding:14px 16px;max-height:560px;overflow:auto;background:transparent;font:13px/22px var(--mn-mono);color:var(--mn-code-text)}.mn-pre code{font:inherit;background:none;padding:0}.mn-t-key{color:var(--mn-key)}.mn-t-str{color:var(--mn-str)}.mn-t-num{color:var(--mn-num)}.mn-t-lit{color:var(--mn-lit)}.mn-code-foot{padding:10px 16px;font-size:12px;line-height:18px;color:var(--mn-faint);border-top:1px solid var(--mn-border)}.mn-code-foot code{font-family:var(--mn-mono)}.mn-empty{padding:24px 20px;font-size:14px;line-height:22px;color:var(--mn-muted)}.mn-empty a{color:var(--mn-primary)}.mn-empty strong{color:var(--mn-strong);font-weight:600}.mn-code-loading{padding:16px}.mn-skeleton{height:14px;margin:8px 0;border-radius:8px;background:linear-gradient(90deg, var(--mn-soft), var(--mn-border), var(--mn-soft));background-size:200% 100%;animation:mn-shimmer 1.2s infinite}@keyframes mn-shimmer{to{background-position:-200% 0}}"}],"page":{"pagePath":"api-reference/nfs-e/obter-nfs-e","slug":"/api-reference/nfs-e/obter-nfs-e","pageMetadata":{"title":"Obter NFS-e","description":"Retorna a nota pelo `id`, com o `status` atual e o resultado do último processamento\r\n(`processingDetail`). Use para acompanhar o status quando não usa webhooks.","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/{id}","href":"/api-reference/nfs-e/obter-nfs-e","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Retorna a nota pelo \", _jsx(_components.code, {\n children: \"id\"\n }), \", com o \", _jsx(_components.code, {\n children: \"status\"\n }), \" atual e o resultado do último processamento\\r\\n(\", _jsx(_components.code, {\n children: \"processingDetail\"\n }), \"). Use para acompanhar o status quando não usa webhooks.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Obter NFS-e","description":"Retorna a nota pelo `id`, com o `status` atual e o resultado do último processamento\r\n(`processingDetail`). Use para acompanhar o status quando não usa webhooks.","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/{id}","href":"/api-reference/nfs-e/obter-nfs-e","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["NFS-e"],"summary":"Obter NFS-e","description":"Retorna a nota pelo `id`, com o `status` atual e o resultado do último processamento\r\n(`processingDetail`). Use para acompanhar o status quando não usa webhooks.","parameters":["fb50a0bb-f3b5-4920-854a-d8f4b199a4c0"],"responses":{"200":"2a1423ba-1bbf-49f9-8039-6a8389ef49f0","400":"d2cb5bea-cfbb-4de8-89af-358dcfeffd01","403":"2e376681-d619-4f5f-96d6-c70af6818497","429":"65fda03e-686c-48ed-a84c-879e7ad9d5fc"},"security":["107a206a-3ecb-43e0-bfa6-1ca51327a55a"],"method":"get","type":"path","servers":["a6b8c512-0d25-45d7-9da0-4cc68c875365","eadd70cc-e9e3-4347-9ad4-1c4eaf09cafa"],"path":"/v1/service-invoices/{id}","baseUrlOptions":["https://api.spedy.com.br","https://sandbox-api.spedy.com.br"],"title":"Obter NFS-e","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fb50a0bb-f3b5-4920-854a-d8f4b199a4c0":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"2a1423ba-1bbf-49f9-8039-6a8389ef49f0":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"ID da NF","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"integrationId":{"oneOf":[{"type":"string","description":"ID de integração","uniqueKey":"integrationId.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID de integração","uniqueKey":"integrationId.oneOf.1","typeLabel":"null"}],"uniqueKey":"integrationId","typeLabel":"string | null"},"status":{"type":"string","description":"Status\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>created\u003c/b>: Criada — aguarda emissão explícita via issue ou gatilho automático (ex: afterPayment)\u003c/li>\n\u003cli>\u003cb>enqueued\u003c/b>: Enfileirada para processamento junto à SEFAZ ou Prefeitura\u003c/li>\n\u003cli>\u003cb>received\u003c/b>: Recebido\u003c/li>\n\u003cli>\u003cb>authorized\u003c/b>: Autorizado\u003c/li>\n\u003cli>\u003cb>inContingent\u003c/b>: Em contingência\u003c/li>\n\u003cli>\u003cb>rejected\u003c/b>: Rejeitado\u003c/li>\n\u003cli>\u003cb>canceled\u003c/b>: Cancelado\u003c/li>\n\u003cli>\u003cb>denied\u003c/b>: Denegado\u003c/li>\n\u003cli>\u003cb>removed\u003c/b>: Removido\u003c/li>\n\u003cli>\u003cb>disabled\u003c/b>: Inutilizado\u003c/li>\n\u003c/ul>\n","enum":["created","enqueued","received","authorized","inContingent","rejected","canceled","denied","removed","disabled"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Modelo\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>productInvoice\u003c/b>: NF-e\u003c/li>\n\u003cli>\u003cb>consumerInvoice\u003c/b>: NFC-e\u003c/li>\n\u003cli>\u003cb>serviceInvoice\u003c/b>: NFS-e\u003c/li>\n\u003c/ul>\n","enum":["productInvoice","consumerInvoice","serviceInvoice"],"uniqueKey":"model","typeLabel":"enum\u003cstring>"},"environmentType":{"type":"string","description":"Ambiente\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>production\u003c/b>: Produção\u003c/li>\n\u003cli>\u003cb>development\u003c/b>: Homologação\u003c/li>\n\u003cli>\u003cb>simulation\u003c/b>: \u003c/li>\n\u003c/ul>\n","enum":["production","development","simulation"],"uniqueKey":"environmentType","typeLabel":"enum\u003cstring>"},"issuedOn":{"oneOf":[{"type":"string","description":"Data e hora em que a emissão foi solicitada","format":"date-time","uniqueKey":"issuedOn.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Data e hora em que a emissão foi solicitada","format":"date-time","uniqueKey":"issuedOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"issuedOn","typeLabel":"string\u003cdate-time> | null"},"effectiveDate":{"oneOf":[{"type":"string","description":"Data de competência","format":"date-time","uniqueKey":"effectiveDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Data de competência","format":"date-time","uniqueKey":"effectiveDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"effectiveDate","typeLabel":"string\u003cdate-time> | null"},"receiver":{"oneOf":[{"type":"object","description":"Cliente","properties":{"name":{"oneOf":[{"type":"string","description":"Nome","uniqueKey":"receiver.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome","uniqueKey":"receiver.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.name","typeLabel":"string | null"},"federalTaxNumber":{"oneOf":[{"type":"string","description":"CPF / CNPJ / Doc Estrangeiro","uniqueKey":"receiver.oneOf.0.federalTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"CPF / CNPJ / Doc Estrangeiro","uniqueKey":"receiver.oneOf.0.federalTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.federalTaxNumber","typeLabel":"string | null"},"stateTaxNumber":{"oneOf":[{"type":"string","description":"Inscrição estadual","uniqueKey":"receiver.oneOf.0.stateTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inscrição estadual","uniqueKey":"receiver.oneOf.0.stateTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.stateTaxNumber","typeLabel":"string | null"},"suframaTaxNumber":{"oneOf":[{"type":"string","description":"Inscrição na SUFRAMA do destinatário.\r\n\r\nObrigatória em vendas com isenção para a Zona Franca de Manaus (ZFM) e Áreas de Livre Comércio.","uniqueKey":"receiver.oneOf.0.suframaTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inscrição na SUFRAMA do destinatário.\r\n\r\nObrigatória em vendas com isenção para a Zona Franca de Manaus (ZFM) e Áreas de Livre Comércio.","uniqueKey":"receiver.oneOf.0.suframaTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.suframaTaxNumber","typeLabel":"string | null"},"cityTaxNumber":{"oneOf":[{"type":"string","description":"Inscrição municipal","uniqueKey":"receiver.oneOf.0.cityTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inscrição municipal","uniqueKey":"receiver.oneOf.0.cityTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.cityTaxNumber","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","description":"E-mail","uniqueKey":"receiver.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"E-mail","uniqueKey":"receiver.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.email","typeLabel":"string | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"Telefone","uniqueKey":"receiver.oneOf.0.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Telefone","uniqueKey":"receiver.oneOf.0.phoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.phoneNumber","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","description":"Endereço","properties":{"street":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","description":"Logradouro","uniqueKey":"receiver.oneOf.0.address.oneOf.0.street.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","description":"Logradouro","uniqueKey":"receiver.oneOf.0.address.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.street","typeLabel":"string | null"},"district":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","description":"Bairro","uniqueKey":"receiver.oneOf.0.address.oneOf.0.district.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","description":"Bairro","uniqueKey":"receiver.oneOf.0.address.oneOf.0.district.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.district","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":15,"minLength":0,"type":"string","description":"CEP","uniqueKey":"receiver.oneOf.0.address.oneOf.0.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":15,"minLength":0,"type":"null","description":"CEP","uniqueKey":"receiver.oneOf.0.address.oneOf.0.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.postalCode","typeLabel":"string | null"},"number":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","description":"Número","uniqueKey":"receiver.oneOf.0.address.oneOf.0.number.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","description":"Número","uniqueKey":"receiver.oneOf.0.address.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.number","typeLabel":"string | null"},"additionalInformation":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","description":"Complemento","uniqueKey":"receiver.oneOf.0.address.oneOf.0.additionalInformation.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","description":"Complemento","uniqueKey":"receiver.oneOf.0.address.oneOf.0.additionalInformation.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.additionalInformation","typeLabel":"string | null"},"city":{"oneOf":[{"type":"object","description":"Cidade","properties":{"name":{"oneOf":[{"type":"string","description":"Nome","uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome","uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.name","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Estado","uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Estado","uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.state","typeLabel":"string | null"},"code":{"oneOf":[{"type":"integer","description":"Código IBGE","format":"int32","uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.code.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Código IBGE","format":"int32","uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0.code","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"receiver.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.city","typeLabel":"object | null"},"country":{"oneOf":[{"type":"string","description":"Sigla do país, no padrão [ISO 3166-1](https://bit.ly/4cpb1Dh).\r\n\r\nExemplos: `BRA`, `USA`, `ARG`.","uniqueKey":"receiver.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sigla do país, no padrão [ISO 3166-1](https://bit.ly/4cpb1Dh).\r\n\r\nExemplos: `BRA`, `USA`, `ARG`.","uniqueKey":"receiver.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address.oneOf.0.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"receiver.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"receiver.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver.oneOf.0.address","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"receiver.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"receiver.oneOf.1","typeLabel":"null"}],"uniqueKey":"receiver","typeLabel":"object | null"},"company":{"oneOf":[{"type":"object","description":"Empresa","properties":{"name":{"oneOf":[{"type":"string","description":"Nome fantasia","uniqueKey":"company.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome fantasia","uniqueKey":"company.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"company.oneOf.0.name","typeLabel":"string | null"},"legalName":{"oneOf":[{"type":"string","description":"Razão Social","uniqueKey":"company.oneOf.0.legalName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Razão Social","uniqueKey":"company.oneOf.0.legalName.oneOf.1","typeLabel":"null"}],"uniqueKey":"company.oneOf.0.legalName","typeLabel":"string | null"},"federalTaxNumber":{"oneOf":[{"type":"string","description":"CNPJ","uniqueKey":"company.oneOf.0.federalTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"CNPJ","uniqueKey":"company.oneOf.0.federalTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"company.oneOf.0.federalTaxNumber","typeLabel":"string | null"},"stateTaxNumber":{"oneOf":[{"type":"string","description":"Inscrição Estadual","uniqueKey":"company.oneOf.0.stateTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inscrição Estadual","uniqueKey":"company.oneOf.0.stateTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"company.oneOf.0.stateTaxNumber","typeLabel":"string | null"},"cityTaxNumber":{"oneOf":[{"type":"string","description":"Inscrição Municipal","uniqueKey":"company.oneOf.0.cityTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inscrição Municipal","uniqueKey":"company.oneOf.0.cityTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"company.oneOf.0.cityTaxNumber","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"company.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"company.oneOf.1","typeLabel":"null"}],"uniqueKey":"company","typeLabel":"object | null"},"order":{"oneOf":[{"type":"object","description":"Dados da venda","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"order.oneOf.0.id","typeLabel":"string\u003cuuid>"},"date":{"type":"string","format":"date-time","uniqueKey":"order.oneOf.0.date","typeLabel":"string\u003cdate-time>"},"transactionId":{"oneOf":[{"type":"string","uniqueKey":"order.oneOf.0.transactionId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"order.oneOf.0.transactionId.oneOf.1","typeLabel":"null"}],"uniqueKey":"order.oneOf.0.transactionId","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"order.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"order.oneOf.1","typeLabel":"null"}],"uniqueKey":"order","typeLabel":"object | null"},"authorization":{"oneOf":[{"type":"object","description":"Dados da autorização","properties":{"date":{"oneOf":[{"type":"string","description":"Data de autorização pela SEFAZ ou Prefeitura","format":"date-time","uniqueKey":"authorization.oneOf.0.date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Data de autorização pela SEFAZ ou Prefeitura","format":"date-time","uniqueKey":"authorization.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"authorization.oneOf.0.date","typeLabel":"string\u003cdate-time> | null"},"protocol":{"oneOf":[{"type":"string","description":"Protocolo de autorização","uniqueKey":"authorization.oneOf.0.protocol.oneOf.0","typeLabel":"string"},{"type":"null","description":"Protocolo de autorização","uniqueKey":"authorization.oneOf.0.protocol.oneOf.1","typeLabel":"null"}],"uniqueKey":"authorization.oneOf.0.protocol","typeLabel":"string | null"},"digestValue":{"oneOf":[{"type":"string","description":"Digest value do XML autorizado","uniqueKey":"authorization.oneOf.0.digestValue.oneOf.0","typeLabel":"string"},{"type":"null","description":"Digest value do XML autorizado","uniqueKey":"authorization.oneOf.0.digestValue.oneOf.1","typeLabel":"null"}],"uniqueKey":"authorization.oneOf.0.digestValue","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"authorization.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"authorization.oneOf.1","typeLabel":"null"}],"uniqueKey":"authorization","typeLabel":"object | null"},"cancellation":{"oneOf":[{"type":"object","description":"Dados do cancelamento","properties":{"date":{"oneOf":[{"type":"string","description":"Data de cancelamento pela SEFAZ ou Prefeitura","format":"date-time","uniqueKey":"cancellation.oneOf.0.date.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"Data de cancelamento pela SEFAZ ou Prefeitura","format":"date-time","uniqueKey":"cancellation.oneOf.0.date.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.oneOf.0.date","typeLabel":"string\u003cdate-time> | null"},"protocol":{"oneOf":[{"type":"string","description":"Protocolo de cancelamento","uniqueKey":"cancellation.oneOf.0.protocol.oneOf.0","typeLabel":"string"},{"type":"null","description":"Protocolo de cancelamento","uniqueKey":"cancellation.oneOf.0.protocol.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.oneOf.0.protocol","typeLabel":"string | null"},"justification":{"oneOf":[{"type":"string","description":"Justificativa de cancelamento","uniqueKey":"cancellation.oneOf.0.justification.oneOf.0","typeLabel":"string"},{"type":"null","description":"Justificativa de cancelamento","uniqueKey":"cancellation.oneOf.0.justification.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation.oneOf.0.justification","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"cancellation.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"cancellation.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancellation","typeLabel":"object | null"},"amount":{"type":"number","description":"Valor total da NF","format":"double","uniqueKey":"amount","typeLabel":"number\u003cdouble>"},"number":{"oneOf":[{"type":"integer","description":"Número","format":"int64","uniqueKey":"number.oneOf.0","typeLabel":"integer\u003cint64>"},{"type":"null","description":"Número","format":"int64","uniqueKey":"number.oneOf.1","typeLabel":"null"}],"uniqueKey":"number","typeLabel":"integer\u003cint64> | null"},"processingDetail":{"oneOf":[{"type":"object","description":"Detalhes do processamento","properties":{"status":{"type":"string","description":"\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>processing\u003c/b>: Em processamento — evento na fila aguardando execução\u003c/li>\n\u003cli>\u003cb>success\u003c/b>: Processado com sucesso — indica que o evento foi executado, não que a nota foi autorizada. Uma nota rejeitada também terá status Success.\u003c/li>\n\u003cli>\u003cb>failed\u003c/b>: Falha interna no processamento do evento na fila (erro de infraestrutura)\u003c/li>\n\u003c/ul>\n","enum":["processing","success","failed"],"uniqueKey":"processingDetail.oneOf.0.status","typeLabel":"enum\u003cstring>"},"message":{"oneOf":[{"type":"string","uniqueKey":"processingDetail.oneOf.0.message.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"processingDetail.oneOf.0.message.oneOf.1","typeLabel":"null"}],"uniqueKey":"processingDetail.oneOf.0.message","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","uniqueKey":"processingDetail.oneOf.0.code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"processingDetail.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"processingDetail.oneOf.0.code","typeLabel":"string | null"},"on":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"processingDetail.oneOf.0.on.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"processingDetail.oneOf.0.on.oneOf.1","typeLabel":"null"}],"uniqueKey":"processingDetail.oneOf.0.on","typeLabel":"string\u003cdate-time> | null"}},"additionalProperties":false,"uniqueKey":"processingDetail.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"processingDetail.oneOf.1","typeLabel":"null"}],"uniqueKey":"processingDetail","typeLabel":"object | null"},"isFromApi":{"type":"boolean","description":"Emitida via API pública","uniqueKey":"isFromApi","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"totals":{"oneOf":[{"type":"object","description":"Totais da NFS-e.\r\n\r\nAlíquotas e percentuais de redução são informados em **percentual**:\r\n\r\n- **Alíquota:** `3` significa 3% — e não `0.03`\r\n- **Redução:** `60` significa redução de 60% — e não `0.6`","required":["invoiceAmount"],"properties":{"invoiceAmount":{"type":"number","description":"Valor total da NFS-e","format":"double","isRequired":true,"uniqueKey":"totals.oneOf.0.invoiceAmount","typeLabel":"number\u003cdouble>"},"netAmount":{"type":"number","description":"Valor líquido","format":"double","uniqueKey":"totals.oneOf.0.netAmount","typeLabel":"number\u003cdouble>"},"issBaseTax":{"oneOf":[{"type":"number","description":"Base de cálculo do ISS","format":"double","uniqueKey":"totals.oneOf.0.issBaseTax.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Base de cálculo do ISS","format":"double","uniqueKey":"totals.oneOf.0.issBaseTax.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.issBaseTax","typeLabel":"number\u003cdouble> | null"},"irRate":{"oneOf":[{"type":"number","description":"Alíquota do IR (%)","format":"double","uniqueKey":"totals.oneOf.0.irRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota do IR (%)","format":"double","uniqueKey":"totals.oneOf.0.irRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.irRate","typeLabel":"number\u003cdouble> | null"},"csllRate":{"oneOf":[{"type":"number","description":"Alíquota do CSLL (%)","format":"double","uniqueKey":"totals.oneOf.0.csllRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota do CSLL (%)","format":"double","uniqueKey":"totals.oneOf.0.csllRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.csllRate","typeLabel":"number\u003cdouble> | null"},"pisRate":{"oneOf":[{"type":"number","description":"Alíquota do PIS (%)","format":"double","uniqueKey":"totals.oneOf.0.pisRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota do PIS (%)","format":"double","uniqueKey":"totals.oneOf.0.pisRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.pisRate","typeLabel":"number\u003cdouble> | null"},"cofinsRate":{"oneOf":[{"type":"number","description":"Alíquota do COFINS (%)","format":"double","uniqueKey":"totals.oneOf.0.cofinsRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota do COFINS (%)","format":"double","uniqueKey":"totals.oneOf.0.cofinsRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.cofinsRate","typeLabel":"number\u003cdouble> | null"},"inssRate":{"oneOf":[{"type":"number","description":"Alíquota do INSS (%)","format":"double","uniqueKey":"totals.oneOf.0.inssRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota do INSS (%)","format":"double","uniqueKey":"totals.oneOf.0.inssRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.inssRate","typeLabel":"number\u003cdouble> | null"},"issRate":{"oneOf":[{"type":"number","description":"Alíquota do ISS (%)","format":"double","uniqueKey":"totals.oneOf.0.issRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota do ISS (%)","format":"double","uniqueKey":"totals.oneOf.0.issRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.issRate","typeLabel":"number\u003cdouble> | null"},"issAmount":{"oneOf":[{"type":"number","description":"Valor do ISS","format":"double","uniqueKey":"totals.oneOf.0.issAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do ISS","format":"double","uniqueKey":"totals.oneOf.0.issAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.issAmount","typeLabel":"number\u003cdouble> | null"},"discountUnconditionedAmount":{"oneOf":[{"type":"number","description":"Valor total do desconto incondicionado","format":"double","uniqueKey":"totals.oneOf.0.discountUnconditionedAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor total do desconto incondicionado","format":"double","uniqueKey":"totals.oneOf.0.discountUnconditionedAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.discountUnconditionedAmount","typeLabel":"number\u003cdouble> | null"},"discountConditionedAmount":{"oneOf":[{"type":"number","description":"Valor total do desconto condicionado","format":"double","uniqueKey":"totals.oneOf.0.discountConditionedAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor total do desconto condicionado","format":"double","uniqueKey":"totals.oneOf.0.discountConditionedAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.discountConditionedAmount","typeLabel":"number\u003cdouble> | null"},"irAmount":{"oneOf":[{"type":"number","description":"Valor do IR","format":"double","uniqueKey":"totals.oneOf.0.irAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do IR","format":"double","uniqueKey":"totals.oneOf.0.irAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.irAmount","typeLabel":"number\u003cdouble> | null"},"pisCofinsBaseTax":{"oneOf":[{"type":"number","description":"Base de cálculo do Pis/Cofins","format":"double","uniqueKey":"totals.oneOf.0.pisCofinsBaseTax.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Base de cálculo do Pis/Cofins","format":"double","uniqueKey":"totals.oneOf.0.pisCofinsBaseTax.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.pisCofinsBaseTax","typeLabel":"number\u003cdouble> | null"},"pisAmount":{"oneOf":[{"type":"number","description":"Valor do PIS","format":"double","uniqueKey":"totals.oneOf.0.pisAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do PIS","format":"double","uniqueKey":"totals.oneOf.0.pisAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.pisAmount","typeLabel":"number\u003cdouble> | null"},"cofinsAmount":{"oneOf":[{"type":"number","description":"Valor do COFINS","format":"double","uniqueKey":"totals.oneOf.0.cofinsAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do COFINS","format":"double","uniqueKey":"totals.oneOf.0.cofinsAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.cofinsAmount","typeLabel":"number\u003cdouble> | null"},"inssAmount":{"oneOf":[{"type":"number","description":"Valor do INSS","format":"double","uniqueKey":"totals.oneOf.0.inssAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do INSS","format":"double","uniqueKey":"totals.oneOf.0.inssAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.inssAmount","typeLabel":"number\u003cdouble> | null"},"csllAmount":{"oneOf":[{"type":"number","description":"Valor do CSLL","format":"double","uniqueKey":"totals.oneOf.0.csllAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do CSLL","format":"double","uniqueKey":"totals.oneOf.0.csllAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.csllAmount","typeLabel":"number\u003cdouble> | null"},"othersAmount":{"oneOf":[{"type":"number","description":"Valor de outros tributos","format":"double","uniqueKey":"totals.oneOf.0.othersAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor de outros tributos","format":"double","uniqueKey":"totals.oneOf.0.othersAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.othersAmount","typeLabel":"number\u003cdouble> | null"},"deductionsAmount":{"oneOf":[{"type":"number","description":"Valor das deduções","format":"double","uniqueKey":"totals.oneOf.0.deductionsAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor das deduções","format":"double","uniqueKey":"totals.oneOf.0.deductionsAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.deductionsAmount","typeLabel":"number\u003cdouble> | null"},"irWithheld":{"oneOf":[{"type":"boolean","description":"IR retido","uniqueKey":"totals.oneOf.0.irWithheld.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"IR retido","uniqueKey":"totals.oneOf.0.irWithheld.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.irWithheld","typeLabel":"boolean | null"},"issWithheld":{"oneOf":[{"type":"boolean","description":"ISS retido","uniqueKey":"totals.oneOf.0.issWithheld.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"ISS retido","uniqueKey":"totals.oneOf.0.issWithheld.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.issWithheld","typeLabel":"boolean | null"},"cofinsWithheld":{"oneOf":[{"type":"boolean","description":"COFINS retido","uniqueKey":"totals.oneOf.0.cofinsWithheld.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"COFINS retido","uniqueKey":"totals.oneOf.0.cofinsWithheld.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.cofinsWithheld","typeLabel":"boolean | null"},"inssWithheld":{"oneOf":[{"type":"boolean","description":"INSS retido","uniqueKey":"totals.oneOf.0.inssWithheld.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"INSS retido","uniqueKey":"totals.oneOf.0.inssWithheld.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.inssWithheld","typeLabel":"boolean | null"},"csllWithheld":{"oneOf":[{"type":"boolean","description":"CSLL retido","uniqueKey":"totals.oneOf.0.csllWithheld.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"CSLL retido","uniqueKey":"totals.oneOf.0.csllWithheld.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.csllWithheld","typeLabel":"boolean | null"},"pisWithheld":{"oneOf":[{"type":"boolean","description":"PIS retido","uniqueKey":"totals.oneOf.0.pisWithheld.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"PIS retido","uniqueKey":"totals.oneOf.0.pisWithheld.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.pisWithheld","typeLabel":"boolean | null"},"ibsStateRate":{"oneOf":[{"type":"number","description":"Alíquota do IBS de competência da UF (%)","format":"double","uniqueKey":"totals.oneOf.0.ibsStateRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota do IBS de competência da UF (%)","format":"double","uniqueKey":"totals.oneOf.0.ibsStateRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsStateRate","typeLabel":"number\u003cdouble> | null"},"ibsStateRedRate":{"oneOf":[{"type":"number","description":"Percentual de redução da alíquota do IBS de competência da UF","format":"double","uniqueKey":"totals.oneOf.0.ibsStateRedRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Percentual de redução da alíquota do IBS de competência da UF","format":"double","uniqueKey":"totals.oneOf.0.ibsStateRedRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsStateRedRate","typeLabel":"number\u003cdouble> | null"},"ibsCityRate":{"oneOf":[{"type":"number","description":"Alíquota vigente do IBS do Município (%)","format":"double","uniqueKey":"totals.oneOf.0.ibsCityRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota vigente do IBS do Município (%)","format":"double","uniqueKey":"totals.oneOf.0.ibsCityRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsCityRate","typeLabel":"number\u003cdouble> | null"},"ibsCityRedRate":{"oneOf":[{"type":"number","description":"Percentual de redução da alíquota do IBS do Município","format":"double","uniqueKey":"totals.oneOf.0.ibsCityRedRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Percentual de redução da alíquota do IBS do Município","format":"double","uniqueKey":"totals.oneOf.0.ibsCityRedRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsCityRedRate","typeLabel":"number\u003cdouble> | null"},"cbsRate":{"oneOf":[{"type":"number","description":"Alíquota vigente da CBS (%)","format":"double","uniqueKey":"totals.oneOf.0.cbsRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota vigente da CBS (%)","format":"double","uniqueKey":"totals.oneOf.0.cbsRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.cbsRate","typeLabel":"number\u003cdouble> | null"},"cbsRedRate":{"oneOf":[{"type":"number","description":"Percentual de redução da alíquota da CBS","format":"double","uniqueKey":"totals.oneOf.0.cbsRedRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Percentual de redução da alíquota da CBS","format":"double","uniqueKey":"totals.oneOf.0.cbsRedRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.cbsRedRate","typeLabel":"number\u003cdouble> | null"},"ibsCbsBaseTax":{"oneOf":[{"type":"number","description":"Base de cálculo do IBS e CBS","format":"double","uniqueKey":"totals.oneOf.0.ibsCbsBaseTax.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Base de cálculo do IBS e CBS","format":"double","uniqueKey":"totals.oneOf.0.ibsCbsBaseTax.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsCbsBaseTax","typeLabel":"number\u003cdouble> | null"},"ibsStateAmount":{"oneOf":[{"type":"number","description":"Valor do IBS de competência da UF","format":"double","uniqueKey":"totals.oneOf.0.ibsStateAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do IBS de competência da UF","format":"double","uniqueKey":"totals.oneOf.0.ibsStateAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsStateAmount","typeLabel":"number\u003cdouble> | null"},"ibsCityAmount":{"oneOf":[{"type":"number","description":"Valor do IBS de competência do Município","format":"double","uniqueKey":"totals.oneOf.0.ibsCityAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do IBS de competência do Município","format":"double","uniqueKey":"totals.oneOf.0.ibsCityAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsCityAmount","typeLabel":"number\u003cdouble> | null"},"ibsAmount":{"oneOf":[{"type":"number","description":"Valor do IBS","format":"double","uniqueKey":"totals.oneOf.0.ibsAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor do IBS","format":"double","uniqueKey":"totals.oneOf.0.ibsAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.ibsAmount","typeLabel":"number\u003cdouble> | null"},"cbsAmount":{"oneOf":[{"type":"number","description":"Valor da CBS","format":"double","uniqueKey":"totals.oneOf.0.cbsAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor da CBS","format":"double","uniqueKey":"totals.oneOf.0.cbsAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.cbsAmount","typeLabel":"number\u003cdouble> | null"},"receivedAmount":{"oneOf":[{"type":"number","description":"Valor total recebido pelo serviço prestado","format":"double","uniqueKey":"totals.oneOf.0.receivedAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor total recebido pelo serviço prestado","format":"double","uniqueKey":"totals.oneOf.0.receivedAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals.oneOf.0.receivedAmount","typeLabel":"number\u003cdouble> | null"}},"additionalProperties":false,"uniqueKey":"totals.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"totals.oneOf.1","typeLabel":"null"}],"uniqueKey":"totals","typeLabel":"object | null"},"rps":{"oneOf":[{"type":"object","properties":{"number":{"type":"integer","format":"int64","uniqueKey":"rps.oneOf.0.number","typeLabel":"integer\u003cint64>"},"series":{"oneOf":[{"type":"string","uniqueKey":"rps.oneOf.0.series.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"rps.oneOf.0.series.oneOf.1","typeLabel":"null"}],"uniqueKey":"rps.oneOf.0.series","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"rps.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"rps.oneOf.1","typeLabel":"null"}],"uniqueKey":"rps","typeLabel":"object | null"},"location":{"oneOf":[{"type":"object","properties":{"code":{"oneOf":[{"type":"integer","description":"Código IBGE","format":"int32","uniqueKey":"location.oneOf.0.code.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Código IBGE","format":"int32","uniqueKey":"location.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.oneOf.0.code","typeLabel":"integer\u003cint32> | null"},"name":{"oneOf":[{"type":"string","description":"Nome","uniqueKey":"location.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome","uniqueKey":"location.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"location.oneOf.0.name","typeLabel":"string | null"},"state":{"type":"string","description":"Estado\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>ro\u003c/b>: Rondônia\u003c/li>\n\u003cli>\u003cb>ac\u003c/b>: Acre\u003c/li>\n\u003cli>\u003cb>am\u003c/b>: Amazonas\u003c/li>\n\u003cli>\u003cb>rr\u003c/b>: Roraima\u003c/li>\n\u003cli>\u003cb>pa\u003c/b>: Pará\u003c/li>\n\u003cli>\u003cb>ap\u003c/b>: Amapá\u003c/li>\n\u003cli>\u003cb>to\u003c/b>: Tocantins\u003c/li>\n\u003cli>\u003cb>ma\u003c/b>: Maranhão\u003c/li>\n\u003cli>\u003cb>pi\u003c/b>: Piauí\u003c/li>\n\u003cli>\u003cb>ce\u003c/b>: Ceará\u003c/li>\n\u003cli>\u003cb>rn\u003c/b>: Rio Grande do Norte\u003c/li>\n\u003cli>\u003cb>pb\u003c/b>: Paraíba\u003c/li>\n\u003cli>\u003cb>pe\u003c/b>: Pernambuco\u003c/li>\n\u003cli>\u003cb>al\u003c/b>: Alagoas\u003c/li>\n\u003cli>\u003cb>se\u003c/b>: Sergipe\u003c/li>\n\u003cli>\u003cb>ba\u003c/b>: Bahia\u003c/li>\n\u003cli>\u003cb>mg\u003c/b>: Minas Gerais\u003c/li>\n\u003cli>\u003cb>es\u003c/b>: Espírito Santo\u003c/li>\n\u003cli>\u003cb>rj\u003c/b>: Rio de Janeiro\u003c/li>\n\u003cli>\u003cb>sp\u003c/b>: São Paulo\u003c/li>\n\u003cli>\u003cb>pr\u003c/b>: Paraná\u003c/li>\n\u003cli>\u003cb>sc\u003c/b>: Santa Catarina\u003c/li>\n\u003cli>\u003cb>rs\u003c/b>: Rio Grande do Sul\u003c/li>\n\u003cli>\u003cb>ms\u003c/b>: Mato Grosso do Sul\u003c/li>\n\u003cli>\u003cb>mt\u003c/b>: Mato Grosso\u003c/li>\n\u003cli>\u003cb>go\u003c/b>: Goiás\u003c/li>\n\u003cli>\u003cb>df\u003c/b>: Distrito Federal\u003c/li>\n\u003cli>\u003cb>an\u003c/b>: Ambiente Nacional\u003c/li>\n\u003cli>\u003cb>ex\u003c/b>: Exterior\u003c/li>\n\u003c/ul>\n","enum":["ro","ac","am","rr","pa","ap","to","ma","pi","ce","rn","pb","pe","al","se","ba","mg","es","rj","sp","pr","sc","rs","ms","mt","go","df","an","ex"],"uniqueKey":"location.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"location.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"location.oneOf.1","typeLabel":"null"}],"uniqueKey":"location","typeLabel":"object | null"},"ibsCbs":{"oneOf":[{"type":"object","properties":{"cst":{"oneOf":[{"type":"integer","description":"Código de Situação Tributária do IBS e CBS","format":"int32","uniqueKey":"ibsCbs.oneOf.0.cst.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Código de Situação Tributária do IBS e CBS","format":"int32","uniqueKey":"ibsCbs.oneOf.0.cst.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.cst","typeLabel":"integer\u003cint32> | null"},"classification":{"oneOf":[{"type":"integer","description":"Código de Classificação Tributária do IBS e CBS","format":"int32","uniqueKey":"ibsCbs.oneOf.0.classification.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Código de Classificação Tributária do IBS e CBS","format":"int32","uniqueKey":"ibsCbs.oneOf.0.classification.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.classification","typeLabel":"integer\u003cint32> | null"},"operationIndicatorCode":{"oneOf":[{"type":"string","description":"Código indicador da operação de fornecimento","uniqueKey":"ibsCbs.oneOf.0.operationIndicatorCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Código indicador da operação de fornecimento","uniqueKey":"ibsCbs.oneOf.0.operationIndicatorCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.operationIndicatorCode","typeLabel":"string | null"},"isPersonalUse":{"type":"boolean","description":"Indica operação de uso ou consumo pessoal","uniqueKey":"ibsCbs.oneOf.0.isPersonalUse","typeLabel":"boolean"},"operationType":{"oneOf":[{"type":"string","description":"Tipo de Operação com Entes Governamentais ou outros serviços sobre bens imóveis\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>supplyWithSubsequentPayment\u003c/b>: Fornecimento com pagamento posterior\u003c/li>\n\u003cli>\u003cb>paymentReceivedAfterSupply\u003c/b>: Recebimento do pagamento com fornecimento já realizado\u003c/li>\n\u003cli>\u003cb>supplyWithPriorPayment\u003c/b>: Fornecimento com pagamento já realizado\u003c/li>\n\u003cli>\u003cb>paymentReceivedBeforeSupply\u003c/b>: Recebimento do pagamento com fornecimento posterior\u003c/li>\n\u003cli>\u003cb>simultaneousSupplyAndPayment\u003c/b>: Fornecimento e recebimento do pagamento concomitantes\u003c/li>\n\u003c/ul>\n","enum":["supplyWithSubsequentPayment","paymentReceivedAfterSupply","supplyWithPriorPayment","paymentReceivedBeforeSupply","simultaneousSupplyAndPayment"],"uniqueKey":"ibsCbs.oneOf.0.operationType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"ibsCbs.oneOf.0.operationType.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.operationType","typeLabel":"enum\u003cstring> | null"},"governmentEntityType":{"oneOf":[{"type":"string","description":"Tipo de ente governamental\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>union\u003c/b>: União\u003c/li>\n\u003cli>\u003cb>state\u003c/b>: Estado\u003c/li>\n\u003cli>\u003cb>federal\u003c/b>: Distrito Federal\u003c/li>\n\u003cli>\u003cb>city\u003c/b>: Município\u003c/li>\n\u003c/ul>\n","enum":["union","state","federal","city"],"uniqueKey":"ibsCbs.oneOf.0.governmentEntityType.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"ibsCbs.oneOf.0.governmentEntityType.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.governmentEntityType","typeLabel":"enum\u003cstring> | null"},"property":{"oneOf":[{"type":"object","description":"Informações de operações relacionadas a bens imóveis","properties":{"fiscalPropertyTaxNumber":{"oneOf":[{"type":"string","description":"Inscrição imobiliária fiscal","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.fiscalPropertyTaxNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Inscrição imobiliária fiscal","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.fiscalPropertyTaxNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.fiscalPropertyTaxNumber","typeLabel":"string | null"},"cibCode":{"oneOf":[{"type":"string","description":"Código do Cadastro Imobiliário Brasileiro - CIB","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.cibCode.oneOf.0","typeLabel":"string"},{"type":"null","description":"Código do Cadastro Imobiliário Brasileiro - CIB","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.cibCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.cibCode","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","description":"Informações do endereço do imóvel","properties":{"street":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","description":"Logradouro","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.street.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","description":"Logradouro","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.street.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.street","typeLabel":"string | null"},"district":{"oneOf":[{"maxLength":100,"minLength":0,"type":"string","description":"Bairro","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.district.oneOf.0","typeLabel":"string"},{"maxLength":100,"minLength":0,"type":"null","description":"Bairro","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.district.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.district","typeLabel":"string | null"},"postalCode":{"oneOf":[{"maxLength":15,"minLength":0,"type":"string","description":"CEP","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.postalCode.oneOf.0","typeLabel":"string"},{"maxLength":15,"minLength":0,"type":"null","description":"CEP","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.postalCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.postalCode","typeLabel":"string | null"},"number":{"oneOf":[{"maxLength":10,"minLength":0,"type":"string","description":"Número","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.number.oneOf.0","typeLabel":"string"},{"maxLength":10,"minLength":0,"type":"null","description":"Número","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.number.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.number","typeLabel":"string | null"},"additionalInformation":{"oneOf":[{"maxLength":150,"minLength":0,"type":"string","description":"Complemento","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.additionalInformation.oneOf.0","typeLabel":"string"},{"maxLength":150,"minLength":0,"type":"null","description":"Complemento","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.additionalInformation.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.additionalInformation","typeLabel":"string | null"},"city":{"oneOf":[{"type":"object","description":"Cidade","properties":{"name":{"oneOf":[{"type":"string","description":"Nome","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.name","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","description":"Estado","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","description":"Estado","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.state","typeLabel":"string | null"},"code":{"oneOf":[{"type":"integer","description":"Código IBGE","format":"int32","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.code.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Código IBGE","format":"int32","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0.code","typeLabel":"integer\u003cint32> | null"}},"additionalProperties":false,"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.city","typeLabel":"object | null"},"country":{"oneOf":[{"type":"string","description":"Sigla do país, no padrão [ISO 3166-1](https://bit.ly/4cpb1Dh).\r\n\r\nExemplos: `BRA`, `USA`, `ARG`.","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Sigla do país, no padrão [ISO 3166-1](https://bit.ly/4cpb1Dh).\r\n\r\nExemplos: `BRA`, `USA`, `ARG`.","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0.country","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.address","typeLabel":"object | null"},"location":{"oneOf":[{"type":"object","description":"Município do imóvel, pelo código IBGE ou pelo nome e UF.\r\n\r\nOpcional: se omitido, é usado o município do endereço do imóvel.","properties":{"code":{"oneOf":[{"type":"integer","description":"Código IBGE","format":"int32","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0.code.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","description":"Código IBGE","format":"int32","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0.code","typeLabel":"integer\u003cint32> | null"},"name":{"oneOf":[{"type":"string","description":"Nome","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0.name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Nome","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0.name.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0.name","typeLabel":"string | null"},"state":{"type":"string","description":"Estado\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>ro\u003c/b>: Rondônia\u003c/li>\n\u003cli>\u003cb>ac\u003c/b>: Acre\u003c/li>\n\u003cli>\u003cb>am\u003c/b>: Amazonas\u003c/li>\n\u003cli>\u003cb>rr\u003c/b>: Roraima\u003c/li>\n\u003cli>\u003cb>pa\u003c/b>: Pará\u003c/li>\n\u003cli>\u003cb>ap\u003c/b>: Amapá\u003c/li>\n\u003cli>\u003cb>to\u003c/b>: Tocantins\u003c/li>\n\u003cli>\u003cb>ma\u003c/b>: Maranhão\u003c/li>\n\u003cli>\u003cb>pi\u003c/b>: Piauí\u003c/li>\n\u003cli>\u003cb>ce\u003c/b>: Ceará\u003c/li>\n\u003cli>\u003cb>rn\u003c/b>: Rio Grande do Norte\u003c/li>\n\u003cli>\u003cb>pb\u003c/b>: Paraíba\u003c/li>\n\u003cli>\u003cb>pe\u003c/b>: Pernambuco\u003c/li>\n\u003cli>\u003cb>al\u003c/b>: Alagoas\u003c/li>\n\u003cli>\u003cb>se\u003c/b>: Sergipe\u003c/li>\n\u003cli>\u003cb>ba\u003c/b>: Bahia\u003c/li>\n\u003cli>\u003cb>mg\u003c/b>: Minas Gerais\u003c/li>\n\u003cli>\u003cb>es\u003c/b>: Espírito Santo\u003c/li>\n\u003cli>\u003cb>rj\u003c/b>: Rio de Janeiro\u003c/li>\n\u003cli>\u003cb>sp\u003c/b>: São Paulo\u003c/li>\n\u003cli>\u003cb>pr\u003c/b>: Paraná\u003c/li>\n\u003cli>\u003cb>sc\u003c/b>: Santa Catarina\u003c/li>\n\u003cli>\u003cb>rs\u003c/b>: Rio Grande do Sul\u003c/li>\n\u003cli>\u003cb>ms\u003c/b>: Mato Grosso do Sul\u003c/li>\n\u003cli>\u003cb>mt\u003c/b>: Mato Grosso\u003c/li>\n\u003cli>\u003cb>go\u003c/b>: Goiás\u003c/li>\n\u003cli>\u003cb>df\u003c/b>: Distrito Federal\u003c/li>\n\u003cli>\u003cb>an\u003c/b>: Ambiente Nacional\u003c/li>\n\u003cli>\u003cb>ex\u003c/b>: Exterior\u003c/li>\n\u003c/ul>\n","enum":["ro","ac","am","rr","pa","ap","to","ma","pi","ce","rn","pb","pe","al","se","ba","mg","es","rj","sp","pr","sc","rs","ms","mt","go","df","an","ex"],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0.state","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0.location","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"ibsCbs.oneOf.0.property.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"ibsCbs.oneOf.0.property.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs.oneOf.0.property","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"ibsCbs.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"ibsCbs.oneOf.1","typeLabel":"null"}],"uniqueKey":"ibsCbs","typeLabel":"object | null"},"nbsCode":{"oneOf":[{"type":"string","uniqueKey":"nbsCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"nbsCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"nbsCode","typeLabel":"string | null"},"nationalTaxationCode":{"oneOf":[{"type":"string","uniqueKey":"nationalTaxationCode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"nationalTaxationCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"nationalTaxationCode","typeLabel":"string | null"},"batchNumber":{"oneOf":[{"type":"integer","format":"int32","uniqueKey":"batchNumber.oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","uniqueKey":"batchNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"batchNumber","typeLabel":"integer\u003cint32> | null"},"approximateTaxes":{"oneOf":[{"type":"object","properties":{"federalAmount":{"oneOf":[{"type":"number","description":"Valor total Federal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.federalAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor total Federal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.federalAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.federalAmount","typeLabel":"number\u003cdouble> | null"},"federalRate":{"oneOf":[{"type":"number","description":"Alíquota Federal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.federalRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota Federal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.federalRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.federalRate","typeLabel":"number\u003cdouble> | null"},"municipalRate":{"oneOf":[{"type":"number","description":"Alíquota Municipal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.municipalRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota Municipal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.municipalRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.municipalRate","typeLabel":"number\u003cdouble> | null"},"municipalAmount":{"oneOf":[{"type":"number","description":"Valor total municipal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.municipalAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor total municipal","format":"double","uniqueKey":"approximateTaxes.oneOf.0.municipalAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.municipalAmount","typeLabel":"number\u003cdouble> | null"},"stateAmount":{"oneOf":[{"type":"number","description":"Valor total estadual","format":"double","uniqueKey":"approximateTaxes.oneOf.0.stateAmount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor total estadual","format":"double","uniqueKey":"approximateTaxes.oneOf.0.stateAmount.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.stateAmount","typeLabel":"number\u003cdouble> | null"},"stateRate":{"oneOf":[{"type":"number","description":"Alíquota Estadual","format":"double","uniqueKey":"approximateTaxes.oneOf.0.stateRate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota Estadual","format":"double","uniqueKey":"approximateTaxes.oneOf.0.stateRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.stateRate","typeLabel":"number\u003cdouble> | null"},"amount":{"oneOf":[{"type":"number","description":"Valor total da tributação","format":"double","uniqueKey":"approximateTaxes.oneOf.0.amount.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Valor total da tributação","format":"double","uniqueKey":"approximateTaxes.oneOf.0.amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.amount","typeLabel":"number\u003cdouble> | null"},"rate":{"oneOf":[{"type":"number","description":"Alíquota total","format":"double","uniqueKey":"approximateTaxes.oneOf.0.rate.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","description":"Alíquota total","format":"double","uniqueKey":"approximateTaxes.oneOf.0.rate.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.rate","typeLabel":"number\u003cdouble> | null"},"version":{"oneOf":[{"type":"string","description":"Versão","uniqueKey":"approximateTaxes.oneOf.0.version.oneOf.0","typeLabel":"string"},{"type":"null","description":"Versão","uniqueKey":"approximateTaxes.oneOf.0.version.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.version","typeLabel":"string | null"},"source":{"oneOf":[{"type":"string","description":"Fonte da tributação","uniqueKey":"approximateTaxes.oneOf.0.source.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fonte da tributação","uniqueKey":"approximateTaxes.oneOf.0.source.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes.oneOf.0.source","typeLabel":"string | null"},"mode":{"type":"string","description":"Modo de exibição da descrição do serviço com Tributos Aproximados\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>disabled\u003c/b>: Desabilitado\u003c/li>\n\u003cli>\u003cb>detailed\u003c/b>: Detalhado\u003c/li>\n\u003cli>\u003cb>simplified\u003c/b>: Simplificado\u003c/li>\n\u003c/ul>\n","enum":["disabled","detailed","simplified"],"uniqueKey":"approximateTaxes.oneOf.0.mode","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"approximateTaxes.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"approximateTaxes.oneOf.1","typeLabel":"null"}],"uniqueKey":"approximateTaxes","typeLabel":"object | null"},"foreignTrade":{"oneOf":[{"type":"object","description":"Dados de comércio exterior da NFS-e.\r\n\r\nCada campo informado substitui o valor da regra fiscal da empresa; os campos omitidos continuam vindo da regra, que só se aplica quando o tomador ou o intermediário é estrangeiro.","required":["amount","currencyCode"],"properties":{"amount":{"type":"number","description":"Valor do serviço na moeda estrangeira.","format":"double","isRequired":true,"uniqueKey":"foreignTrade.oneOf.0.amount","typeLabel":"number\u003cdouble>"},"currencyCode":{"minLength":1,"type":"string","description":"Código ISO da moeda estrangeira, ex: `USD`.","isRequired":true,"uniqueKey":"foreignTrade.oneOf.0.currencyCode","typeLabel":"string"},"serviceProvisionMode":{"oneOf":[{"type":"string","description":"Modo de prestação do serviço.\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>unknown\u003c/b>: Desconhecido (tipo não informado na nota de origem)\u003c/li>\n\u003cli>\u003cb>crossBorder\u003c/b>: Transfronteiriço\u003c/li>\n\u003cli>\u003cb>consumptionInBrazil\u003c/b>: Consumo no Brasil\u003c/li>\n\u003cli>\u003cb>temporaryMovementPhysicalPerson\u003c/b>: Movimento Temporário de Pessoas Físicas\u003c/li>\n\u003cli>\u003cb>consumptionOutSideBrazil\u003c/b>: Consumo no Exterior\u003c/li>\n\u003c/ul>\n","enum":["unknown","crossBorder","consumptionInBrazil","temporaryMovementPhysicalPerson","consumptionOutSideBrazil"],"uniqueKey":"foreignTrade.oneOf.0.serviceProvisionMode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"foreignTrade.oneOf.0.serviceProvisionMode.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignTrade.oneOf.0.serviceProvisionMode","typeLabel":"enum\u003cstring> | null"},"relationshipBetweenParties":{"oneOf":[{"type":"string","description":"Vínculo entre as partes da operação.\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>withoutLink\u003c/b>: Sem vínculo com o Tomador / Prestador\u003c/li>\n\u003cli>\u003cb>controlled\u003c/b>: Controlada\u003c/li>\n\u003cli>\u003cb>controller\u003c/b>: Controladora\u003c/li>\n\u003cli>\u003cb>related\u003c/b>: Coligada\u003c/li>\n\u003cli>\u003cb>matrix\u003c/b>: Matriz\u003c/li>\n\u003cli>\u003cb>branch\u003c/b>: Filial ou sucursal\u003c/li>\n\u003cli>\u003cb>otherLink\u003c/b>: Outro vínculo\u003c/li>\n\u003cli>\u003cb>unknown\u003c/b>: Desconhecido (tipo não informado na nota de origem)\u003c/li>\n\u003c/ul>\n","enum":["withoutLink","controlled","controller","related","matrix","branch","otherLink","unknown"],"uniqueKey":"foreignTrade.oneOf.0.relationshipBetweenParties.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"foreignTrade.oneOf.0.relationshipBetweenParties.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignTrade.oneOf.0.relationshipBetweenParties","typeLabel":"enum\u003cstring> | null"},"supportMechanismForServiceProvider":{"oneOf":[{"type":"string","description":"Mecanismo de apoio/fomento utilizado pelo prestador do serviço.","uniqueKey":"foreignTrade.oneOf.0.supportMechanismForServiceProvider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mecanismo de apoio/fomento utilizado pelo prestador do serviço.","uniqueKey":"foreignTrade.oneOf.0.supportMechanismForServiceProvider.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignTrade.oneOf.0.supportMechanismForServiceProvider","typeLabel":"string | null"},"supportMechanismForBorrower":{"oneOf":[{"type":"string","description":"Mecanismo de apoio/fomento utilizado pelo tomador do serviço.","uniqueKey":"foreignTrade.oneOf.0.supportMechanismForBorrower.oneOf.0","typeLabel":"string"},{"type":"null","description":"Mecanismo de apoio/fomento utilizado pelo tomador do serviço.","uniqueKey":"foreignTrade.oneOf.0.supportMechanismForBorrower.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignTrade.oneOf.0.supportMechanismForBorrower","typeLabel":"string | null"},"relationshipBetweenOperationAndTemporaryMovement":{"oneOf":[{"type":"string","description":"Vínculo da operação à movimentação temporária de bens.\u003cp>Valores possíveis:\u003c/p>\n\u003cul>\n\u003cli>\u003cb>unknown\u003c/b>: Desconhecido (tipo não informado na nota de origem)\u003c/li>\n\u003cli>\u003cb>no\u003c/b>: Não\u003c/li>\n\u003cli>\u003cb>importDeclaration\u003c/b>: Vinculada - Declaração de Importação\u003c/li>\n\u003cli>\u003cb>exportDeclaration\u003c/b>: Vinculada - Declaração de Exportação\u003c/li>\n\u003c/ul>\n","enum":["unknown","no","importDeclaration","exportDeclaration"],"uniqueKey":"foreignTrade.oneOf.0.relationshipBetweenOperationAndTemporaryMovement.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"foreignTrade.oneOf.0.relationshipBetweenOperationAndTemporaryMovement.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignTrade.oneOf.0.relationshipBetweenOperationAndTemporaryMovement","typeLabel":"enum\u003cstring> | null"},"sendInvoiceToMdic":{"oneOf":[{"type":"boolean","description":"Define se a NFS-e é compartilhada com o MDIC.","uniqueKey":"foreignTrade.oneOf.0.sendInvoiceToMdic.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Define se a NFS-e é compartilhada com o MDIC.","uniqueKey":"foreignTrade.oneOf.0.sendInvoiceToMdic.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignTrade.oneOf.0.sendInvoiceToMdic","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"foreignTrade.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"foreignTrade.oneOf.1","typeLabel":"null"}],"uniqueKey":"foreignTrade","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","integrationId":"\u003cstring>","status":"created","model":"productInvoice","environmentType":"production","issuedOn":"2023-11-07T05:31:56Z","effectiveDate":"2023-11-07T05:31:56Z","receiver":{"name":"\u003cstring>","federalTaxNumber":"\u003cstring>","stateTaxNumber":"\u003cstring>","suframaTaxNumber":"\u003cstring>","cityTaxNumber":"\u003cstring>","email":"\u003cstring>","phoneNumber":"\u003cstring>","address":{"street":"\u003cstring>","district":"\u003cstring>","postalCode":"\u003cstring>","number":"\u003cstring>","additionalInformation":"\u003cstring>","city":{"name":"\u003cstring>","state":"\u003cstring>","code":123},"country":"\u003cstring>"}},"company":{"name":"\u003cstring>","legalName":"\u003cstring>","federalTaxNumber":"\u003cstring>","stateTaxNumber":"\u003cstring>","cityTaxNumber":"\u003cstring>"},"order":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","date":"2023-11-07T05:31:56Z","transactionId":"\u003cstring>"},"authorization":{"date":"2023-11-07T05:31:56Z","protocol":"\u003cstring>","digestValue":"\u003cstring>"},"cancellation":{"date":"2023-11-07T05:31:56Z","protocol":"\u003cstring>","justification":"\u003cstring>"},"amount":123,"number":123,"processingDetail":{"status":"processing","message":"\u003cstring>","code":"\u003cstring>","on":"2023-11-07T05:31:56Z"},"isFromApi":true,"description":"\u003cstring>","totals":{"invoiceAmount":123,"netAmount":123,"issBaseTax":123,"irRate":123,"csllRate":123,"pisRate":123,"cofinsRate":123,"inssRate":123,"issRate":123,"issAmount":123,"discountUnconditionedAmount":123,"discountConditionedAmount":123,"irAmount":123,"pisCofinsBaseTax":123,"pisAmount":123,"cofinsAmount":123,"inssAmount":123,"csllAmount":123,"othersAmount":123,"deductionsAmount":123,"irWithheld":true,"issWithheld":true,"cofinsWithheld":true,"inssWithheld":true,"csllWithheld":true,"pisWithheld":true,"ibsStateRate":123,"ibsStateRedRate":123,"ibsCityRate":123,"ibsCityRedRate":123,"cbsRate":123,"cbsRedRate":123,"ibsCbsBaseTax":123,"ibsStateAmount":123,"ibsCityAmount":123,"ibsAmount":123,"cbsAmount":123,"receivedAmount":123},"rps":{"number":123,"series":"\u003cstring>"},"location":{"code":123,"name":"\u003cstring>","state":"ro"},"ibsCbs":{"cst":123,"classification":123,"operationIndicatorCode":"\u003cstring>","isPersonalUse":true,"operationType":"supplyWithSubsequentPayment","governmentEntityType":"union","property":{"fiscalPropertyTaxNumber":"\u003cstring>","cibCode":"\u003cstring>","address":{"street":"\u003cstring>","district":"\u003cstring>","postalCode":"\u003cstring>","number":"\u003cstring>","additionalInformation":"\u003cstring>","city":{"name":"\u003cstring>","state":"\u003cstring>","code":123},"country":"\u003cstring>"},"location":{"code":123,"name":"\u003cstring>","state":"ro"}}},"nbsCode":"\u003cstring>","nationalTaxationCode":"\u003cstring>","batchNumber":123,"approximateTaxes":{"federalAmount":123,"federalRate":123,"municipalRate":123,"municipalAmount":123,"stateAmount":123,"stateRate":123,"amount":123,"rate":123,"version":"\u003cstring>","source":"\u003cstring>","mode":"disabled"},"foreignTrade":{"amount":123,"currencyCode":"\u003cstring>","serviceProvisionMode":"unknown","relationshipBetweenParties":"withoutLink","supportMechanismForServiceProvider":"\u003cstring>","supportMechanismForBorrower":"\u003cstring>","relationshipBetweenOperationAndTemporaryMovement":"unknown","sendInvoiceToMdic":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"d2cb5bea-cfbb-4de8-89af-358dcfeffd01":{"description":"Bad Request — Erro de validação ou regra de negócio","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2e376681-d619-4f5f-96d6-c70af6818497":{"description":"Forbidden — Chave de API inválida","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"65fda03e-686c-48ed-a84c-879e7ad9d5fc":{"description":"Too Many Requests — Limite de requisições atingido","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"107a206a-3ecb-43e0-bfa6-1ca51327a55a":{"ApiKey":{"type":"apiKey","description":"Authorization By X-Api-Key inside request's header","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"ApiKey"}}},"servers":{"a6b8c512-0d25-45d7-9da0-4cc68c875365":{"url":"https://api.spedy.com.br","description":"Produção"},"eadd70cc-e9e3-4347-9ad4-1c4eaf09cafa":{"url":"https://sandbox-api.spedy.com.br","description":"Sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Authorization By X-Api-Key inside request's header","name":"X-Api-Key","in":"header","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"X-Api-Key","type":"string","description":"Authorization By X-Api-Key inside request's header","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKey","name":"X-Api-Key"}],"title":"ApiKey"}]},"originalFileLocation":"openapi/v1.json"},"subdomain":"spedy","siteName":"Spedy","title":"Obter NFS-e - Spedy","navMaps":{"firstHrefInVersion":{"v1":{"href":"/api-reference/nfs-e/obter-nfs-e","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T12:35:15.046Z","originalFileLocation":"api-reference/nfs-e/obter-nfs-e.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retorna a nota pelo id, com o status atual e o resultado do último processamento (processingDetail). Use para acompanhar o status quando não usa webhooks.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Spedy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Obter NFS-e - Spedy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retorna a nota pelo id, com o status atual e o resultado do último processamento (processingDetail). Use para acompanhar o status quando não usa webhooks.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Spedy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://spedy.mintlify.site/_mintlify/api/og/v2?division=NFS-e\u0026amp;title=Obter+NFS-e\u0026amp;description=Retorna+a+nota+pelo+%60id%60%2C+com+o+%60status%60+atual+e+o+resultado+do+%C3%BAltimo+processamento%0D%0A%28%60processingDetail%60%29.+Use+para+acompanhar+o+status+quando+n%C3%A3o+usa+webhooks\u0026amp;theme=6d94f11e0f2acf049e8f4ec6\u0026amp;signature=13081a3d219adef99196bd3aa138d901f3f5b08554472a0538d079c36fbc6958\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Obter NFS-e - Spedy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retorna a nota pelo id, com o status atual e o resultado do último processamento (processingDetail). Use para acompanhar o status quando não usa webhooks.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://spedy.mintlify.site/_mintlify/api/og/v2?division=NFS-e\u0026amp;title=Obter+NFS-e\u0026amp;description=Retorna+a+nota+pelo+%60id%60%2C+com+o+%60status%60+atual+e+o+resultado+do+%C3%BAltimo+processamento%0D%0A%28%60processingDetail%60%29.+Use+para+acompanhar+o+status+quando+n%C3%A3o+usa+webhooks\u0026amp;theme=6d94f11e0f2acf049e8f4ec6\u0026amp;signature=13081a3d219adef99196bd3aa138d901f3f5b08554472a0538d079c36fbc6958\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/spedy/DeB8lQkcaCwLI60P/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Spedy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D93E8D\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/nfs-e/obter-nfs-e.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.spedy.com.br/#organization\",\"name\":\"Spedy\",\"url\":\"https://docs.spedy.com.br\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/spedy/CpHdCXrsn8ll8Rr3/logo/spedy-logo.svg?fit=max\u0026auto=format\u0026n=CpHdCXrsn8ll8Rr3\u0026q=85\u0026s=43e536c2f0fa8572a8a4da15adf08d0c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.spedy.com.br#website\",\"name\":\"Spedy\",\"url\":\"https://docs.spedy.com.br\",\"publisher\":{\"@id\":\"https://docs.spedy.com.br/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e#webpage\",\"url\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e\",\"name\":\"Obter NFS-e\",\"description\":\"Retorna a nota pelo id, com o status atual e o resultado do último processamento (processingDetail). Use para acompanhar o status quando não usa webhooks.\",\"dateModified\":\"2026-11-10T12:35:15.046Z\",\"isPartOf\":{\"@id\":\"https://docs.spedy.com.br#website\"},\"breadcrumb\":{\"@id\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.spedy.com.br/api-reference/empresas/listar-empresas\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"NFS-e\",\"item\":\"https://docs.spedy.com.br/api-reference/nfs-e/listar-notas-fiscais\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Obter NFS-e\",\"item\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e#apireference\",\"headline\":\"Obter NFS-e\",\"name\":\"Obter NFS-e\",\"description\":\"Retorna a nota pelo id, com o status atual e o resultado do último processamento (processingDetail). Use para acompanhar o status quando não usa webhooks.\",\"url\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e\",\"mainEntityOfPage\":{\"@id\":\"https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e#webpage\"},\"dateModified\":\"2026-11-10T12:35:15.046Z\",\"publisher\":{\"@id\":\"https://docs.spedy.com.br/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.spedy.com.br#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Spedy\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Spedy","nav":{"global":null,"versions":[{"version":"v1","tag":"Current","tabs":[{"tab":"Comece aqui","icon":"rocket","pages":[{"title":"Comece aqui","href":""}]},{"tab":"Guias","icon":"book-open","pages":[{"title":"Guias","href":"/guides/conceitos-modelo-de-dados"}]},{"tab":"Webhooks","icon":"bell","pages":[{"title":"Webhooks","href":"/webhooks/visao-geral"}]},{"tab":"Referência da API","icon":"code","groups":[{"group":"Visão geral","pages":[{"title":"Introdução à referência","href":"/reference/introducao"},{"title":"Erros e rejeições","href":"/reference/erros-e-rejeicoes"}]},{"group":"Endpoints","pages":[{"group":"Empresas","pages":[{"title":"Listar Empresas","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/companies","href":"/api-reference/empresas/listar-empresas"},{"title":"Criar Empresa","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/companies","href":"/api-reference/empresas/criar-empresa"},{"title":"Obter Empresa","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/companies/{id}","href":"/api-reference/empresas/obter-empresa"},{"title":"Alterar Empresa","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/companies/{id}","href":"/api-reference/empresas/alterar-empresa"},{"title":"Excluir Empresa","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/companies/{id}","href":"/api-reference/empresas/excluir-empresa"},{"title":"Obter certificados","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/companies/{id}/certificates","href":"/api-reference/empresas/obter-certificados"},{"title":"Adicionar certificado","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/companies/{id}/certificates","href":"/api-reference/empresas/adicionar-certificado"},{"title":"Obter configurações","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/companies/{id}/settings","href":"/api-reference/empresas/obter-configurações"},{"title":"Alterar configurações","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/companies/{id}/settings","href":"/api-reference/empresas/alterar-configurações"}]},{"group":"Vendas","pages":[{"title":"Listar Vendas","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/orders","href":"/api-reference/vendas/listar-vendas"},{"title":"Criar Venda","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/orders","href":"/api-reference/vendas/criar-venda"},{"title":"Obter Venda","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/orders/{id}","href":"/api-reference/vendas/obter-venda"},{"title":"Alterar Venda","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/orders/{id}","href":"/api-reference/vendas/alterar-venda"},{"title":"Emitir notas fiscais da venda","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/orders/{id}/invoices/issue","href":"/api-reference/vendas/emitir-notas-fiscais-da-venda"},{"title":"Alterar status","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/orders/{id}/status","href":"/api-reference/vendas/alterar-status"},{"title":"Cancelar venda","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/orders/{id}/cancel","href":"/api-reference/vendas/cancelar-venda"}]},{"group":"Clientes","pages":[{"title":"Listar Clientes","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/customers","href":"/api-reference/clientes/listar-clientes"},{"title":"Criar Cliente","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/customers","href":"/api-reference/clientes/criar-cliente"},{"title":"Obter Cliente","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/customers/{id}","href":"/api-reference/clientes/obter-cliente"},{"title":"Alterar Cliente","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/customers/{id}","href":"/api-reference/clientes/alterar-cliente"},{"title":"Excluir Cliente","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/customers/{id}","href":"/api-reference/clientes/excluir-cliente"}]},{"group":"Produtos","pages":[{"title":"Listar Produtos","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/products","href":"/api-reference/produtos/listar-produtos"},{"title":"Criar Produto","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/products","href":"/api-reference/produtos/criar-produto"},{"title":"Obter Produto","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/products/{id}","href":"/api-reference/produtos/obter-produto"},{"title":"Alterar Produto","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/products/{id}","href":"/api-reference/produtos/alterar-produto"},{"title":"Excluir Produto","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/products/{id}","href":"/api-reference/produtos/excluir-produto"}]},{"group":"NF-e","pages":[{"title":"Listar Notas Fiscais","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices","href":"/api-reference/nf-e/listar-notas-fiscais"},{"title":"Criar NF-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/product-invoices","href":"/api-reference/nf-e/criar-nf-e"},{"title":"Obter NF-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/{id}","href":"/api-reference/nf-e/obter-nf-e"},{"title":"Cancelar NF-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/product-invoices/{id}","href":"/api-reference/nf-e/cancelar-nf-e"},{"title":"PDF da Carta de Correção","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/{id}/corrections/{eventId}/pdf","href":"/api-reference/nf-e/pdf-da-carta-de-correção"},{"title":"XML da Carta de Correção","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/{id}/corrections/{eventId}/xml","href":"/api-reference/nf-e/xml-da-carta-de-correção"},{"title":"Listar eventos da NF-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/{id}/events","href":"/api-reference/nf-e/listar-eventos-da-nf-e"},{"title":"Download do XML de um evento da NF-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/{id}/events/{eventId}/xml","href":"/api-reference/nf-e/download-do-xml-de-um-evento-da-nf-e"},{"title":"Download do PDF da NF-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/{id}/pdf","href":"/api-reference/nf-e/download-do-pdf-da-nf-e"},{"title":"Download do XML da NF-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/{id}/xml","href":"/api-reference/nf-e/download-do-xml-da-nf-e"},{"title":"Listar inutilizações","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/disablements","href":"/api-reference/nf-e/listar-inutilizações"},{"title":"Inutilização de numeração","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/product-invoices/disablements","href":"/api-reference/nf-e/inutilização-de-numeração"},{"title":"Obter Inutilização","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/disablements/{id}","href":"/api-reference/nf-e/obter-inutilização"},{"title":"XML da Inutilização","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/product-invoices/disablements/{id}/xml","href":"/api-reference/nf-e/xml-da-inutilização"},{"title":"Consultar nota fiscal","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/product-invoices/{id}/check-status","href":"/api-reference/nf-e/consultar-nota-fiscal"},{"title":"Carta de Correção","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/product-invoices/{id}/corrections","href":"/api-reference/nf-e/carta-de-correção"},{"title":"Reemitir nota fiscal","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/product-invoices/{id}/issue","href":"/api-reference/nf-e/reemitir-nota-fiscal"},{"title":"Reenviar e-mail","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/product-invoices/{id}/resend-email","href":"/api-reference/nf-e/reenviar-e-mail"}]},{"group":"NFC-e","pages":[{"title":"Listar Notas Fiscais","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices","href":"/api-reference/nfc-e/listar-notas-fiscais"},{"title":"Criar NFC-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/consumer-invoices","href":"/api-reference/nfc-e/criar-nfc-e"},{"title":"Obter NFC-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/{id}","href":"/api-reference/nfc-e/obter-nfc-e"},{"title":"Cancelar NFC-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/consumer-invoices/{id}","href":"/api-reference/nfc-e/cancelar-nfc-e"},{"title":"Listar eventos da NFC-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/{id}/events","href":"/api-reference/nfc-e/listar-eventos-da-nfc-e"},{"title":"Download do XML de um evento da NFC-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/{id}/events/{eventId}/xml","href":"/api-reference/nfc-e/download-do-xml-de-um-evento-da-nfc-e"},{"title":"Download do PDF da NFC-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/{id}/pdf","href":"/api-reference/nfc-e/download-do-pdf-da-nfc-e"},{"title":"Download do XML da NFC-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/{id}/xml","href":"/api-reference/nfc-e/download-do-xml-da-nfc-e"},{"title":"Listar inutilizações","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/disablements","href":"/api-reference/nfc-e/listar-inutilizações"},{"title":"Inutilização de numeração","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/consumer-invoices/disablements","href":"/api-reference/nfc-e/inutilização-de-numeração"},{"title":"Obter Inutilização","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/disablements/{id}","href":"/api-reference/nfc-e/obter-inutilização"},{"title":"XML da Inutilização","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/consumer-invoices/disablements/{id}/xml","href":"/api-reference/nfc-e/xml-da-inutilização"},{"title":"Consultar nota fiscal","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/consumer-invoices/{id}/check-status","href":"/api-reference/nfc-e/consultar-nota-fiscal"},{"title":"Reemitir nota fiscal","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/consumer-invoices/{id}/issue","href":"/api-reference/nfc-e/reemitir-nota-fiscal"},{"title":"Reenviar e-mail","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/consumer-invoices/{id}/resend-email","href":"/api-reference/nfc-e/reenviar-e-mail"}]},{"group":"NFS-e","pages":[{"title":"Listar Notas Fiscais","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices","href":"/api-reference/nfs-e/listar-notas-fiscais"},{"title":"Criar NFS-e","description":"Cria uma **NFS-e** (nota de serviço) e a enfileira para emissão junto à prefeitura/provedor\r\nmunicipal. A emissão é **assíncrona**: a resposta `2xx` confirma que a solicitação foi aceita, não\r\nque a nota foi autorizada — acompanhe o resultado por webhook ou consulta.\r\n \r\n**integrationId** — Identificador da nota no seu sistema (máx. 36 caracteres). Recomendado em todas as integrações:\r\n \r\n- **Associação:** vincula a NFS-e gerada pela Spedy a um ID do seu sistema (ex: ID do pedido)\r\n- **Idempotência:** um segundo POST com o mesmo `integrationId` atualiza a nota existente em vez de criar uma nova — protege contra duplicidade em retries e timeouts\r\n- **Correção de rejeitada:** para corrigir uma NFS-e rejeitada, reenvie o POST com os dados corrigidos e o mesmo `integrationId` — sem necessidade de deletar a nota anterior","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/service-invoices","href":"/api-reference/nfs-e/criar-nfs-e"},{"title":"Obter NFS-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/{id}","href":"/api-reference/nfs-e/obter-nfs-e"},{"title":"Cancelar NFS-e","description":"Cancela uma nota **autorizada**, dentro do prazo legal, informando a justificativa (`reason`).\r\nO cancelamento é processado de forma **assíncrona** até o status `canceled` — acompanhe por webhook ou consulta.\r\nPrazos e regras variam por UF (NF-e/NFC-e) e por município (NFS-e).","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/service-invoices/{id}","href":"/api-reference/nfs-e/cancelar-nfs-e"},{"title":"Listar eventos da NFS-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/{id}/events","href":"/api-reference/nfs-e/listar-eventos-da-nfs-e"},{"title":"Download do XML de um evento da NFS-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/{id}/events/{eventId}/xml","href":"/api-reference/nfs-e/download-do-xml-de-um-evento-da-nfs-e"},{"title":"Download do PDF da NFS-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/{id}/pdf","href":"/api-reference/nfs-e/download-do-pdf-da-nfs-e"},{"title":"Download do XML da NFS-e","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/{id}/xml","href":"/api-reference/nfs-e/download-do-xml-da-nfs-e"},{"title":"Cidades integradas","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/cities","href":"/api-reference/nfs-e/cidades-integradas"},{"title":"Configurações de emissão por município","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/service-invoices/cities/{cityCode}/settings","href":"/api-reference/nfs-e/configurações-de-emissão-por-município"},{"title":"Consultar nota fiscal","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/service-invoices/{id}/check-status","href":"/api-reference/nfs-e/consultar-nota-fiscal"},{"title":"Reemitir nota fiscal","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/service-invoices/{id}/issue","href":"/api-reference/nfs-e/reemitir-nota-fiscal"},{"title":"Reenviar e-mail","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/service-invoices/{id}/resend-email","href":"/api-reference/nfs-e/reenviar-e-mail"}]},{"group":"Webhooks","pages":[{"title":"Listar Webhooks","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/webhooks","href":"/api-reference/webhooks/listar-webhooks"},{"title":"Criar Webhook","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/webhooks","href":"/api-reference/webhooks/criar-webhook"},{"title":"Obter Webhook","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/webhooks/{id}","href":"/api-reference/webhooks/obter-webhook"},{"title":"Alterar Webhook","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/webhooks/{id}","href":"/api-reference/webhooks/alterar-webhook"},{"title":"Excluir Webhook","deprecated":null,"version":null,"openapi":"/openapi/v1.json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/excluir-webhook"},{"title":"Consultar segredo de assinatura","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/webhooks/secret","href":"/api-reference/webhooks/consultar-segredo-de-assinatura"},{"title":"Rotacionar segredo de assinatura","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/webhooks/secret/rotate","href":"/api-reference/webhooks/rotacionar-segredo-de-assinatura"},{"title":"Desabilitar Webhook","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/webhooks/{id}/disable","href":"/api-reference/webhooks/desabilitar-webhook"},{"title":"Habilitar Webhook","deprecated":null,"version":null,"openapi":"/openapi/v1.json put /v1/webhooks/{id}/enable","href":"/api-reference/webhooks/habilitar-webhook"}]},{"group":"NF-e Recebidas","pages":[{"title":"Listar NF-e Recebidas","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-product-invoices","href":"/api-reference/nf-e-recebidas/listar-nf-e-recebidas"},{"title":"Obter NF-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-product-invoices/{id}","href":"/api-reference/nf-e-recebidas/obter-nf-e-recebida"},{"title":"Download do DANFE (PDF) da NF-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-product-invoices/{id}/pdf","href":"/api-reference/nf-e-recebidas/download-do-danfe-pdf-da-nf-e-recebida"},{"title":"Download do XML da NF-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-product-invoices/{id}/xml","href":"/api-reference/nf-e-recebidas/download-do-xml-da-nf-e-recebida"},{"title":"Status de sincronização de NF-e Recebidas","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-product-invoices/sync-status","href":"/api-reference/nf-e-recebidas/status-de-sincronização-de-nf-e-recebidas"},{"title":"Manifestar NF-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/inbound-product-invoices/{id}/manifest","href":"/api-reference/nf-e-recebidas/manifestar-nf-e-recebida"},{"title":"Solicitar sincronização de NF-e Recebidas","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/inbound-product-invoices/sync","href":"/api-reference/nf-e-recebidas/solicitar-sincronização-de-nf-e-recebidas"}]},{"group":"NFS-e Recebidas","pages":[{"title":"Listar NFS-e Recebidas","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-service-invoices","href":"/api-reference/nfs-e-recebidas/listar-nfs-e-recebidas"},{"title":"Obter NFS-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-service-invoices/{id}","href":"/api-reference/nfs-e-recebidas/obter-nfs-e-recebida"},{"title":"Download do DANFSe (PDF) da NFS-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-service-invoices/{id}/pdf","href":"/api-reference/nfs-e-recebidas/download-do-danfse-pdf-da-nfs-e-recebida"},{"title":"Download do XML da NFS-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-service-invoices/{id}/xml","href":"/api-reference/nfs-e-recebidas/download-do-xml-da-nfs-e-recebida"},{"title":"Status de sincronização de NFS-e Recebidas","deprecated":null,"version":null,"openapi":"/openapi/v1.json get /v1/inbound-service-invoices/sync-status","href":"/api-reference/nfs-e-recebidas/status-de-sincronização-de-nfs-e-recebidas"},{"title":"Manifestar NFS-e Recebida","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/inbound-service-invoices/{id}/manifest","href":"/api-reference/nfs-e-recebidas/manifestar-nfs-e-recebida"},{"title":"Solicitar sincronização de NFS-e Recebidas","deprecated":null,"version":null,"openapi":"/openapi/v1.json post /v1/inbound-service-invoices/sync","href":"/api-reference/nfs-e-recebidas/solicitar-sincronização-de-nfs-e-recebidas"}]}]}]},{"tab":"Changelog","icon":"scroll","pages":[{"title":"Changelog","href":"/changelog"}]}]}]},"basePath":"","title":"Obter NFS-e - Spedy","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}