focus_nfe 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (206) hide show
  1. checksums.yaml +7 -0
  2. data/.git-hooks/pre_push/steep.rb +18 -0
  3. data/.git-hooks/pre_push/yard_doc.rb +18 -0
  4. data/.gitattributes +1 -0
  5. data/.overcommit.yml +69 -0
  6. data/.rspec +3 -0
  7. data/.yardopts +11 -0
  8. data/CHANGELOG.md +77 -0
  9. data/CLAUDE.md +118 -0
  10. data/CODE_OF_CONDUCT.md +10 -0
  11. data/LICENSE.txt +21 -0
  12. data/README.md +348 -0
  13. data/Rakefile +105 -0
  14. data/data/schemas/schema_cte.json +2793 -0
  15. data/data/schemas/schema_cte_os.json +1335 -0
  16. data/data/schemas/schema_cte_os_transporte_rodoviario.json +109 -0
  17. data/data/schemas/schema_cte_transporte_aereo.json +115 -0
  18. data/data/schemas/schema_cte_transporte_aquaviario.json +174 -0
  19. data/data/schemas/schema_cte_transporte_dutoviario.json +65 -0
  20. data/data/schemas/schema_cte_transporte_ferroviario.json +144 -0
  21. data/data/schemas/schema_cte_transporte_multimodal.json +45 -0
  22. data/data/schemas/schema_cte_transporte_rodoviario.json +78 -0
  23. data/data/schemas/schema_dce.json +549 -0
  24. data/data/schemas/schema_mdfe.json +1102 -0
  25. data/data/schemas/schema_mdfe_transporte_aereo.json +44 -0
  26. data/data/schemas/schema_mdfe_transporte_aquaviario.json +209 -0
  27. data/data/schemas/schema_mdfe_transporte_ferroviario.json +99 -0
  28. data/data/schemas/schema_mdfe_transporte_rodoviario.json +628 -0
  29. data/data/schemas/schema_nfcom.json +1859 -0
  30. data/data/schemas/schema_nfe.json +4750 -0
  31. data/data/schemas/schema_nfe_forma_pagamento.json +97 -0
  32. data/data/schemas/schema_nfe_item.json +2574 -0
  33. data/data/schemas/schema_nfgas.json +2316 -0
  34. data/data/schemas/schema_nfse_nacional.json +1847 -0
  35. data/data/schemas/schema_nfse_recebida.json +548 -0
  36. data/lib/focus_nfe/client.rb +162 -0
  37. data/lib/focus_nfe/configuration.rb +104 -0
  38. data/lib/focus_nfe/errors.rb +123 -0
  39. data/lib/focus_nfe/esquemas/campo.rb +171 -0
  40. data/lib/focus_nfe/esquemas/catalogo.rb +34 -0
  41. data/lib/focus_nfe/esquemas/decimal.rb +66 -0
  42. data/lib/focus_nfe/esquemas/esquema.rb +72 -0
  43. data/lib/focus_nfe/esquemas/validador.rb +87 -0
  44. data/lib/focus_nfe/http/adapter.rb +25 -0
  45. data/lib/focus_nfe/http/adapters/net_http.rb +99 -0
  46. data/lib/focus_nfe/http/authentication.rb +23 -0
  47. data/lib/focus_nfe/http/connection.rb +118 -0
  48. data/lib/focus_nfe/http/logging.rb +100 -0
  49. data/lib/focus_nfe/http/response.rb +75 -0
  50. data/lib/focus_nfe/modelos/documento.rb +113 -0
  51. data/lib/focus_nfe/modelos/inutilizacao.rb +75 -0
  52. data/lib/focus_nfe/modelos/pagina.rb +54 -0
  53. data/lib/focus_nfe/recursos/backups.rb +17 -0
  54. data/lib/focus_nfe/recursos/base.rb +91 -0
  55. data/lib/focus_nfe/recursos/ceps.rb +16 -0
  56. data/lib/focus_nfe/recursos/cfops.rb +16 -0
  57. data/lib/focus_nfe/recursos/cnaes.rb +16 -0
  58. data/lib/focus_nfe/recursos/cnpjs.rb +13 -0
  59. data/lib/focus_nfe/recursos/concerns/baixavel.rb +41 -0
  60. data/lib/focus_nfe/recursos/concerns/baixavel_eventos.rb +34 -0
  61. data/lib/focus_nfe/recursos/concerns/cancelavel.rb +25 -0
  62. data/lib/focus_nfe/recursos/concerns/conciliavel.rb +66 -0
  63. data/lib/focus_nfe/recursos/concerns/consultavel.rb +26 -0
  64. data/lib/focus_nfe/recursos/concerns/corrigivel.rb +45 -0
  65. data/lib/focus_nfe/recursos/concerns/corrigivel_cte.rb +60 -0
  66. data/lib/focus_nfe/recursos/concerns/emitivel.rb +51 -0
  67. data/lib/focus_nfe/recursos/concerns/enviavel.rb +40 -0
  68. data/lib/focus_nfe/recursos/concerns/eventavel.rb +46 -0
  69. data/lib/focus_nfe/recursos/concerns/inutilizavel.rb +96 -0
  70. data/lib/focus_nfe/recursos/concerns/listavel.rb +22 -0
  71. data/lib/focus_nfe/recursos/concerns/localizavel.rb +22 -0
  72. data/lib/focus_nfe/recursos/concerns/notificavel.rb +23 -0
  73. data/lib/focus_nfe/recursos/concerns/removivel.rb +20 -0
  74. data/lib/focus_nfe/recursos/concerns/visualizavel.rb +28 -0
  75. data/lib/focus_nfe/recursos/cte.rb +35 -0
  76. data/lib/focus_nfe/recursos/cte_os.rb +29 -0
  77. data/lib/focus_nfe/recursos/ctes_recebidas.rb +38 -0
  78. data/lib/focus_nfe/recursos/dce.rb +16 -0
  79. data/lib/focus_nfe/recursos/emails_bloqueados.rb +31 -0
  80. data/lib/focus_nfe/recursos/empresas.rb +35 -0
  81. data/lib/focus_nfe/recursos/mdfe.rb +78 -0
  82. data/lib/focus_nfe/recursos/municipios.rb +60 -0
  83. data/lib/focus_nfe/recursos/ncms.rb +16 -0
  84. data/lib/focus_nfe/recursos/nfce.rb +19 -0
  85. data/lib/focus_nfe/recursos/nfcom.rb +16 -0
  86. data/lib/focus_nfe/recursos/nfe.rb +106 -0
  87. data/lib/focus_nfe/recursos/nfes_recebidas.rb +56 -0
  88. data/lib/focus_nfe/recursos/nfgas.rb +16 -0
  89. data/lib/focus_nfe/recursos/nfse.rb +18 -0
  90. data/lib/focus_nfe/recursos/nfse_nacional.rb +16 -0
  91. data/lib/focus_nfe/recursos/nfses_nacionais_recebidas.rb +21 -0
  92. data/lib/focus_nfe/recursos/webhooks.rb +22 -0
  93. data/lib/focus_nfe/version.rb +6 -0
  94. data/lib/focus_nfe/webhook.rb +68 -0
  95. data/lib/focus_nfe.rb +124 -0
  96. data/sig/focus_nfe/client.rbs +38 -0
  97. data/sig/focus_nfe/configuration.rbs +29 -0
  98. data/sig/focus_nfe/errors.rbs +59 -0
  99. data/sig/focus_nfe/esquemas/campo.rbs +47 -0
  100. data/sig/focus_nfe/esquemas/catalogo.rbs +8 -0
  101. data/sig/focus_nfe/esquemas/decimal.rbs +25 -0
  102. data/sig/focus_nfe/esquemas/esquema.rbs +30 -0
  103. data/sig/focus_nfe/esquemas/validador.rbs +20 -0
  104. data/sig/focus_nfe/http/adapter.rbs +7 -0
  105. data/sig/focus_nfe/http/adapters/net_http.rbs +25 -0
  106. data/sig/focus_nfe/http/authentication.rbs +9 -0
  107. data/sig/focus_nfe/http/connection.rbs +32 -0
  108. data/sig/focus_nfe/http/logging.rbs +30 -0
  109. data/sig/focus_nfe/http/response.rbs +28 -0
  110. data/sig/focus_nfe/modelos/documento.rbs +34 -0
  111. data/sig/focus_nfe/modelos/inutilizacao.rbs +24 -0
  112. data/sig/focus_nfe/modelos/pagina.rbs +21 -0
  113. data/sig/focus_nfe/recursos/backups.rbs +7 -0
  114. data/sig/focus_nfe/recursos/base.rbs +25 -0
  115. data/sig/focus_nfe/recursos/ceps.rbs +10 -0
  116. data/sig/focus_nfe/recursos/cfops.rbs +10 -0
  117. data/sig/focus_nfe/recursos/cnaes.rbs +10 -0
  118. data/sig/focus_nfe/recursos/cnpjs.rbs +7 -0
  119. data/sig/focus_nfe/recursos/concerns/baixavel.rbs +12 -0
  120. data/sig/focus_nfe/recursos/concerns/baixavel_eventos.rbs +14 -0
  121. data/sig/focus_nfe/recursos/concerns/cancelavel.rbs +9 -0
  122. data/sig/focus_nfe/recursos/concerns/conciliavel.rbs +15 -0
  123. data/sig/focus_nfe/recursos/concerns/consultavel.rbs +9 -0
  124. data/sig/focus_nfe/recursos/concerns/corrigivel.rbs +15 -0
  125. data/sig/focus_nfe/recursos/concerns/corrigivel_cte.rbs +17 -0
  126. data/sig/focus_nfe/recursos/concerns/emitivel.rbs +14 -0
  127. data/sig/focus_nfe/recursos/concerns/enviavel.rbs +15 -0
  128. data/sig/focus_nfe/recursos/concerns/eventavel.rbs +12 -0
  129. data/sig/focus_nfe/recursos/concerns/inutilizavel.rbs +20 -0
  130. data/sig/focus_nfe/recursos/concerns/listavel.rbs +9 -0
  131. data/sig/focus_nfe/recursos/concerns/localizavel.rbs +9 -0
  132. data/sig/focus_nfe/recursos/concerns/notificavel.rbs +9 -0
  133. data/sig/focus_nfe/recursos/concerns/removivel.rbs +9 -0
  134. data/sig/focus_nfe/recursos/concerns/visualizavel.rbs +9 -0
  135. data/sig/focus_nfe/recursos/cte.rbs +17 -0
  136. data/sig/focus_nfe/recursos/cte_os.rbs +17 -0
  137. data/sig/focus_nfe/recursos/ctes_recebidas.rbs +14 -0
  138. data/sig/focus_nfe/recursos/dce.rbs +10 -0
  139. data/sig/focus_nfe/recursos/emails_bloqueados.rbs +12 -0
  140. data/sig/focus_nfe/recursos/empresas.rbs +12 -0
  141. data/sig/focus_nfe/recursos/mdfe.rbs +21 -0
  142. data/sig/focus_nfe/recursos/municipios.rbs +19 -0
  143. data/sig/focus_nfe/recursos/ncms.rbs +10 -0
  144. data/sig/focus_nfe/recursos/nfce.rbs +12 -0
  145. data/sig/focus_nfe/recursos/nfcom.rbs +10 -0
  146. data/sig/focus_nfe/recursos/nfe.rbs +23 -0
  147. data/sig/focus_nfe/recursos/nfes_recebidas.rbs +16 -0
  148. data/sig/focus_nfe/recursos/nfgas.rbs +10 -0
  149. data/sig/focus_nfe/recursos/nfse.rbs +11 -0
  150. data/sig/focus_nfe/recursos/nfse_nacional.rbs +10 -0
  151. data/sig/focus_nfe/recursos/nfses_nacionais_recebidas.rbs +11 -0
  152. data/sig/focus_nfe/recursos/webhooks.rbs +11 -0
  153. data/sig/focus_nfe/webhook.rbs +11 -0
  154. data/sig/focus_nfe.rbs +10 -0
  155. data/spec/focus_nfe/client_spec.rb +208 -0
  156. data/spec/focus_nfe/configuration_spec.rb +121 -0
  157. data/spec/focus_nfe/errors_mapping_spec.rb +68 -0
  158. data/spec/focus_nfe/errors_spec.rb +107 -0
  159. data/spec/focus_nfe/esquemas/campo_spec.rb +291 -0
  160. data/spec/focus_nfe/esquemas/decimal_spec.rb +54 -0
  161. data/spec/focus_nfe/esquemas/esquema_spec.rb +73 -0
  162. data/spec/focus_nfe/esquemas/validador_spec.rb +167 -0
  163. data/spec/focus_nfe/esquemas_spec.rb +42 -0
  164. data/spec/focus_nfe/http/adapter_spec.rb +8 -0
  165. data/spec/focus_nfe/http/adapters/net_http_spec.rb +181 -0
  166. data/spec/focus_nfe/http/authentication_spec.rb +24 -0
  167. data/spec/focus_nfe/http/connection_spec.rb +255 -0
  168. data/spec/focus_nfe/http/logging_spec.rb +83 -0
  169. data/spec/focus_nfe/http/response_spec.rb +161 -0
  170. data/spec/focus_nfe/modelos/documento_spec.rb +150 -0
  171. data/spec/focus_nfe/modelos/inutilizacao_spec.rb +91 -0
  172. data/spec/focus_nfe/modelos/pagina_spec.rb +77 -0
  173. data/spec/focus_nfe/recursos/backups_spec.rb +29 -0
  174. data/spec/focus_nfe/recursos/base_spec.rb +56 -0
  175. data/spec/focus_nfe/recursos/ceps_spec.rb +16 -0
  176. data/spec/focus_nfe/recursos/cfops_spec.rb +16 -0
  177. data/spec/focus_nfe/recursos/cnaes_spec.rb +20 -0
  178. data/spec/focus_nfe/recursos/cnpjs_spec.rb +11 -0
  179. data/spec/focus_nfe/recursos/concerns/emitivel_validacao_spec.rb +158 -0
  180. data/spec/focus_nfe/recursos/cte_os_spec.rb +9 -0
  181. data/spec/focus_nfe/recursos/cte_spec.rb +9 -0
  182. data/spec/focus_nfe/recursos/ctes_recebidas_spec.rb +56 -0
  183. data/spec/focus_nfe/recursos/dce_spec.rb +8 -0
  184. data/spec/focus_nfe/recursos/emails_bloqueados_spec.rb +29 -0
  185. data/spec/focus_nfe/recursos/empresas_spec.rb +45 -0
  186. data/spec/focus_nfe/recursos/mdfe_spec.rb +100 -0
  187. data/spec/focus_nfe/recursos/municipios_spec.rb +58 -0
  188. data/spec/focus_nfe/recursos/ncms_spec.rb +16 -0
  189. data/spec/focus_nfe/recursos/nfce_spec.rb +10 -0
  190. data/spec/focus_nfe/recursos/nfcom_spec.rb +8 -0
  191. data/spec/focus_nfe/recursos/nfe_spec.rb +262 -0
  192. data/spec/focus_nfe/recursos/nfes_recebidas_spec.rb +87 -0
  193. data/spec/focus_nfe/recursos/nfgas_spec.rb +8 -0
  194. data/spec/focus_nfe/recursos/nfse_nacional_spec.rb +8 -0
  195. data/spec/focus_nfe/recursos/nfse_spec.rb +9 -0
  196. data/spec/focus_nfe/recursos/nfses_nacionais_recebidas_spec.rb +17 -0
  197. data/spec/focus_nfe/recursos/webhooks_spec.rb +22 -0
  198. data/spec/focus_nfe/webhook_spec.rb +66 -0
  199. data/spec/focus_nfe_global_configuration_spec.rb +70 -0
  200. data/spec/focus_nfe_require_spec.rb +87 -0
  201. data/spec/focus_nfe_spec.rb +11 -0
  202. data/spec/spec_helper.rb +58 -0
  203. data/spec/support/shared_examples/recurso_fiscal.rb +445 -0
  204. data/spec/support/shared_examples/recurso_leitura.rb +217 -0
  205. data/tools/pull_fields.rb +62 -0
  206. metadata +420 -0
@@ -0,0 +1,1859 @@
1
+ [
2
+ {
3
+ "name": "serie",
4
+ "description": "Série do documento fiscal. Deixe em branco para que a API se responsabilize pela numeração automática (recomendado).",
5
+ "type": "String[1-3]",
6
+ "required": true,
7
+ "tag": "serie"
8
+ },
9
+ {
10
+ "name": "numero",
11
+ "description": "Número do documento fiscal. Deixe em branco para que a API se responsabilize pela numeração automática (recomendado).",
12
+ "type": "String[1-9]",
13
+ "required": true,
14
+ "tag": "nNF"
15
+ },
16
+ {
17
+ "name": "data_emissao",
18
+ "description": "Data e hora de emissão do documento fiscal.",
19
+ "type": null,
20
+ "required": true,
21
+ "tag": "dhEmi"
22
+ },
23
+ {
24
+ "name": "numero_site",
25
+ "description": "Identificação do número do Site do Autorizador de recepção da NFCom. Se o autorizador da NFCom possuir apenas um site deverá ser informado com Zero (0), em caso de autorizador trabalhar com múltiplos sites indicar o número do site para qual foi endereçada a NFCOM (1 a 9).",
26
+ "type": null,
27
+ "required": true,
28
+ "enum": "",
29
+ "tag": "nSiteAutoriz"
30
+ },
31
+ {
32
+ "name": "municipio",
33
+ "description": "Código do município de ocorrência do fato gerador.",
34
+ "type": "Integer[7]",
35
+ "required": true,
36
+ "tag": "cMunFG"
37
+ },
38
+ {
39
+ "name": "finalidade_nfcom",
40
+ "description": "Finalidade de emissão da NFCom. Deixar em branco a API atribui '0' ao campo.",
41
+ "type": null,
42
+ "required": true,
43
+ "enum": "* +0+: NFCom Normal\\n* +3+: NFCom de Substituição\\n* +4+: NFCom ajuste de débito",
44
+ "tag": "finNFCom"
45
+ },
46
+ {
47
+ "name": "tipo_faturamento",
48
+ "description": "Tipo de Faturamento da NFCom. Deixar em branco a API atribui '0' ao campo.",
49
+ "type": null,
50
+ "required": true,
51
+ "enum": "* +0+: Faturamento Normal\\n* +1+: Faturamento centralizado\\n* +2+: Cofaturamento",
52
+ "tag": "tpFat"
53
+ },
54
+ {
55
+ "name": "versao_aplicativo",
56
+ "description": "Versão do processo de emissão.",
57
+ "type": "String[1-20]",
58
+ "required": true,
59
+ "tag": "verProc"
60
+ },
61
+ {
62
+ "name": "indicador_prepago",
63
+ "description": "Indicador de serviço pré-pago.",
64
+ "type": null,
65
+ "required": false,
66
+ "enum": "* +1+: Serviço pré-pago (informar a tag somente se a nota for referente a um serviço exclusivamente pré-pago)",
67
+ "tag": "indPrePago"
68
+ },
69
+ {
70
+ "name": "indicador_cessao",
71
+ "description": "Indicador de Sessão de Meios de Rede.",
72
+ "type": null,
73
+ "required": false,
74
+ "enum": "* +1+: Dispensa geração do grupo Fatura. Apenas para notas dos tipos Normal e Substituição com tipo de faturamento normal",
75
+ "tag": "indCessaoMeiosRede"
76
+ },
77
+ {
78
+ "name": "data_entrada_contingencia",
79
+ "description": "Data e Hora da entrada em contingência.",
80
+ "type": null,
81
+ "required": false,
82
+ "tag": "dhCont"
83
+ },
84
+ {
85
+ "name": "motivo_entrada_contingencia",
86
+ "description": "Justificativa da entrada em contingência.",
87
+ "type": "String[15-256]",
88
+ "required": false,
89
+ "tag": "xJust"
90
+ },
91
+ {
92
+ "name": "tipo_compra_governamental",
93
+ "description": "Para administração pública direta e suas autarquias e fundações",
94
+ "type": null,
95
+ "required": false,
96
+ "reforma_tributaria": true,
97
+ "enum": "* +1+: União\\n* +2+: Estado\\n* +3+: Distrito Federal\\n* +4+: Município\\n* +5+: Consórcio Público\\n* +6+: Comitê Gestor do IBS",
98
+ "tag": "tpEnteGov"
99
+ },
100
+ {
101
+ "name": "perc_reducao_aliquota_compra_governamental",
102
+ "description": "Percentual de redução de alíquota em compra governamental",
103
+ "type": "Decimal[3.2-4]",
104
+ "required": false,
105
+ "reforma_tributaria": true,
106
+ "tag": "pRedutor"
107
+ },
108
+ {
109
+ "name": "tipo_operacao_governamental",
110
+ "description": "Tipo de operação com ente governamental",
111
+ "type": null,
112
+ "required": false,
113
+ "enum": "* +1+: Fornecimento com pagamento posterior\\n* +2+: Recebimento do pagamento com fornecimento já realizado\\n* +3+: Fornecimento com pagamento já realizado\\n* +4+: Recebimento do pagamento com fornecimento posterior",
114
+ "tag": "tpOperGov"
115
+ },
116
+ {
117
+ "name": "chave_acesso_dfe_anterior",
118
+ "description": "Chave de acesso do documento fiscal anterior. Deverá ser informado para tpOperGov 2 e 3 e vedado para os tipos 1 e 4.",
119
+ "type": "String[44]",
120
+ "required": false,
121
+ "tag": "refDFeAnt"
122
+ },
123
+ {
124
+ "name": "cnpj_emitente",
125
+ "description": "CNPJ da emitente.",
126
+ "type": "String[14]",
127
+ "required": true,
128
+ "tag": "CNPJ"
129
+ },
130
+ {
131
+ "name": "inscricao_estadual_emitente",
132
+ "description": "Inscrição Estadual do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
133
+ "type": "String[2-14]",
134
+ "required": true,
135
+ "tag": "IE"
136
+ },
137
+ {
138
+ "name": "ie_virtual_emitente",
139
+ "description": "Inscrição Estadual Virtual do emitente na UF de Destino da partilha (IE Virtual).",
140
+ "type": "String[2-14]",
141
+ "required": false,
142
+ "tag": "IEUFDest"
143
+ },
144
+ {
145
+ "name": "regime_tributario_emitente",
146
+ "description": "Código de regime tributário. Utiliza os dados do cadastro da empresa quando omitido.",
147
+ "type": null,
148
+ "required": true,
149
+ "enum": "* +1+: Simples Nacional\\n* +2+: Simples Nacional - excesso de sublimite de receita bruta\\n* +3+: Regime Normal",
150
+ "tag": "CRT"
151
+ },
152
+ {
153
+ "name": "nome_emitente",
154
+ "description": "Razão social ou Nome do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
155
+ "type": "String[2-60]",
156
+ "required": true,
157
+ "tag": "xNome"
158
+ },
159
+ {
160
+ "name": "nome_fantasia_emitente",
161
+ "description": "Nome fantasia do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
162
+ "type": "String[1-60]",
163
+ "required": false,
164
+ "tag": "xFant"
165
+ },
166
+ {
167
+ "name": "logradouro_emitente",
168
+ "description": "Logradouro (rua, avenida, travessa etc.) do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
169
+ "type": "String[2-60]",
170
+ "required": true,
171
+ "tag": "xLgr"
172
+ },
173
+ {
174
+ "name": "numero_emitente",
175
+ "description": "Número do endereço do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
176
+ "type": "String[1-60]",
177
+ "required": true,
178
+ "tag": "nro"
179
+ },
180
+ {
181
+ "name": "complemento_emitente",
182
+ "description": "Complemento do endereço do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
183
+ "type": "String[1-60]",
184
+ "required": false,
185
+ "tag": "xCpl"
186
+ },
187
+ {
188
+ "name": "bairro_emitente",
189
+ "description": "Bairro do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
190
+ "type": "String[2-60]",
191
+ "required": true,
192
+ "tag": "xBairro"
193
+ },
194
+ {
195
+ "name": "codigo_municipio_emitente",
196
+ "description": "Código do município (utilizar a tabela do IBGE). Utiliza os dados do cadastro da empresa quando omitido.",
197
+ "type": "String[7]",
198
+ "required": true,
199
+ "tag": "cMun"
200
+ },
201
+ {
202
+ "name": "municipio_emitente",
203
+ "description": "Município do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
204
+ "type": "String[2-60]",
205
+ "required": true,
206
+ "tag": "xMun"
207
+ },
208
+ {
209
+ "name": "cep_emitente",
210
+ "description": "CEP do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
211
+ "type": "Integer[8]",
212
+ "required": true,
213
+ "tag": "CEP"
214
+ },
215
+ {
216
+ "name": "uf_emitente",
217
+ "description": "UF do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
218
+ "type": "String[2]",
219
+ "required": true,
220
+ "tag": "UF"
221
+ },
222
+ {
223
+ "name": "telefone_emitente",
224
+ "description": "Telefone do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
225
+ "type": "String[7-12]",
226
+ "required": false,
227
+ "tag": "fone"
228
+ },
229
+ {
230
+ "name": "email_emitente",
231
+ "description": "Endereço de E-mail do emitente. Utiliza os dados do cadastro da empresa quando omitido.",
232
+ "type": "String[1-60]",
233
+ "required": false,
234
+ "tag": "email"
235
+ },
236
+ {
237
+ "name": "nome_destinatario",
238
+ "description": "Nome ou razão social do destinatário/assinante.",
239
+ "type": "String[2-60]",
240
+ "required": true,
241
+ "tag": "xNome"
242
+ },
243
+ {
244
+ "name": "cnpj_destinatario",
245
+ "description": "CNPJ do destinatário/assinante. Obrigatório informar CNPJ <b>ou</b> CPF <b>ou</b> Outra indentificação do destinatário/assinante.",
246
+ "type": "String[14]",
247
+ "required": false,
248
+ "tag": "CNPJ"
249
+ },
250
+ {
251
+ "name": "cpf_destinatario",
252
+ "description": "CPF do destinatário/assinante. Obrigatório informar CNPJ <b>ou</b> CPF <b>ou</b> Outra indentificação do destinatário/assinante.",
253
+ "type": "String[11]",
254
+ "required": false,
255
+ "tag": "CPF"
256
+ },
257
+ {
258
+ "name": "outra_indificacao_destinatario",
259
+ "description": "Outra indentificação do destinatário/assinante que não seja o CPF. Obrigatório informar CNPJ <b>ou</b> CPF <b>ou</b> Outra indentificação do destinatário/assinante.",
260
+ "type": "String[2-20]",
261
+ "required": false,
262
+ "tag": "idOutros"
263
+ },
264
+ {
265
+ "name": "indicador_ie_destinatario",
266
+ "description": "Indicador da IE do Destinatário/assinante.",
267
+ "type": null,
268
+ "required": true,
269
+ "enum": "* +1+: Contribuinte ICMS (informar a IE do destinatário/assinante)\\n* +2+: Contribuinte isento de Inscrição no cadastro de Contribuintes do ICMS\\n* +9+: Não Contribuinte, que pode ou não possuir Inscrição Estadual no Cadastro de Contribuintes do ICMS",
270
+ "tag": "indIEDest"
271
+ },
272
+ {
273
+ "name": "inscricao_estadual_destinatario",
274
+ "description": "Inscrição Estadual do destinatário/assinante. Obrigatório informar caso exista.",
275
+ "type": "String[0-14]",
276
+ "required": false,
277
+ "tag": "IE"
278
+ },
279
+ {
280
+ "name": "inscricao_municipal_destinatario",
281
+ "description": "Inscrição Municipal do destinatário/assinante",
282
+ "type": "String[1-15]",
283
+ "required": false,
284
+ "tag": "IM"
285
+ },
286
+ {
287
+ "name": "logradouro_destinatario",
288
+ "description": "Logradouro (rua, avenida, travessa etc.) do destinatário/assinante.",
289
+ "type": "String[2-60]",
290
+ "required": true,
291
+ "tag": "xLgr"
292
+ },
293
+ {
294
+ "name": "numero_destinatario",
295
+ "description": "Número do endereço do destinatário/assinante",
296
+ "type": "String[1-60]",
297
+ "required": true,
298
+ "tag": "nro"
299
+ },
300
+ {
301
+ "name": "complemento_destinatario",
302
+ "description": "Complemento do endereço do destinatário/assinante",
303
+ "type": "String[1-60]",
304
+ "required": false,
305
+ "tag": "xCpl"
306
+ },
307
+ {
308
+ "name": "bairro_destinatario",
309
+ "description": "Bairro do destinatário/assinante.",
310
+ "type": "String[2-60]",
311
+ "required": true,
312
+ "tag": "xBairro"
313
+ },
314
+ {
315
+ "name": "codigo_municipio_destinatario",
316
+ "description": "Código do município (utilizar a tabela do IBGE) do destinatário/assinante.",
317
+ "type": "String[7]",
318
+ "required": false,
319
+ "tag": "cMun"
320
+ },
321
+ {
322
+ "name": "municipio_destinatario",
323
+ "description": "Município do destinatário/assinante.",
324
+ "type": "String[2-60]",
325
+ "required": true,
326
+ "tag": "xMun"
327
+ },
328
+ {
329
+ "name": "cep_destinatario",
330
+ "description": "CEP do destinatário/assinante.",
331
+ "type": "String[8]",
332
+ "required": true,
333
+ "tag": "CEP"
334
+ },
335
+ {
336
+ "name": "uf_destinatario",
337
+ "description": "UF do destinatário/assinante.",
338
+ "type": "String[2]",
339
+ "required": true,
340
+ "tag": "UF"
341
+ },
342
+ {
343
+ "name": "codigo_pais_destinatario",
344
+ "description": "Código do país do destinatário/assinante.",
345
+ "type": "String[1-4]",
346
+ "required": false,
347
+ "tag": "cPais"
348
+ },
349
+ {
350
+ "name": "pais_destinatario",
351
+ "description": "Nome do país do destinatário/assinante.",
352
+ "type": "String[2-60]",
353
+ "required": false,
354
+ "tag": "xPais"
355
+ },
356
+ {
357
+ "name": "telefone_destinatario",
358
+ "description": "Telefone do destinatário/assinante.",
359
+ "type": "String[7-12]",
360
+ "required": false,
361
+ "tag": "fone"
362
+ },
363
+ {
364
+ "name": "email_destinatario",
365
+ "description": "E-mail do destinatário/assinante.",
366
+ "type": "String[1-60]",
367
+ "required": false,
368
+ "tag": "email"
369
+ },
370
+ {
371
+ "name": "codigo_assinante",
372
+ "description": "Código único de Identificação do assinante.",
373
+ "type": "String[1-15]",
374
+ "required": true,
375
+ "tag": "iCodAssinante"
376
+ },
377
+ {
378
+ "name": "tipo_assinante",
379
+ "description": "Tipo de assinante.",
380
+ "type": null,
381
+ "required": true,
382
+ "enum": "* +1+: Comercial\\n* +2+: Industrial\\n* +3+: Residencial/Pessoa Física\\n* +4+: Produtor Rural\\n* +5+: Órgão da administração pública estadual direta e suas fundações e autarquias, quando mantidas pelo poder público estadual e regidas por normas de direito público, nos termos do Convênio ICMS 107/95\\n* +6+: Prestador de serviço de telecomunicação responsável pelo recolhimento do imposto incidente sobre a cessão dos meios de rede do prestador do serviço ao usuário final, nos termos do Convênio ICMS 17/13\\n* +7+: Missões Diplomáticas, Repartições Consulares e Organismos Internacionais, nos termos do Convênio ICMS 158/94\\n* +8+: Igrejas e Templos de qualquer natureza\\n* +99+: Outros não especificados anteriormente",
383
+ "tag": "tpAssinante"
384
+ },
385
+ {
386
+ "name": "tipo_servico",
387
+ "description": "Tipo de serviço utilizado.",
388
+ "type": null,
389
+ "required": true,
390
+ "enum": "* +1+: Telefonia\\n* +2+: Comunicação de dados\\n* +3+: TV por Assinatura\\n* +4+: Provimento de acesso à Internet\\n* +5+: Multimídia\\n* +6+: Outros\\n* +7+: Varios",
391
+ "tag": "tpServUtil"
392
+ },
393
+ {
394
+ "name": "numero_contato_assinante",
395
+ "description": "Número do Contrato do assinante.",
396
+ "type": "String[1-20]",
397
+ "required": false,
398
+ "tag": "nContrato"
399
+ },
400
+ {
401
+ "name": "data_inicio_contrato",
402
+ "description": "Data de início do contrato.",
403
+ "type": null,
404
+ "required": false,
405
+ "tag": "dContratoIni"
406
+ },
407
+ {
408
+ "name": "data_fim_contrato",
409
+ "description": "Data de término do contrato.",
410
+ "type": null,
411
+ "required": false,
412
+ "tag": "dContratoFim"
413
+ },
414
+ {
415
+ "name": "terminal_principal",
416
+ "description": "Número do Terminal Principal do serviço contratado.",
417
+ "type": "String[7-12]",
418
+ "required": true,
419
+ "tag": "NroTermPrinc"
420
+ },
421
+ {
422
+ "name": "uf_terminal_principal",
423
+ "description": "Código da UF de habilitação do terminal principal.",
424
+ "type": "Integer[2]",
425
+ "required": true,
426
+ "tag": "cUFPrinc"
427
+ },
428
+ {
429
+ "name": "terminal_adicional",
430
+ "description": "Número do Terminal adicional do serviço contratado.",
431
+ "type": "String[7-12]",
432
+ "required": true,
433
+ "tag": "NroTermAdic"
434
+ },
435
+ {
436
+ "name": "uf_terminal_adicional",
437
+ "description": "Código da UF de habilitação do terminal adicional.",
438
+ "type": "Integer[2]",
439
+ "required": true,
440
+ "tag": "cUFAdic"
441
+ },
442
+ {
443
+ "name": "chave_nfcom_original",
444
+ "description": "Chave de acesso da NFCom original.",
445
+ "type": "String[44]",
446
+ "required": false,
447
+ "tag": "chNFCom"
448
+ },
449
+ {
450
+ "name": "cnpj_emitente_substituicao",
451
+ "description": "CNPJ do Emitente.",
452
+ "type": "String[14]",
453
+ "required": false,
454
+ "tag": "CNPJ"
455
+ },
456
+ {
457
+ "name": "modelo_substituicao",
458
+ "description": "Modelo do documento (21 ou 22).",
459
+ "type": "Integer[2]",
460
+ "required": false,
461
+ "tag": "mod"
462
+ },
463
+ {
464
+ "name": "serie_substituicao",
465
+ "description": "Serie do documento fiscal.",
466
+ "type": "String[3]",
467
+ "required": false,
468
+ "tag": "serie"
469
+ },
470
+ {
471
+ "name": "numero_substituicao",
472
+ "description": "Número do documento fiscal.",
473
+ "type": "String[1-9]",
474
+ "required": false,
475
+ "tag": "nNF"
476
+ },
477
+ {
478
+ "name": "data_emissao_substituicao",
479
+ "description": "Ano e mês da emissão da NF (AAAAMM).",
480
+ "type": "String[6]",
481
+ "required": false,
482
+ "tag": "CompetEmis"
483
+ },
484
+ {
485
+ "name": "hash_registro_substituicao",
486
+ "description": "Hash do registro no arquivo do convênio 115.",
487
+ "type": "String[32]",
488
+ "required": false,
489
+ "tag": "hash115"
490
+ },
491
+ {
492
+ "name": "motivo_substituicao",
493
+ "description": "Motivo da substituição.",
494
+ "type": null,
495
+ "required": false,
496
+ "enum": "* +1+: Erro de Preço\\n* +2+: Erro Cadastral\\n* +3+: Decisão Judicial\\n* +4+: Erro de Tributação\\n* +5+: Descontinuidade do Serviço",
497
+ "tag": "motSub"
498
+ },
499
+ {
500
+ "name": "chave_nfcom_local",
501
+ "description": "Chave de acesso da NFCom emitida pela Operadora Local.",
502
+ "type": "String[44]",
503
+ "required": false,
504
+ "tag": "chNFComLocal"
505
+ },
506
+ {
507
+ "name": "itens",
508
+ "description": "Itens da nota fiscal.",
509
+ "type": "Coleção[1-990]",
510
+ "required": false,
511
+ "collection_type": "ItemNotaFiscalXML",
512
+ "collection": {
513
+ "object_type": "ItemNotaFiscalXML",
514
+ "object_description": "Detalhamento de Produtos e Serviços. Tag XML det",
515
+ "object_attributes": [
516
+ {
517
+ "name": "numero_item",
518
+ "description": "Número do item da NFCom, começando por +1+.",
519
+ "type": "String[3]",
520
+ "required": true,
521
+ "tag": "nItem"
522
+ },
523
+ {
524
+ "name": "chave_nfcom_anterior",
525
+ "description": "Chave de Acesso da NFCom anterior.",
526
+ "type": "String[44]",
527
+ "required": true,
528
+ "tag": "chNFComAnt"
529
+ },
530
+ {
531
+ "name": "numero_item_anterior",
532
+ "description": "Número do item da NFCom anterior.",
533
+ "type": "String[3]",
534
+ "required": true,
535
+ "tag": "nItemAnt"
536
+ },
537
+ {
538
+ "name": "codigo_produto",
539
+ "description": "Código do produto ou serviço.",
540
+ "type": "String[1-60]",
541
+ "required": true,
542
+ "tag": "cProd"
543
+ },
544
+ {
545
+ "name": "descricao",
546
+ "description": "Descrição do produto.",
547
+ "type": "String[1-120]",
548
+ "required": true,
549
+ "tag": "xProd"
550
+ },
551
+ {
552
+ "name": "classificacao",
553
+ "description": "Código de classificação.",
554
+ "type": "String[7]",
555
+ "required": true,
556
+ "tag": "cClass"
557
+ },
558
+ {
559
+ "name": "cfop",
560
+ "description": "CFOP.",
561
+ "type": "Integer[4]",
562
+ "required": false,
563
+ "tag": "CFOP"
564
+ },
565
+ {
566
+ "name": "cnpj_ld",
567
+ "description": "CNPJ da operadora LD.",
568
+ "type": "String[14]",
569
+ "required": false,
570
+ "tag": "CNPJLD"
571
+ },
572
+ {
573
+ "name": "unidade_medida",
574
+ "description": "Unidade Básica de Medida.",
575
+ "type": null,
576
+ "required": true,
577
+ "enum": "* +1+: Minuto\\n* +2+: MB\\n* +3+: GB\\n* +4+: UN",
578
+ "tag": "uMed"
579
+ },
580
+ {
581
+ "name": "quantidade_faturada",
582
+ "description": "Quantidade Faturada.",
583
+ "type": "Decimal[11.0-4]",
584
+ "required": true,
585
+ "tag": "qFaturada"
586
+ },
587
+ {
588
+ "name": "valor_item",
589
+ "description": "Valor unitário do item.",
590
+ "type": "Decimal[13.2-8]",
591
+ "required": true,
592
+ "tag": "vItem"
593
+ },
594
+ {
595
+ "name": "valor_desconto",
596
+ "description": "Valor do Desconto.",
597
+ "type": "Decimal[13.2]",
598
+ "required": false,
599
+ "tag": "vDesc"
600
+ },
601
+ {
602
+ "name": "valor_outras_despesas",
603
+ "description": "Outras despesas acessórias.",
604
+ "type": "Decimal[13.2]",
605
+ "required": false,
606
+ "tag": "vOutro"
607
+ },
608
+ {
609
+ "name": "valor_total_item",
610
+ "description": "Valor total do item.",
611
+ "type": "Decimal[13.2-8]",
612
+ "required": true,
613
+ "tag": "vProd"
614
+ },
615
+ {
616
+ "name": "data_expiracao_credito",
617
+ "description": "Data de expiração de crédito.",
618
+ "type": null,
619
+ "required": false,
620
+ "tag": "dExpiracao"
621
+ },
622
+ {
623
+ "name": "indicador_devolucao",
624
+ "description": "Indicador de devolução do valor do item.",
625
+ "type": null,
626
+ "required": false,
627
+ "enum": "* +1+: Devolução do valor do item",
628
+ "tag": "indDevolucao"
629
+ },
630
+ {
631
+ "name": null,
632
+ "description": ":icms_situacao_tributaria Situação tributária do ICMS.",
633
+ "type": null,
634
+ "required": true,
635
+ "enum": "* +00+: Tributação normal ICMS\\n* +20+: Tributação com BC reduzida do ICMS\\n* +40+: Isenta\\n* +41+: Não tributada\\n* +51+: Diferimento (a exigência do preenchimento das informações do ICMS diferido fica a critério de cada UF)\\n* +90+: Outros (Regime Normal)\\n* +90_simples_nacional+: Outros (Regime Simples Nacional)",
636
+ "tag": "CST"
637
+ },
638
+ {
639
+ "name": null,
640
+ "description": ":icms_base_calculo Valor da base de cálculo do ICMS.",
641
+ "type": "Decimal[13.2]",
642
+ "required": false,
643
+ "tag": "vBC"
644
+ },
645
+ {
646
+ "name": null,
647
+ "description": ":icms_aliquota Alíquota do ICMS.",
648
+ "type": "Decimal[3.2]",
649
+ "required": false,
650
+ "tag": "pICMS"
651
+ },
652
+ {
653
+ "name": null,
654
+ "description": ":icms_valor Valor do ICMS.",
655
+ "type": "Decimal[13.2]",
656
+ "required": false,
657
+ "tag": "vICMS"
658
+ },
659
+ {
660
+ "name": null,
661
+ "description": ":icms_fcp_percentual Percentual de ICMS relativo ao Fundo de Combate à Pobreza (FCP).",
662
+ "type": "Decimal[3.2]",
663
+ "required": false,
664
+ "tag": "pFCP"
665
+ },
666
+ {
667
+ "name": null,
668
+ "description": ":icms_fcp_valor Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP).",
669
+ "type": "Decimal[13.2]",
670
+ "required": false,
671
+ "tag": "vFCP"
672
+ },
673
+ {
674
+ "name": null,
675
+ "description": ":icms_reducao_base_calculo Percentual de redução da base de cálculo.",
676
+ "type": "Decimal[3.2]",
677
+ "required": false,
678
+ "tag": "pRedBC"
679
+ },
680
+ {
681
+ "name": null,
682
+ "description": ":icms_valor_desonerado Valor do ICMS de desoneração.",
683
+ "type": "Decimal[13.2]",
684
+ "required": false,
685
+ "tag": "vICMSDeson"
686
+ },
687
+ {
688
+ "name": null,
689
+ "description": ":icms_codigo_beneficio_fiscal Código de Benefício Fiscal na UF aplicado ao item.",
690
+ "type": "String[10]",
691
+ "required": false,
692
+ "tag": "cBenef"
693
+ },
694
+ {
695
+ "name": null,
696
+ "description": ":icms_indicador_simples_nacional Indicador de contribuinte Simples Nacional.",
697
+ "type": null,
698
+ "required": false,
699
+ "enum": "* +1+: Sim",
700
+ "tag": "indSN"
701
+ },
702
+ {
703
+ "name": "icms_uf_dest",
704
+ "description": "Informações do ICMS de partilha com a UF destinatária.",
705
+ "type": "Coleção[0-n]",
706
+ "required": false,
707
+ "collection_type": "InformacoesIcmsUfDestinataria",
708
+ "collection": {
709
+ "object_type": "InformacoesIcmsUfDestinataria",
710
+ "object_description": "Informações do ICMS de partilha com a UF destinatária. Tag XML ICMSUFDest",
711
+ "object_attributes": [
712
+ {
713
+ "name": "uf_destinatario",
714
+ "description": "(apenas para venda interestadual para consumidor final) Código UF destinatária.",
715
+ "type": "Integer[2]",
716
+ "required": false,
717
+ "tag": "cUFDest"
718
+ },
719
+ {
720
+ "name": "icms_base_calculo_uf_destino",
721
+ "description": "(apenas para venda interestadual para consumidor final) Valor da BC do ICMS na UF de destino.",
722
+ "type": "Decimal[13.2]",
723
+ "required": false,
724
+ "tag": "vBCUFDest"
725
+ },
726
+ {
727
+ "name": "fcp_percentual_uf_destino",
728
+ "description": "(apenas para venda interestadual para consumidor final) Percentual do ICMS relativo ao Fundo de Combate à Pobreza (FCP) na UF de destino.",
729
+ "type": "Decimal[3.2]",
730
+ "required": false,
731
+ "tag": "pFCPUFDest"
732
+ },
733
+ {
734
+ "name": "icms_aliquota_interna_uf_destino",
735
+ "description": "(apenas para venda interestadual para consumidor final) Alíquota interna da UF de destino.",
736
+ "type": "Decimal[3.2]",
737
+ "required": false,
738
+ "tag": "pICMSUFDest"
739
+ },
740
+ {
741
+ "name": "fcp_valor_uf_destino",
742
+ "description": "(apenas para venda interestadual para consumidor final) Valor do ICMS relativo ao Fundo de Combate à Pobreza (FCP) da UF de destino.",
743
+ "type": "Decimal[13.2]",
744
+ "required": false,
745
+ "tag": "vFCPUFDest"
746
+ },
747
+ {
748
+ "name": "icms_valor_uf_destino",
749
+ "description": "(apenas para venda interestadual para consumidor final) Valor do ICMS de partilha para a UF de destino.",
750
+ "type": "Decimal[13.2]",
751
+ "required": false,
752
+ "tag": "vICMSUFDest"
753
+ },
754
+ {
755
+ "name": "icms_valor_uf_emissao",
756
+ "description": "(apenas para venda interestadual para consumidor final) Valor do ICMS de partilha para a UF de emissão.",
757
+ "type": "Decimal[13.2]",
758
+ "required": false,
759
+ "tag": "vICMSUFEmi"
760
+ },
761
+ {
762
+ "name": "icms_beneficio_uf_destino",
763
+ "description": "(apenas para venda interestadual para consumidor final) Código de Benefício Fiscal na UF destino aplicado ao item.",
764
+ "type": "String[10]",
765
+ "required": false,
766
+ "tag": "cBenefUFDest"
767
+ }
768
+ ]
769
+ }
770
+ },
771
+ {
772
+ "name": null,
773
+ "description": ":pis_situacao_tributaria Classificação Tributária do PIS.",
774
+ "type": null,
775
+ "required": false,
776
+ "enum": "* +01+: Tributável com alíquota básica\\n* +02+: Tributável com alíquota diferenciada\\n* +06+: Tributável com alíquota zero\\n* +07+: Operação isenta de contribuição\\n* +08+: Operação sem incidência da contribuição\\n* +09+: Operação com suspensão da contribuição\\n* +49+: Outras operações de saída",
777
+ "tag": "CST"
778
+ },
779
+ {
780
+ "name": null,
781
+ "description": ":pis_base_calculo Valor da base de cálculo do PIS.",
782
+ "type": "Decimal[13.2]",
783
+ "required": false,
784
+ "tag": "vBC"
785
+ },
786
+ {
787
+ "name": null,
788
+ "description": ":pis_aliquota_porcentual Alíquota do PIS em porcentual.",
789
+ "type": "Decimal[3.2]",
790
+ "required": false,
791
+ "tag": "pPIS"
792
+ },
793
+ {
794
+ "name": null,
795
+ "description": ":pis_valor Valor do PIS.",
796
+ "type": "Decimal[13.2]",
797
+ "required": false,
798
+ "tag": "vPIS"
799
+ },
800
+ {
801
+ "name": null,
802
+ "description": ":cofins_situacao_tributaria Classificação Tributária do COFINS.",
803
+ "type": null,
804
+ "required": false,
805
+ "enum": "* +01+: Tributável com alíquota básica\\n* +02+: Tributável com alíquota diferenciada\\n* +06+: Tributável com alíquota zero\\n* +07+: Operação isenta de contribuição\\n* +08+: Operação sem incidência da contribuição\\n* +09+: Operação com suspensão da contribuição\\n* +49+: Outras operações de saída",
806
+ "tag": "CST"
807
+ },
808
+ {
809
+ "name": null,
810
+ "description": ":cofins_base_calculo Valor da base de cálculo do COFINS.",
811
+ "type": "Decimal[13.2]",
812
+ "required": false,
813
+ "tag": "vBC"
814
+ },
815
+ {
816
+ "name": null,
817
+ "description": ":cofins_aliquota_porcentual Alíquota do COFINS em porcentual.",
818
+ "type": "Decimal[3.2]",
819
+ "required": false,
820
+ "tag": "pCOFINS"
821
+ },
822
+ {
823
+ "name": null,
824
+ "description": ":cofins_valor Valor do COFINS.",
825
+ "type": "Decimal[13.2]",
826
+ "required": false,
827
+ "tag": "vCOFINS"
828
+ },
829
+ {
830
+ "name": null,
831
+ "description": ":fust_base_calculo Valor da base de cálculo do FUST.",
832
+ "type": "Decimal[13.2]",
833
+ "required": false,
834
+ "tag": "vBC"
835
+ },
836
+ {
837
+ "name": null,
838
+ "description": ":fust_aliquota_porcentual Alíquota do FUST em porcentual.",
839
+ "type": "Decimal[3.2]",
840
+ "required": false,
841
+ "tag": "pFUST"
842
+ },
843
+ {
844
+ "name": null,
845
+ "description": ":fust_valor Valor do FUST.",
846
+ "type": "Decimal[13.2]",
847
+ "required": false,
848
+ "tag": "vFUST"
849
+ },
850
+ {
851
+ "name": null,
852
+ "description": ":funttel_base_calculo Valor da base de cálculo do FUNTTEL.",
853
+ "type": "Decimal[13.2]",
854
+ "required": false,
855
+ "tag": "vBC"
856
+ },
857
+ {
858
+ "name": null,
859
+ "description": ":funttel_aliquota_porcentual Alíquota do FUNTTEL em porcentual.",
860
+ "type": "Decimal[3.2]",
861
+ "required": false,
862
+ "tag": "pFUNTTEL"
863
+ },
864
+ {
865
+ "name": null,
866
+ "description": ":funttel_valor Valor do FUNTTEL.",
867
+ "type": "Decimal[13.2]",
868
+ "required": false,
869
+ "tag": "vFUNTTEL"
870
+ },
871
+ {
872
+ "name": "pis_valor_retido",
873
+ "description": "Valor Retido de PIS.",
874
+ "type": "Decimal[13.2-8]",
875
+ "required": false,
876
+ "tag": "vRetPIS"
877
+ },
878
+ {
879
+ "name": "cofins_valor_retido",
880
+ "description": "Valor Retido de COFINS.",
881
+ "type": "Decimal[13.2-8]",
882
+ "required": false,
883
+ "tag": "vRetCofins"
884
+ },
885
+ {
886
+ "name": "csll_valor_retido",
887
+ "description": "Valor Retido de CSLL.",
888
+ "type": "Decimal[13.2-8]",
889
+ "required": false,
890
+ "tag": "vRetCSLL"
891
+ },
892
+ {
893
+ "name": "irrf_base_calculo",
894
+ "description": "Base de Cálculo do IRRF.",
895
+ "type": "Decimal[13.2-8]",
896
+ "required": false,
897
+ "tag": "vBCIRRF"
898
+ },
899
+ {
900
+ "name": "irrf_valor_retido",
901
+ "description": "Valor Retido de IRRF.",
902
+ "type": "Decimal[13.2-8]",
903
+ "required": false,
904
+ "tag": "vIRRF"
905
+ },
906
+ {
907
+ "name": "ibs_cbs_situacao_tributaria",
908
+ "description": "Código da Situação Tributária do IBS/CBS",
909
+ "type": "String[3]",
910
+ "required": true,
911
+ "reforma_tributaria": true,
912
+ "tag": "CST"
913
+ },
914
+ {
915
+ "name": "ibs_cbs_classificacao_tributaria",
916
+ "description": "Código de Classificação Tributária do IBS/CBS",
917
+ "type": "String[6]",
918
+ "required": true,
919
+ "reforma_tributaria": true,
920
+ "tag": "cClassTrib"
921
+ },
922
+ {
923
+ "name": "ibs_cbs_base_calculo",
924
+ "description": "Valor da Base de cálculo comum a IBS/CBS",
925
+ "type": "Decimal[13.2]",
926
+ "required": false,
927
+ "reforma_tributaria": true,
928
+ "tag": "vBC"
929
+ },
930
+ {
931
+ "name": "ibs_uf_aliquota",
932
+ "description": "Alíquota do IBS Estadual",
933
+ "type": "Decimal[3.2-4]",
934
+ "required": false,
935
+ "reforma_tributaria": true,
936
+ "tag": "pIBSUF"
937
+ },
938
+ {
939
+ "name": "ibs_uf_percentual_diferimento",
940
+ "description": "Percentual do diferimento",
941
+ "type": "Decimal[3.2-4]",
942
+ "required": false,
943
+ "reforma_tributaria": true,
944
+ "tag": "pDif"
945
+ },
946
+ {
947
+ "name": "ibs_uf_valor_diferido",
948
+ "description": "Valor do Diferimento",
949
+ "type": "Decimal[13.2]",
950
+ "required": false,
951
+ "reforma_tributaria": true,
952
+ "tag": "vDif"
953
+ },
954
+ {
955
+ "name": "ibs_uf_valor_tributo_devolvido",
956
+ "description": "Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e gás natural e em outras hipóteses definidas no regulamento",
957
+ "type": "Decimal[13.2]",
958
+ "required": false,
959
+ "reforma_tributaria": true,
960
+ "tag": "vDevTrib"
961
+ },
962
+ {
963
+ "name": "ibs_uf_percentual_reducao_aliquota",
964
+ "description": "Percentual da redução de Alíquota do cClassTrib",
965
+ "type": "Decimal[3.2-4]",
966
+ "required": false,
967
+ "reforma_tributaria": true,
968
+ "tag": "pRedAliq"
969
+ },
970
+ {
971
+ "name": "ibs_uf_aliquota_efetiva",
972
+ "description": "Alíquota Efetiva do IBS de competência das UF que será aplicada a base de cálculo, incluindo o gCompraGov/pRedutor, se houver.",
973
+ "type": "Decimal[3.2-4]",
974
+ "required": false,
975
+ "reforma_tributaria": true,
976
+ "tag": "pAliqEfet"
977
+ },
978
+ {
979
+ "name": "ibs_uf_valor",
980
+ "description": "Valor do IBS de competência da UF",
981
+ "type": "Decimal[13.2]",
982
+ "required": false,
983
+ "reforma_tributaria": true,
984
+ "tag": "vIBSUF"
985
+ },
986
+ {
987
+ "name": "ibs_mun_aliquota",
988
+ "description": "Alíquota do IBS Municipal",
989
+ "type": "Decimal[3.2-4]",
990
+ "required": false,
991
+ "reforma_tributaria": true,
992
+ "tag": "pIBSMun"
993
+ },
994
+ {
995
+ "name": "ibs_mun_percentual_diferimento",
996
+ "description": "Percentual do diferimento",
997
+ "type": "Decimal[3.2-4]",
998
+ "required": false,
999
+ "reforma_tributaria": true,
1000
+ "tag": "pDif"
1001
+ },
1002
+ {
1003
+ "name": "ibs_mun_valor_diferido",
1004
+ "description": "Valor do Diferimento",
1005
+ "type": "Decimal[13.2]",
1006
+ "required": false,
1007
+ "reforma_tributaria": true,
1008
+ "tag": "vDif"
1009
+ },
1010
+ {
1011
+ "name": "ibs_mun_valor_tributo_devolvido",
1012
+ "description": "Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e gás natural e em outras hipóteses definidas no regulamento",
1013
+ "type": "Decimal[13.2]",
1014
+ "required": false,
1015
+ "reforma_tributaria": true,
1016
+ "tag": "vDevTrib"
1017
+ },
1018
+ {
1019
+ "name": "ibs_mun_percentual_reducao_aliquota",
1020
+ "description": "Percentual da redução de Alíquota do cClassTrib",
1021
+ "type": "Decimal[3.2-4]",
1022
+ "required": false,
1023
+ "reforma_tributaria": true,
1024
+ "tag": "pRedAliq"
1025
+ },
1026
+ {
1027
+ "name": "ibs_mun_aliquota_efetiva",
1028
+ "description": "Alíquota Efetiva do IBS de competência das UF que será aplicada a Base de Cálculo, incluindo o gCompraGov/pRedutor, se houver.",
1029
+ "type": "Decimal[3.2-4]",
1030
+ "required": false,
1031
+ "reforma_tributaria": true,
1032
+ "tag": "pAliqEfet"
1033
+ },
1034
+ {
1035
+ "name": "ibs_mun_valor",
1036
+ "description": "Valor do IBS de competência do Município",
1037
+ "type": "Decimal[2]",
1038
+ "required": false,
1039
+ "reforma_tributaria": true,
1040
+ "tag": "vIBSMun"
1041
+ },
1042
+ {
1043
+ "name": "ibs_valor",
1044
+ "description": "Valor do IBS (soma de vIBSUF e vIBSMun)",
1045
+ "type": "Decimal[2]",
1046
+ "required": false,
1047
+ "reforma_tributaria": true,
1048
+ "tag": "vIBS"
1049
+ },
1050
+ {
1051
+ "name": "cbs_aliquota",
1052
+ "description": "Alíquota da CBS",
1053
+ "type": "Decimal[4]",
1054
+ "required": false,
1055
+ "reforma_tributaria": true,
1056
+ "tag": "pCBS"
1057
+ },
1058
+ {
1059
+ "name": "cbs_percentual_diferimento",
1060
+ "description": "Percentual do diferimento",
1061
+ "type": "Decimal[3.2-4]",
1062
+ "required": false,
1063
+ "reforma_tributaria": true,
1064
+ "tag": "pDif"
1065
+ },
1066
+ {
1067
+ "name": "cbs_valor_diferido",
1068
+ "description": "Valor do Diferimento",
1069
+ "type": "Decimal[13.2]",
1070
+ "required": false,
1071
+ "reforma_tributaria": true,
1072
+ "tag": "vDif"
1073
+ },
1074
+ {
1075
+ "name": "cbs_valor_tributo_devolvido",
1076
+ "description": "Valor do tributo devolvido. No fornecimento de energia elétrica, água, esgoto e gás natural e em outras hipóteses definidas no regulamento",
1077
+ "type": "Decimal[13.2]",
1078
+ "required": false,
1079
+ "reforma_tributaria": true,
1080
+ "tag": "vDevTrib"
1081
+ },
1082
+ {
1083
+ "name": "cbs_percentual_reducao_aliquota",
1084
+ "description": "Percentual da redução de Alíquota do cClassTrib",
1085
+ "type": "Decimal[3.2-4]",
1086
+ "required": false,
1087
+ "reforma_tributaria": true,
1088
+ "tag": "pRedAliq"
1089
+ },
1090
+ {
1091
+ "name": "cbs_aliquota_efetiva",
1092
+ "description": "Alíquota efetiva da CBS que será aplicada a base de cálculo, incluindo o gCompraGov/pRedutor, se houver",
1093
+ "type": "Decimal[3.2-4]",
1094
+ "required": false,
1095
+ "reforma_tributaria": true,
1096
+ "tag": "pAliqEfet"
1097
+ },
1098
+ {
1099
+ "name": "cbs_valor",
1100
+ "description": "Valor da CBS",
1101
+ "type": "Decimal[13.2]",
1102
+ "required": false,
1103
+ "reforma_tributaria": true,
1104
+ "tag": "vCBS"
1105
+ },
1106
+ {
1107
+ "name": "ibs_cbs_situacao_tributaria_regular",
1108
+ "description": "Código da Situação Tributária. Informado como seria o CST caso não cumprida a condição resolutória/suspensiva",
1109
+ "type": "String[3]",
1110
+ "required": false,
1111
+ "reforma_tributaria": true,
1112
+ "tag": "CSTReg"
1113
+ },
1114
+ {
1115
+ "name": "ibs_cbs_classificacao_tributaria_regular",
1116
+ "description": "Código de Classificação Tributária. Informado como seria o cClassTrib caso não cumprida a condição resolutória/suspensiva",
1117
+ "type": "String[6]",
1118
+ "required": false,
1119
+ "reforma_tributaria": true,
1120
+ "tag": "cClassTribReg"
1121
+ },
1122
+ {
1123
+ "name": "ibs_aliquota_efetiva_regular_uf",
1124
+ "description": "Alíquota efetiva da UF. Informado a Alíquota caso não cumprida a condição resolutória/suspensiva",
1125
+ "type": "Decimal[3.2-4]",
1126
+ "required": false,
1127
+ "reforma_tributaria": true,
1128
+ "tag": "pAliqEfetRegIBSUF"
1129
+ },
1130
+ {
1131
+ "name": "ibs_valor_tributo_regular_uf",
1132
+ "description": "Informado como seria o valor do Tributo da UF caso não cumprida a condição resolutória/suspensiva",
1133
+ "type": "Decimal[13.2]",
1134
+ "required": false,
1135
+ "reforma_tributaria": true,
1136
+ "tag": "vTribRegIBSUF"
1137
+ },
1138
+ {
1139
+ "name": "ibs_aliquota_efetiva_regular_municipio",
1140
+ "description": "Alíquota efetiva do Município. Informado a Alíquota caso não cumprida a condição resolutória/suspensiva",
1141
+ "type": "Decimal[3.2-4]",
1142
+ "required": false,
1143
+ "reforma_tributaria": true,
1144
+ "tag": "pAliqEfetRegIBSMun"
1145
+ },
1146
+ {
1147
+ "name": "ibs_valor_tributo_regular_municipio",
1148
+ "description": "Informado como seria o valor do Tributo do Município caso não cumprida a condição resolutória/suspensiva",
1149
+ "type": "Decimal[13.2]",
1150
+ "required": false,
1151
+ "reforma_tributaria": true,
1152
+ "tag": "vTribRegIBSMun"
1153
+ },
1154
+ {
1155
+ "name": "cbs_aliquota_efetiva_regular",
1156
+ "description": "Alíquota efetiva da CBS. Informado a Alíquota caso não cumprida a condição resolutória/suspensiva",
1157
+ "type": "Decimal[3.2-4]",
1158
+ "required": false,
1159
+ "reforma_tributaria": true,
1160
+ "tag": "pAliqEfetRegCBS"
1161
+ },
1162
+ {
1163
+ "name": "cbs_valor_tributo_regular",
1164
+ "description": "Informado como seria o valor do Tributo CBS caso não cumprida a condição resolutória/suspensiva",
1165
+ "type": "Decimal[13.2]",
1166
+ "required": false,
1167
+ "reforma_tributaria": true,
1168
+ "tag": "vTribRegCBS"
1169
+ },
1170
+ {
1171
+ "name": "ibs_aliquota_competencia_uf",
1172
+ "description": "Alíquota IBS da UF utilizada",
1173
+ "type": "Decimal[3.2-4]",
1174
+ "required": false,
1175
+ "reforma_tributaria": true,
1176
+ "tag": "pAliqIBSUF"
1177
+ },
1178
+ {
1179
+ "name": "ibs_valor_tributo_calculado_uf",
1180
+ "description": "Valor do Tributo do IBS da UF. Valor que seria devido a UF, sem aplicação do Art.473. da LC 214/20025",
1181
+ "type": "Decimal[13.2]",
1182
+ "required": false,
1183
+ "reforma_tributaria": true,
1184
+ "tag": "vTribIBSUF"
1185
+ },
1186
+ {
1187
+ "name": "ibs_aliquota_competencia_municipio",
1188
+ "description": "Alíquota IBS do Município utilizada",
1189
+ "type": "Decimal[3.2-4]",
1190
+ "required": false,
1191
+ "reforma_tributaria": true,
1192
+ "tag": "pAliqIBSMun"
1193
+ },
1194
+ {
1195
+ "name": "ibs_valor_tributo_calculado_municipio",
1196
+ "description": "Valor do Tributo do Município da UF. Valor que seria devido ao Município, sem aplicação do Art.473. da LC 214/20025",
1197
+ "type": "Decimal[13.2]",
1198
+ "required": false,
1199
+ "reforma_tributaria": true,
1200
+ "tag": "vTribIBSMun"
1201
+ },
1202
+ {
1203
+ "name": "cbs_aliquota_compra_governamental",
1204
+ "description": "Alíquota IBS do CBS utilizada",
1205
+ "type": "Decimal[3.2-4]",
1206
+ "required": false,
1207
+ "reforma_tributaria": true,
1208
+ "tag": "pAliqCBS"
1209
+ },
1210
+ {
1211
+ "name": "cbs_valor_tributo_calculado",
1212
+ "description": "Valor do Tributo da CBS. Valor que seria devido a CBS, sem aplicação do Art.473. da LC 214/20025",
1213
+ "type": "Decimal[13.2]",
1214
+ "required": false,
1215
+ "reforma_tributaria": true,
1216
+ "tag": "vTribCBS"
1217
+ },
1218
+ {
1219
+ "name": "ibs_valor_estornado",
1220
+ "description": "Valor do IBS a ser estornado",
1221
+ "type": "Decimal[13.2]",
1222
+ "required": false,
1223
+ "reforma_tributaria": true,
1224
+ "tag": "vIBSEstCred"
1225
+ },
1226
+ {
1227
+ "name": "cbs_valor_estornado",
1228
+ "description": "Valor do CBS a ser estornado",
1229
+ "type": "Decimal[13.2]",
1230
+ "required": false,
1231
+ "reforma_tributaria": true,
1232
+ "tag": "vCBSEstCred"
1233
+ },
1234
+ {
1235
+ "name": "valor_item_processo",
1236
+ "description": "Valor unitário do item.",
1237
+ "type": "Decimal[13.2-8]",
1238
+ "required": false,
1239
+ "tag": "vItem"
1240
+ },
1241
+ {
1242
+ "name": "quantidade_faturada_processo",
1243
+ "description": "Quantidade Faturada.",
1244
+ "type": "Decimal[11.0-4]",
1245
+ "required": false,
1246
+ "tag": "qFaturada"
1247
+ },
1248
+ {
1249
+ "name": "valor_total_processo",
1250
+ "description": "Valor total do item.",
1251
+ "type": "Decimal[13.2-8]",
1252
+ "required": false,
1253
+ "tag": "vProd"
1254
+ },
1255
+ {
1256
+ "name": "valor_desconto_processo",
1257
+ "description": "Valor do Desconto.",
1258
+ "type": "Decimal[13.2]",
1259
+ "required": false,
1260
+ "tag": "vDesc"
1261
+ },
1262
+ {
1263
+ "name": "outras_despesas_processo",
1264
+ "description": "Outras despesas acessórias.",
1265
+ "type": "Decimal[13.2]",
1266
+ "required": false,
1267
+ "tag": "vOutro"
1268
+ },
1269
+ {
1270
+ "name": "indicador_devolucao_processo",
1271
+ "description": "Indicador de devolução do valor do item.",
1272
+ "type": null,
1273
+ "required": false,
1274
+ "enum": "* +1+: Devolução do valor do item",
1275
+ "tag": "indDevolucao"
1276
+ },
1277
+ {
1278
+ "name": "base_calculo_processo",
1279
+ "description": "Valor da BC do ICMS.",
1280
+ "type": "Decimal[13.2]",
1281
+ "required": false,
1282
+ "tag": "vBC"
1283
+ },
1284
+ {
1285
+ "name": "icms_aliquota_processo",
1286
+ "description": "Alíquota do ICMS.",
1287
+ "type": "Decimal[3.2]",
1288
+ "required": false,
1289
+ "tag": "pICMS"
1290
+ },
1291
+ {
1292
+ "name": "icms_valor_processo",
1293
+ "description": "Valor do ICMS.",
1294
+ "type": "Decimal[13.2]",
1295
+ "required": false,
1296
+ "tag": "vICMS"
1297
+ },
1298
+ {
1299
+ "name": "pis_valor_processo",
1300
+ "description": "Valor do PIS.",
1301
+ "type": "Decimal[13.2]",
1302
+ "required": false,
1303
+ "tag": "vPIS"
1304
+ },
1305
+ {
1306
+ "name": "cofins_valor_processo",
1307
+ "description": "Valor do COFINS.",
1308
+ "type": "Decimal[13.2]",
1309
+ "required": false,
1310
+ "tag": "vCOFINS"
1311
+ },
1312
+ {
1313
+ "name": "fcp_valor_processo",
1314
+ "description": "Valor do Fundo de Combate à pobreza (FCP).",
1315
+ "type": "Decimal[13.2]",
1316
+ "required": false,
1317
+ "tag": "vFCP"
1318
+ },
1319
+ {
1320
+ "name": "identificadores_processos",
1321
+ "description": "Grupo identificador do Processo.",
1322
+ "type": "Coleção[1-10]",
1323
+ "required": false,
1324
+ "collection_type": "IdentificadorProcesso",
1325
+ "collection": {
1326
+ "object_type": "IdentificadorProcesso",
1327
+ "object_description": "Grupo identificador do Processo. Tag XML gProc",
1328
+ "object_attributes": [
1329
+ {
1330
+ "name": "tipo_processo",
1331
+ "description": "Tipo de Processo.",
1332
+ "type": null,
1333
+ "required": false,
1334
+ "enum": "* +0+: SEFAZ\\n* +1+: Justiça Federal\\n* +2+: Justiça Estadual",
1335
+ "tag": "tpProc"
1336
+ },
1337
+ {
1338
+ "name": "numero_processo",
1339
+ "description": "Número do Processo.",
1340
+ "type": "String[1-60]",
1341
+ "required": false,
1342
+ "tag": "nProcesso"
1343
+ }
1344
+ ]
1345
+ }
1346
+ },
1347
+ {
1348
+ "name": "tipo_ressarcimento",
1349
+ "description": "Tipo de Ressarcimento.",
1350
+ "type": null,
1351
+ "required": false,
1352
+ "enum": "* +1+: Cobrança Indevida\\n* +2+: Interrupção\\n* +99+: Outros",
1353
+ "tag": "tpRessarc"
1354
+ },
1355
+ {
1356
+ "name": "data_ressarcimento",
1357
+ "description": "Data de referência.",
1358
+ "type": null,
1359
+ "required": false,
1360
+ "tag": "dRef"
1361
+ },
1362
+ {
1363
+ "name": "numero_processo_ressarcimento",
1364
+ "description": "Número do Processo.",
1365
+ "type": "String[1-60]",
1366
+ "required": false,
1367
+ "tag": "nProcesso"
1368
+ },
1369
+ {
1370
+ "name": "numero_protocolo_ressarcimento",
1371
+ "description": "Número do protocolo de reclamação.",
1372
+ "type": "String[1-60]",
1373
+ "required": false,
1374
+ "tag": "nProtReclama"
1375
+ },
1376
+ {
1377
+ "name": "observacoes_ressarcimento",
1378
+ "description": "Observações sobre o processo de ressarcimento.",
1379
+ "type": "String[15-100]",
1380
+ "required": false,
1381
+ "tag": "xObs"
1382
+ },
1383
+ {
1384
+ "name": "informacoes_adicionais",
1385
+ "description": "Informações adicionais do produto (norma referenciada, informações complementares, etc).",
1386
+ "type": "String[1-500]",
1387
+ "required": false,
1388
+ "tag": "infAdProd"
1389
+ }
1390
+ ]
1391
+ }
1392
+ },
1393
+ {
1394
+ "name": "valor_produtos",
1395
+ "description": "Valor Total dos produtos e serviços. Calculado automaticamente se omitido.",
1396
+ "type": "Decimal[13.2]",
1397
+ "required": false,
1398
+ "tag": "vProd"
1399
+ },
1400
+ {
1401
+ "name": "icms_base_calculo",
1402
+ "description": "Valor total da base de cálculo do ICMS. Calculado automaticamente se omitido.",
1403
+ "type": "Decimal[13.2]",
1404
+ "required": false,
1405
+ "tag": "vBC"
1406
+ },
1407
+ {
1408
+ "name": "icms_valor_total",
1409
+ "description": "Valor total do ICMS. Calculado automaticamente se omitido.",
1410
+ "type": "Decimal[13.2]",
1411
+ "required": false,
1412
+ "tag": "vICMS"
1413
+ },
1414
+ {
1415
+ "name": "icms_valor_total_desonerado",
1416
+ "description": "Valor total do ICMS Desonerado. Calculado automaticamente se omitido.",
1417
+ "type": "Decimal[13.2]",
1418
+ "required": false,
1419
+ "tag": "vICMSDeson"
1420
+ },
1421
+ {
1422
+ "name": "icms_fcp_valor_total",
1423
+ "description": "Valor Total do FCP (Fundo de Combate à Pobreza). Calculado automaticamente se omitido.",
1424
+ "type": "Decimal[13.2]",
1425
+ "required": false,
1426
+ "tag": "vFCP"
1427
+ },
1428
+ {
1429
+ "name": "cofins_valor",
1430
+ "description": "Valor do COFINS. Calculado automaticamente se omitido.",
1431
+ "type": "Decimal[13.2]",
1432
+ "required": false,
1433
+ "tag": "vCOFINS"
1434
+ },
1435
+ {
1436
+ "name": "pis_valor",
1437
+ "description": "Valor do PIS. Calculado automaticamente se omitido.",
1438
+ "type": "Decimal[13.2]",
1439
+ "required": false,
1440
+ "tag": "vPIS"
1441
+ },
1442
+ {
1443
+ "name": "funttel_valor",
1444
+ "description": "Valor do FUNTTEL. Calculado automaticamente se omitido.",
1445
+ "type": "Decimal[13.2]",
1446
+ "required": false,
1447
+ "tag": "vFUNTTEL"
1448
+ },
1449
+ {
1450
+ "name": "fust_valor",
1451
+ "description": "Valor do FUST. Calculado automaticamente se omitido.",
1452
+ "type": "Decimal[13.2]",
1453
+ "required": false,
1454
+ "tag": "vFUST"
1455
+ },
1456
+ {
1457
+ "name": "pis_valor_retido",
1458
+ "description": "Valor do PIS retido. Calculado automaticamente se omitido.",
1459
+ "type": "Decimal[13.2]",
1460
+ "required": false,
1461
+ "tag": "vRetPIS"
1462
+ },
1463
+ {
1464
+ "name": "cofins_valor_retido",
1465
+ "description": "Valor do COFINS retido. Calculado automaticamente se omitido.",
1466
+ "type": "Decimal[13.2]",
1467
+ "required": false,
1468
+ "tag": "vRetCofins"
1469
+ },
1470
+ {
1471
+ "name": "csll_valor_retido",
1472
+ "description": "Valor do CSLL retido. Calculado automaticamente se omitido.",
1473
+ "type": "Decimal[13.2]",
1474
+ "required": false,
1475
+ "tag": "vRetCSLL"
1476
+ },
1477
+ {
1478
+ "name": "irrf_valor_retido",
1479
+ "description": "Valor do IRRF retido. Calculado automaticamente se omitido.",
1480
+ "type": "Decimal[13.2]",
1481
+ "required": false,
1482
+ "tag": "vIRRF"
1483
+ },
1484
+ {
1485
+ "name": "valor_desconto",
1486
+ "description": "Valor Total do Desconto. Calculado automaticamente se omitido.",
1487
+ "type": "Decimal[13.2]",
1488
+ "required": false,
1489
+ "tag": "vDesc"
1490
+ },
1491
+ {
1492
+ "name": "valor_outras_despesas",
1493
+ "description": "Outras Despesas acessórias. Calculado automaticamente se omitido.",
1494
+ "type": "Decimal[13.2]",
1495
+ "required": false,
1496
+ "tag": "vOutro"
1497
+ },
1498
+ {
1499
+ "name": "valor_total",
1500
+ "description": "Valor Total da NFCom. Calculado automaticamente se omitido.",
1501
+ "type": "Decimal[13.2]",
1502
+ "required": false,
1503
+ "tag": "vNF"
1504
+ },
1505
+ {
1506
+ "name": "ibs_cbs_base_calculo",
1507
+ "description": "Total da Base de cálculo do IBS/CBS",
1508
+ "type": "Decimal[13.2]",
1509
+ "required": false,
1510
+ "reforma_tributaria": true,
1511
+ "tag": "vBCIBSCBS"
1512
+ },
1513
+ {
1514
+ "name": "ibs_uf_valor_total_diferimento",
1515
+ "description": "Total do diferimento",
1516
+ "type": "Decimal[13.2]",
1517
+ "required": false,
1518
+ "reforma_tributaria": true,
1519
+ "tag": "vDif"
1520
+ },
1521
+ {
1522
+ "name": "ibs_uf_valor_total_devolucao",
1523
+ "description": "Total de Devolução de Tributo IBS UF",
1524
+ "type": "Decimal[13.2]",
1525
+ "required": false,
1526
+ "reforma_tributaria": true,
1527
+ "tag": "vDevTrib"
1528
+ },
1529
+ {
1530
+ "name": "ibs_uf_valor_total",
1531
+ "description": "Total do IBS UF",
1532
+ "type": "Decimal[13.2]",
1533
+ "required": false,
1534
+ "reforma_tributaria": true,
1535
+ "tag": "vIBSUF"
1536
+ },
1537
+ {
1538
+ "name": "ibs_mun_valor_total_diferimento",
1539
+ "description": "Total do diferimento",
1540
+ "type": "Decimal[13.2]",
1541
+ "required": false,
1542
+ "reforma_tributaria": true,
1543
+ "tag": "vDif"
1544
+ },
1545
+ {
1546
+ "name": "ibs_mun_valor_total_devolucao",
1547
+ "description": "Total de Devolução de Tributo IBS Municipal",
1548
+ "type": "Decimal[13.2]",
1549
+ "required": false,
1550
+ "reforma_tributaria": true,
1551
+ "tag": "vDevTrib"
1552
+ },
1553
+ {
1554
+ "name": "ibs_mun_valor_total",
1555
+ "description": "Total do IBS Municipal",
1556
+ "type": "Decimal[13.2]",
1557
+ "required": false,
1558
+ "reforma_tributaria": true,
1559
+ "tag": "vIBSMun"
1560
+ },
1561
+ {
1562
+ "name": "ibs_valor_total",
1563
+ "description": "Total do IBS (IBS UF + IBS Mun)",
1564
+ "type": "Decimal[13.2]",
1565
+ "required": false,
1566
+ "reforma_tributaria": true,
1567
+ "tag": "vIBS"
1568
+ },
1569
+ {
1570
+ "name": "cbs_valor_total_diferimento",
1571
+ "description": "Total do diferimento",
1572
+ "type": "Decimal[13.2]",
1573
+ "required": false,
1574
+ "reforma_tributaria": true,
1575
+ "tag": "vDif"
1576
+ },
1577
+ {
1578
+ "name": "cbs_valor_total_devolucao",
1579
+ "description": "Total de Devolução do tributo CBS",
1580
+ "type": "Decimal[13.2]",
1581
+ "required": false,
1582
+ "reforma_tributaria": true,
1583
+ "tag": "vDevTrib"
1584
+ },
1585
+ {
1586
+ "name": "cbs_valor_total",
1587
+ "description": "Total do CBS",
1588
+ "type": "Decimal[13.2]",
1589
+ "required": false,
1590
+ "reforma_tributaria": true,
1591
+ "tag": "vCBS"
1592
+ },
1593
+ {
1594
+ "name": "ibs_cbs_valor_total",
1595
+ "description": "Valor total do documento fiscal(vNF + total do IBS + total da CBS)",
1596
+ "type": "Decimal[13.2]",
1597
+ "required": false,
1598
+ "reforma_tributaria": true,
1599
+ "tag": "vTotDFe"
1600
+ },
1601
+ {
1602
+ "name": "saldo_pontos",
1603
+ "description": "Saldo de pontos do cliente na data de referência.",
1604
+ "type": "String[1-20]",
1605
+ "required": false,
1606
+ "tag": "qtdSaldoPts"
1607
+ },
1608
+ {
1609
+ "name": "data_afericao_pontos",
1610
+ "description": "Data de aferição do saldo de pontos.",
1611
+ "type": null,
1612
+ "required": false,
1613
+ "tag": "dRefSaldoPts"
1614
+ },
1615
+ {
1616
+ "name": "pontos_resgate",
1617
+ "description": "Qtd de pontos resgatados na data de referência.",
1618
+ "type": "String[1-20]",
1619
+ "required": false,
1620
+ "tag": "qtdPtsResg"
1621
+ },
1622
+ {
1623
+ "name": "data_resgate_pontos",
1624
+ "description": "Data de resgate dos pontos.",
1625
+ "type": null,
1626
+ "required": false,
1627
+ "tag": "dRefResgPts"
1628
+ },
1629
+ {
1630
+ "name": "data_faturamento",
1631
+ "description": "Ano e mês referência do faturamento (AAAAMM).",
1632
+ "type": null,
1633
+ "required": false,
1634
+ "tag": "CompetFat"
1635
+ },
1636
+ {
1637
+ "name": "data_vencimento_fatura",
1638
+ "description": "Data de vencimento da fatura.",
1639
+ "type": null,
1640
+ "required": false,
1641
+ "tag": "dVencFat"
1642
+ },
1643
+ {
1644
+ "name": "data_uso_inicial",
1645
+ "description": "Período de uso inicial.",
1646
+ "type": null,
1647
+ "required": false,
1648
+ "tag": "dPerUsoIni"
1649
+ },
1650
+ {
1651
+ "name": "data_uso_final",
1652
+ "description": "Período de uso final.",
1653
+ "type": null,
1654
+ "required": false,
1655
+ "tag": "dPerUsoFim"
1656
+ },
1657
+ {
1658
+ "name": "codigo_barras",
1659
+ "description": "Linha digitável do código de barras.",
1660
+ "type": "String[1-48]",
1661
+ "required": false,
1662
+ "tag": "codBarras"
1663
+ },
1664
+ {
1665
+ "name": "codigo_debito_automatico",
1666
+ "description": "Código de autorização débito em conta.",
1667
+ "type": "String[1-20]",
1668
+ "required": false,
1669
+ "tag": "codDebAuto"
1670
+ },
1671
+ {
1672
+ "name": "codigo_banco",
1673
+ "description": "Número do banco para débito em conta.",
1674
+ "type": "String[3-5]",
1675
+ "required": false,
1676
+ "tag": "codBanco"
1677
+ },
1678
+ {
1679
+ "name": "codigo_agencia",
1680
+ "description": "Número da agência bancária para débito em conta.",
1681
+ "type": "String[1-10]",
1682
+ "required": false,
1683
+ "tag": "codAgencia"
1684
+ },
1685
+ {
1686
+ "name": "logradouro_entrega_fatura",
1687
+ "description": "Logradouro (rua, avenida, travessa etc.) de entrega da fatura.",
1688
+ "type": "String[2-60]",
1689
+ "required": false,
1690
+ "tag": "xLgr"
1691
+ },
1692
+ {
1693
+ "name": "numero_entrega_fatura",
1694
+ "description": "Número do endereço de entrega da fatura.",
1695
+ "type": "String[1-60]",
1696
+ "required": false,
1697
+ "tag": "nro"
1698
+ },
1699
+ {
1700
+ "name": "complemento_entrega_fatura",
1701
+ "description": "Complemento do endereço de entrega da fatura.",
1702
+ "type": "String[1-60]",
1703
+ "required": false,
1704
+ "tag": "xCpl"
1705
+ },
1706
+ {
1707
+ "name": "bairro_entrega_fatura",
1708
+ "description": "Bairro de entrega da fatura.",
1709
+ "type": "String[2-60]",
1710
+ "required": false,
1711
+ "tag": "xBairro"
1712
+ },
1713
+ {
1714
+ "name": "codigo_municipio_entrega_fatura",
1715
+ "description": "Código do município (utilizar a tabela do IBGE).",
1716
+ "type": "String[7]",
1717
+ "required": false,
1718
+ "tag": "cMun"
1719
+ },
1720
+ {
1721
+ "name": "municipio_entrega_fatura",
1722
+ "description": "Município de entrega da fatura.",
1723
+ "type": "String[2-60]",
1724
+ "required": false,
1725
+ "tag": "xMun"
1726
+ },
1727
+ {
1728
+ "name": "cep_entrega_fatura",
1729
+ "description": "CEP de entrega da fatura.",
1730
+ "type": "Integer[8]",
1731
+ "required": false,
1732
+ "tag": "CEP"
1733
+ },
1734
+ {
1735
+ "name": "uf_entrega_fatura",
1736
+ "description": "UF de entrega da fatura.",
1737
+ "type": "String[2]",
1738
+ "required": false,
1739
+ "tag": "UF"
1740
+ },
1741
+ {
1742
+ "name": "telefone_entrega_fatura",
1743
+ "description": "Telefone de entrega da fatura.",
1744
+ "type": "String[7-12]",
1745
+ "required": false,
1746
+ "tag": "fone"
1747
+ },
1748
+ {
1749
+ "name": "email_entrega_fatura",
1750
+ "description": "Endereço de E-mail de entrega da fatura.",
1751
+ "type": "String[1-60]",
1752
+ "required": false,
1753
+ "tag": "email"
1754
+ },
1755
+ {
1756
+ "name": "url_qrcode_pix",
1757
+ "description": "URL do QRCode do PIX que será apresentado na fatura.",
1758
+ "type": "String[2-2000]",
1759
+ "required": false,
1760
+ "tag": "urlQRCodePIX"
1761
+ },
1762
+ {
1763
+ "name": "cnpj_emitente_centralizado",
1764
+ "description": "CNPJ do Emitente centralizador.",
1765
+ "type": "String[14]",
1766
+ "required": false,
1767
+ "tag": "CNPJ"
1768
+ },
1769
+ {
1770
+ "name": "uf_emitente_centralizado",
1771
+ "description": "Código da UF do emitente centralizador.",
1772
+ "type": "Integer[2]",
1773
+ "required": false,
1774
+ "tag": "cUF"
1775
+ },
1776
+ {
1777
+ "name": "autorizados_download_xml",
1778
+ "description": "Autorizados para download do XML do DF-e.",
1779
+ "type": "Coleção[0-10]",
1780
+ "required": false,
1781
+ "collection_type": "AutorizadosDownloadXml",
1782
+ "collection": {
1783
+ "object_type": "AutorizadosDownloadXml",
1784
+ "object_description": "Autorizados para download do XML do DF-e. Tag XML autXML",
1785
+ "object_attributes": [
1786
+ {
1787
+ "name": "cnpj",
1788
+ "description": "CNPJ do autorizado.",
1789
+ "type": "String[14]",
1790
+ "required": false,
1791
+ "tag": "CNPJ"
1792
+ },
1793
+ {
1794
+ "name": "cpf",
1795
+ "description": "CPF do autorizado.",
1796
+ "type": "String[11]",
1797
+ "required": false,
1798
+ "tag": "CPF"
1799
+ }
1800
+ ]
1801
+ }
1802
+ },
1803
+ {
1804
+ "name": "informacoes_adicionais_fisco",
1805
+ "description": "Informações adicionais de interesse do Fisco.",
1806
+ "type": "String[1-2000]",
1807
+ "required": false,
1808
+ "tag": "infAdFisco"
1809
+ },
1810
+ {
1811
+ "name": "informacoes_complementares_contribuinte",
1812
+ "description": "Informações complementares de interesse do Contribuinte.",
1813
+ "type": "String[1-3000]",
1814
+ "required": false,
1815
+ "tag": "infCpl"
1816
+ },
1817
+ {
1818
+ "name": "cnpj_responsavel_tecnico",
1819
+ "description": "CNPJ da pessoa jurídica responsável técnica pelo sistema utilizado na emissão do documento fiscal eletrônico.",
1820
+ "type": "String[14]",
1821
+ "required": false,
1822
+ "tag": "CNPJ"
1823
+ },
1824
+ {
1825
+ "name": "nome_responsavel_tecnico",
1826
+ "description": "Nome da pessoa a ser contatada.",
1827
+ "type": "String[2-60]",
1828
+ "required": false,
1829
+ "tag": "xContato"
1830
+ },
1831
+ {
1832
+ "name": "email_responsavel_tecnico",
1833
+ "description": "Email da pessoa jurídica a ser contatada.",
1834
+ "type": "String[1-60]",
1835
+ "required": false,
1836
+ "tag": "email"
1837
+ },
1838
+ {
1839
+ "name": "telefone_responsavel_tecnico",
1840
+ "description": "Telefone da pessoa jurídica a ser contatada.",
1841
+ "type": "String[7-12]",
1842
+ "required": false,
1843
+ "tag": "fone"
1844
+ },
1845
+ {
1846
+ "name": "codigo_responsavel_tecnico",
1847
+ "description": "Identificador do código de segurança do responsável técnico.",
1848
+ "type": "String[3]",
1849
+ "required": false,
1850
+ "tag": "idCSRT"
1851
+ },
1852
+ {
1853
+ "name": "hash_responsavel_tecnico",
1854
+ "description": "Hash do token do código de segurança do responsável técnico.",
1855
+ "type": "String[20]",
1856
+ "required": false,
1857
+ "tag": "hashCSRT"
1858
+ }
1859
+ ]