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,1335 @@
1
+ [
2
+ {
3
+ "name": "cfop",
4
+ "description": "CFOP da CT-e.",
5
+ "type": "Integer[4]",
6
+ "required": true,
7
+ "tag": "CFOP"
8
+ },
9
+ {
10
+ "name": "natureza_operacao",
11
+ "description": "Descrição da natureza de operação.",
12
+ "type": "String[1-60]",
13
+ "required": true,
14
+ "tag": "natOp"
15
+ },
16
+ {
17
+ "name": "serie",
18
+ "description": "Série da CT-e. Deixe em branco para que a API se responsabilize pela numeração automática (recomendado)",
19
+ "type": "Integer[1-3]",
20
+ "required": false,
21
+ "tag": "serie"
22
+ },
23
+ {
24
+ "name": "numero",
25
+ "description": "Número da CT-e. Deixe em branco para que a API se responsabilize pela numeração automática (recomendado)",
26
+ "type": "Integer[1-9]",
27
+ "required": false,
28
+ "tag": "nCT"
29
+ },
30
+ {
31
+ "name": "data_emissao",
32
+ "description": "Data e hora de emissão.",
33
+ "type": null,
34
+ "required": true,
35
+ "tag": "dhEmi"
36
+ },
37
+ {
38
+ "name": "tipo_documento",
39
+ "description": "Tipo do CT-e",
40
+ "type": null,
41
+ "required": true,
42
+ "enum": "* +0+: CT-e Normal\\n* +1+: CT-e de Complemento de Valores\\n* +3+: CT-e Substituto",
43
+ "tag": "tpCTe"
44
+ },
45
+ {
46
+ "name": "codigo_municipio_envio",
47
+ "description": "Código do Município de envio do CT-e. Caso este campo seja omitido, o código será buscado a partir do nome e estado do município, caso contrário utilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.",
48
+ "type": "Integer[7]",
49
+ "required": true,
50
+ "tag": "cMunEnv"
51
+ },
52
+ {
53
+ "name": "municipio_envio",
54
+ "description": "Nome do município de envio do CT-e. Informar PAIS/Municipio para as operações com o exterior.",
55
+ "type": "String[2-60]",
56
+ "required": true,
57
+ "tag": "xMunEnv"
58
+ },
59
+ {
60
+ "name": "uf_envio",
61
+ "description": "Sigla da UF de envio do CT-e. Informar 'EX' para as operações com o exterior.",
62
+ "type": "String[2]",
63
+ "required": true,
64
+ "tag": "UFEnv"
65
+ },
66
+ {
67
+ "name": "modal",
68
+ "description": "Modal de transporte da CT-e OS",
69
+ "type": null,
70
+ "required": true,
71
+ "enum": "* +01+: Rodoviário\\n* +02+: Aéreo\\n* +03+: Aquaviário\\n* +04+: Ferroviário\\n* +05+: Dutoviário\\n* +06+: Multimodal",
72
+ "tag": "modal"
73
+ },
74
+ {
75
+ "name": "tipo_servico",
76
+ "description": "Tipo do serviço prestado.",
77
+ "type": null,
78
+ "required": true,
79
+ "enum": "* +6+: Transporte de Pessoas\\n* +7+: Transporte de Valores\\n* +8+: Excesso de Bagagem",
80
+ "tag": "tpServ"
81
+ },
82
+ {
83
+ "name": "indicador_inscricao_estadual_tomador",
84
+ "description": "Indicador do papel do tomador na prestação do serviço.",
85
+ "type": null,
86
+ "required": true,
87
+ "enum": "* +1+: Contribuinte ICMS\\n* +2+: Contribuinte isento de inscrição\\n* +9+: Não Contribuinte",
88
+ "tag": "indIEToma"
89
+ },
90
+ {
91
+ "name": "codigo_municipio_inicio",
92
+ "description": "Código do Município de início da prestação. Caso este campo seja omitido, o código será buscado a partir do nome e estado do município, caso contrário utilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.",
93
+ "type": "Integer[7]",
94
+ "required": true,
95
+ "tag": "cMunIni"
96
+ },
97
+ {
98
+ "name": "municipio_inicio",
99
+ "description": "Nome do município de início da prestação. Informar 'EXTERIOR' para as operações com o exterior.",
100
+ "type": "String[2-60]",
101
+ "required": true,
102
+ "tag": "xMunIni"
103
+ },
104
+ {
105
+ "name": "uf_inicio",
106
+ "description": "Sigla da UF de início da prestação. Informar 'EX' para as operações com o exterior.",
107
+ "type": "String[2]",
108
+ "required": true,
109
+ "tag": "UFIni"
110
+ },
111
+ {
112
+ "name": "codigo_municipio_fim",
113
+ "description": "Código do Município de término da prestação. Caso este campo seja omitido, o código será buscado a partir do nome e estado do município, caso contrário utilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.",
114
+ "type": "Integer[7]",
115
+ "required": true,
116
+ "tag": "cMunFim"
117
+ },
118
+ {
119
+ "name": "municipio_fim",
120
+ "description": "Nome do município de término da prestação. Informar 'EXTERIOR' para as operações com o exterior.",
121
+ "type": "String[2-60]",
122
+ "required": true,
123
+ "tag": "xMunFim"
124
+ },
125
+ {
126
+ "name": "uf_fim",
127
+ "description": "Sigla da UF de término da prestação. Informar 'EX' para as operações com o exterior.",
128
+ "type": "String[2]",
129
+ "required": true,
130
+ "tag": "UFFim"
131
+ },
132
+ {
133
+ "name": "percursos",
134
+ "description": "Informações do Percurso do CT-e Outros Serviços",
135
+ "type": "Coleção[0-25]",
136
+ "required": false,
137
+ "collection_type": "InfoPercursoOsXML",
138
+ "collection": {
139
+ "object_type": "InfoPercursoOsXML",
140
+ "object_description": "Informações do Percurso do CT-e Outros Serviços. Tag XML infPercurso.",
141
+ "object_attributes": [
142
+ {
143
+ "name": "uf_percurso_veiculo",
144
+ "description": "Sigla das Unidades da Federação do percurso do veículo.",
145
+ "type": "String[2]",
146
+ "required": false,
147
+ "tag": "UFPer"
148
+ }
149
+ ]
150
+ }
151
+ },
152
+ {
153
+ "name": "tipo_compra_governamental",
154
+ "description": "Para administração pública direta e suas autarquias e fundações",
155
+ "type": null,
156
+ "required": false,
157
+ "reforma_tributaria": true,
158
+ "enum": "* +1+: União\\n* +2+: Estados\\n* +3+: Distrito Federal\\n* +4+: Municípios\\n* +5+: Consórcio Público\\n* +6+: Comitê Gestor do IBS",
159
+ "tag": "tpEnteGov"
160
+ },
161
+ {
162
+ "name": "perc_reducao_aliquota_compra_governamental",
163
+ "description": "Percentual de redução de alíquota em compra governamental",
164
+ "type": "Decimal[3.2-4]",
165
+ "required": false,
166
+ "reforma_tributaria": true,
167
+ "tag": "pRedutor"
168
+ },
169
+ {
170
+ "name": "tipo_operacao_governamental",
171
+ "description": "Tipo de operação com ente governamental",
172
+ "type": null,
173
+ "required": false,
174
+ "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",
175
+ "tag": "tpOperGov"
176
+ },
177
+ {
178
+ "name": "chave_acesso_dfe_anterior",
179
+ "description": "Chave de acesso do documento fiscal anterior. Deverá ser informado para tpOperGov 2 e 3 e vedado para os tipos 1 e 4.",
180
+ "type": "String[44]",
181
+ "required": false,
182
+ "tag": "refDFeAnt"
183
+ },
184
+ {
185
+ "name": "caracteristica_adicional_transporte",
186
+ "description": "Característica adicional de transporte. Texto livre: REENTREGA; DEVOLUÇÃO; REFATURAMENTO; etc.",
187
+ "type": "String[1-15]",
188
+ "required": false,
189
+ "tag": "xCaracAd"
190
+ },
191
+ {
192
+ "name": "caracteristica_adicional_servico",
193
+ "description": "Característica adicional de serviço. Texto livre: ENTREGA EXPRESSA; LOGÍSTICA REVERSA; CONVENCIONAL; EMERGENCIAL; etc",
194
+ "type": "String[1-40]",
195
+ "required": false,
196
+ "tag": "xCaracSer"
197
+ },
198
+ {
199
+ "name": "funcionario_emissor",
200
+ "description": "Funcionário emissor do CT-e.",
201
+ "type": "String[1-20]",
202
+ "required": false,
203
+ "tag": "xEmi"
204
+ },
205
+ {
206
+ "name": "observacoes",
207
+ "description": "Observações gerais.",
208
+ "type": "String[1-2000]",
209
+ "required": false,
210
+ "tag": "xObs"
211
+ },
212
+ {
213
+ "name": "observacoes_contribuinte",
214
+ "description": "Observações gerais.",
215
+ "type": "Coleçao[0-10]",
216
+ "required": false,
217
+ "collection_type": "ObservacoesContribuinteXML",
218
+ "collection": {
219
+ "object_type": "ObservacoesContribuinteXML",
220
+ "object_description": "Observações do Contribuinte. Tag XML ObsCont.",
221
+ "object_attributes": [
222
+ {
223
+ "name": "campo",
224
+ "description": "Identificação do campo",
225
+ "type": "String[1-20]",
226
+ "required": false,
227
+ "tag": "xCampo"
228
+ },
229
+ {
230
+ "name": "conteudo",
231
+ "description": "Conteúdo do campo",
232
+ "type": "String[1-160]",
233
+ "required": false,
234
+ "tag": "xTexto"
235
+ }
236
+ ]
237
+ }
238
+ },
239
+ {
240
+ "name": "observacoes_fisco",
241
+ "description": "Observações gerais.",
242
+ "type": "Coleçao[0-10]",
243
+ "required": false,
244
+ "collection_type": "ObservacoesFiscoXML",
245
+ "collection": {
246
+ "object_type": "ObservacoesFiscoXML",
247
+ "object_description": "Observações do Fisco. Tag XML ObsFisco.",
248
+ "object_attributes": [
249
+ {
250
+ "name": "campo",
251
+ "description": "Identificação do campo",
252
+ "type": "String[1-20]",
253
+ "required": false,
254
+ "tag": "xCampo"
255
+ },
256
+ {
257
+ "name": "conteudo",
258
+ "description": "Conteúdo do campo",
259
+ "type": "String[1-60]",
260
+ "required": false,
261
+ "tag": "xTexto"
262
+ }
263
+ ]
264
+ }
265
+ },
266
+ {
267
+ "name": "cnpj_emitente",
268
+ "description": "CNPJ do emitente. Omitir caso o tomador seja pessoa física e informar a tag 'cpf_emitente'. Em caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.",
269
+ "type": "String[14]",
270
+ "required": true,
271
+ "tag": "CNPJ"
272
+ },
273
+ {
274
+ "name": "inscricao_estadual_emitente",
275
+ "description": "Inscrição Estadual da empresa emitente.",
276
+ "type": "Integer[14]",
277
+ "required": true,
278
+ "tag": "IE"
279
+ },
280
+ {
281
+ "name": "inscricao_estadual_st_emitente",
282
+ "description": "Inscrição Estadual do Substituto Tributário da empresa emitente.",
283
+ "type": "Integer[14]",
284
+ "required": true,
285
+ "tag": "IEST"
286
+ },
287
+ {
288
+ "name": "nome_emitente",
289
+ "description": "Razão Social ou nome da empresa emitente.",
290
+ "type": "String[2-60]",
291
+ "required": true,
292
+ "tag": "xNome"
293
+ },
294
+ {
295
+ "name": "nome_fantasia_emitente",
296
+ "description": "Nome fantasia da empresa emitente.",
297
+ "type": "String[2-60]",
298
+ "required": true,
299
+ "tag": "xFant"
300
+ },
301
+ {
302
+ "name": "logradouro_emitente",
303
+ "description": "Logradouro (rua, avenida, travessa etc.) da empresa emitente.",
304
+ "type": "String[2-60]",
305
+ "required": true,
306
+ "tag": "xLgr"
307
+ },
308
+ {
309
+ "name": "numero_emitente",
310
+ "description": "Número do endereço da empresa emitente.",
311
+ "type": "String[1-60]",
312
+ "required": true,
313
+ "tag": "nro"
314
+ },
315
+ {
316
+ "name": "complemento_emitente",
317
+ "description": "Complemento do endereço da empresa emitente.",
318
+ "type": "String[1-60]",
319
+ "required": false,
320
+ "tag": "xCpl"
321
+ },
322
+ {
323
+ "name": "bairro_emitente",
324
+ "description": "Bairro da empresa emitente.",
325
+ "type": "String[2-60]",
326
+ "required": true,
327
+ "tag": "xBairro"
328
+ },
329
+ {
330
+ "name": "codigo_municipio_emitente",
331
+ "description": "Código do Município da empresa emitente. Caso este campo seja omitido, o código será buscado a partir do nome e estado do município, caso contrário utilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.",
332
+ "type": "Integer[7]",
333
+ "required": true,
334
+ "tag": "cMun"
335
+ },
336
+ {
337
+ "name": "municipio_emitente",
338
+ "description": "Município da empresa emitente.",
339
+ "type": "String[2-60]",
340
+ "required": true,
341
+ "tag": "xMun"
342
+ },
343
+ {
344
+ "name": "cep_emitente",
345
+ "description": "CEP da empresa emitente.",
346
+ "type": "Integer[8]",
347
+ "required": false,
348
+ "tag": "CEP"
349
+ },
350
+ {
351
+ "name": "uf_emitente",
352
+ "description": "UF da empresa emitente.",
353
+ "type": "String[2]",
354
+ "required": true,
355
+ "tag": "UF"
356
+ },
357
+ {
358
+ "name": "telefone_emitente",
359
+ "description": "Telefone da empresa emitente.",
360
+ "type": "Integer[6-14]",
361
+ "required": false,
362
+ "tag": "fone"
363
+ },
364
+ {
365
+ "name": "cnpj_tomador",
366
+ "description": "CNPJ do tomador. Omitir caso o tomador seja pessoa física e informar a tag 'cpf_tomador'. Em caso de empresa não estabelecida no Brasil, será informado o CNPJ com zeros.",
367
+ "type": "String[14]",
368
+ "required": false,
369
+ "tag": "CNPJ"
370
+ },
371
+ {
372
+ "name": "cpf_tomador",
373
+ "description": "CPF do tomador. Omitir caso o tomador seja pessoa jurídica e informar a tag 'cnpj_tomador'.",
374
+ "type": "Integer[11]",
375
+ "required": false,
376
+ "tag": "CPF"
377
+ },
378
+ {
379
+ "name": "inscricao_estadual_tomador",
380
+ "description": "Informar a IE do tomador ou ISENTO se tomador é contribuinte do ICMS isento de inscrição no cadastro de contribuintes do ICMS. Caso o tomador não seja contribuinte do ICMS não informar a tag.",
381
+ "type": "Integer[14]",
382
+ "required": false,
383
+ "tag": "IE"
384
+ },
385
+ {
386
+ "name": "nome_tomador",
387
+ "description": "Razão Social ou nome do tomador.",
388
+ "type": "String[2-60]",
389
+ "required": true,
390
+ "tag": "xNome"
391
+ },
392
+ {
393
+ "name": "nome_fantasia_tomador",
394
+ "description": "Nome fantasia do tomador.",
395
+ "type": "String[2-60]",
396
+ "required": false,
397
+ "tag": "xFant"
398
+ },
399
+ {
400
+ "name": "telefone_tomador",
401
+ "description": "Telefone do tomador.",
402
+ "type": "Integer[6-14]",
403
+ "required": true,
404
+ "tag": "fone"
405
+ },
406
+ {
407
+ "name": "logradouro_tomador",
408
+ "description": "Logradouro do tomador(rua, avenida, travessa etc.).",
409
+ "type": "String[2-255]",
410
+ "required": true,
411
+ "tag": "xLgr"
412
+ },
413
+ {
414
+ "name": "numero_tomador",
415
+ "description": "Número do endereço do tomador.",
416
+ "type": "String[1-60]",
417
+ "required": true,
418
+ "tag": "nro"
419
+ },
420
+ {
421
+ "name": "complemento_tomador",
422
+ "description": "Complemento do tomador.",
423
+ "type": "String[1-60]",
424
+ "required": false,
425
+ "tag": "xCpl"
426
+ },
427
+ {
428
+ "name": "bairro_tomador",
429
+ "description": "Bairro do tomador.",
430
+ "type": "Integer[2-60]",
431
+ "required": true,
432
+ "tag": "xBairro"
433
+ },
434
+ {
435
+ "name": "codigo_municipio_tomador",
436
+ "description": "Código do Município do tomador. Caso este campo seja omitido, o código será buscado a partir do nome e estado do município, caso contrário utilizar a tabela do IBGE. Informar 9999999 para operações com o exterior.",
437
+ "type": "Integer[7]",
438
+ "required": true,
439
+ "tag": "cMun"
440
+ },
441
+ {
442
+ "name": "municipio_tomador",
443
+ "description": "Nome do município do tomador. Informar EXTERIOR para operações com o exterior.",
444
+ "type": "String[2-60]",
445
+ "required": true,
446
+ "tag": "xMun"
447
+ },
448
+ {
449
+ "name": "cep_tomador",
450
+ "description": "CEP do endereço do tomador.",
451
+ "type": "Integer[8]",
452
+ "required": true,
453
+ "tag": "CEP"
454
+ },
455
+ {
456
+ "name": "uf_tomador",
457
+ "description": "Sigla da UF do tomador. Informar EX para operações com o exterior.",
458
+ "type": "String[2]",
459
+ "required": true,
460
+ "tag": "UF"
461
+ },
462
+ {
463
+ "name": "codigo_pais_tomador",
464
+ "description": "Código do país do tomador. Utilizar a tabela BACEN.",
465
+ "type": "Integer[1-4]",
466
+ "required": true,
467
+ "tag": "cPais"
468
+ },
469
+ {
470
+ "name": "pais_tomador",
471
+ "description": "Nome do país do tomador.",
472
+ "type": "String[2-60]",
473
+ "required": true,
474
+ "tag": "xPais"
475
+ },
476
+ {
477
+ "name": "email_tomador",
478
+ "description": "Endereço de e-mail do tomador.",
479
+ "type": "String[1-60]",
480
+ "required": false,
481
+ "tag": "email"
482
+ },
483
+ {
484
+ "name": "valor_total",
485
+ "description": "Valor total da prestação de serviço.",
486
+ "type": "Decimal[13.2]",
487
+ "required": true,
488
+ "tag": "vTPrest"
489
+ },
490
+ {
491
+ "name": "valor_receber",
492
+ "description": "Valor a receber.",
493
+ "type": "Decimal[13.2]",
494
+ "required": true,
495
+ "tag": "vRec"
496
+ },
497
+ {
498
+ "name": "componentes_valor",
499
+ "description": "Componentes do Valor da Prestação",
500
+ "type": "Coleção[0-100]",
501
+ "required": false,
502
+ "collection_type": "ComponenteValorPrestacaoXML",
503
+ "collection": {
504
+ "object_type": "ComponenteValorPrestacaoXML",
505
+ "object_description": "Componentes do Valor da Prestação. Tag XML Comp.",
506
+ "object_attributes": [
507
+ {
508
+ "name": "nome",
509
+ "description": "Nome do componente",
510
+ "type": "String[1-15]",
511
+ "required": false,
512
+ "tag": "xNome"
513
+ },
514
+ {
515
+ "name": "valor",
516
+ "description": "Valor do componente",
517
+ "type": "Decimal[13.2]",
518
+ "required": false,
519
+ "tag": "vComp"
520
+ }
521
+ ]
522
+ }
523
+ },
524
+ {
525
+ "name": null,
526
+ "description": ":icms_situacao_tributaria Situação tributária do ICMS.",
527
+ "type": null,
528
+ "required": true,
529
+ "enum": "* +00+: tributada integralmente\\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_outra_uf+: outros (ICMS devido à UF de origem da prestação, quando diferente da UF do emitente)\\n* +90_simples_nacional+: outros (regime Simples Nacional)",
530
+ "tag": "CST"
531
+ },
532
+ {
533
+ "name": null,
534
+ "description": ":icms_base_calculo Valor da base de cálculo do ICMS.",
535
+ "type": "Decimal[13.2]",
536
+ "required": false,
537
+ "tag": "vBC"
538
+ },
539
+ {
540
+ "name": null,
541
+ "description": ":icms_aliquota Alíquota do ICMS.",
542
+ "type": "Decimal[3.2-4]",
543
+ "required": false,
544
+ "tag": "pICMS"
545
+ },
546
+ {
547
+ "name": null,
548
+ "description": ":icms_valor Valor do ICMS.",
549
+ "type": "Decimal[13.2]",
550
+ "required": false,
551
+ "tag": "vICMS"
552
+ },
553
+ {
554
+ "name": null,
555
+ "description": ":icms_reducao_base_calculo Percentual de redução da base de cálculo.",
556
+ "type": "Decimal[3.2-4]",
557
+ "required": false,
558
+ "tag": "pRedBC"
559
+ },
560
+ {
561
+ "name": null,
562
+ "description": ":icms_valor_credito_presumido Valor crédito outorgado/Presumido.",
563
+ "type": "Decimal[13.2]",
564
+ "required": false,
565
+ "tag": "vCred"
566
+ },
567
+ {
568
+ "name": null,
569
+ "description": ":icms_indicador_simples_nacional Indicador de contribuinte Simples Nacional.",
570
+ "type": null,
571
+ "required": false,
572
+ "enum": "* +1+: Sim",
573
+ "tag": "indSN"
574
+ },
575
+ {
576
+ "name": "valor_total_tributos",
577
+ "description": "Valor total aproximado dos tributos",
578
+ "type": "Decimal[13.2]",
579
+ "required": false,
580
+ "tag": "vTotTrib"
581
+ },
582
+ {
583
+ "name": "informacoes_adicionais_fisco",
584
+ "description": "Informações adicionais de interesse do Fisco.",
585
+ "type": "String[1-2000]",
586
+ "required": false,
587
+ "tag": "infAdFisco"
588
+ },
589
+ {
590
+ "name": "icms_base_calculo_uf_fim",
591
+ "description": "Valor da BC do ICMS na UF de término da prestação do serviço de transporte.",
592
+ "type": "Decimal[13.2]",
593
+ "required": false,
594
+ "tag": "vBCUFFim"
595
+ },
596
+ {
597
+ "name": "icms_percentual_fcp_uf_fim",
598
+ "description": "Percentual do ICMS relativo ao Fundo de Combate à pobreza (FCP) na UF de término da prestação do serviço de transporte.",
599
+ "type": "Decimal[3.2]",
600
+ "required": false,
601
+ "tag": "pFCPUFFim"
602
+ },
603
+ {
604
+ "name": "icms_aliquota_interna_uf_fim",
605
+ "description": "Alíquota interna da UF de término da prestação do serviço de transporte.",
606
+ "type": "Decimal[3.2]",
607
+ "required": false,
608
+ "tag": "pICMSUFFim"
609
+ },
610
+ {
611
+ "name": "icms_aliquota_interestadual_uf_fim",
612
+ "description": "Alíquota interestadual das UF envolvidas",
613
+ "type": "Decimal[3.2]",
614
+ "required": false,
615
+ "tag": "pICMSInter"
616
+ },
617
+ {
618
+ "name": "icms_valor_total_fcp_uf_fim",
619
+ "description": "Valor do ICMS relativo ao Fundo de Combate á Pobreza (FCP) da UF de término da prestação.",
620
+ "type": "Decimal[13.2]",
621
+ "required": false,
622
+ "tag": "vFCPUFFim"
623
+ },
624
+ {
625
+ "name": "icms_valor_partilha_uf_fim",
626
+ "description": "Valor do ICMS de partilha para a UF de término da prestação do serviço de transporte.",
627
+ "type": "Decimal[13.2]",
628
+ "required": false,
629
+ "tag": "vICMSUFFim"
630
+ },
631
+ {
632
+ "name": "icms_valor_partilha_uf_inicio",
633
+ "description": "Valor do ICMS de partilha para a UF de início da prestação do serviço de transporte.",
634
+ "type": "Decimal[13.2]",
635
+ "required": false,
636
+ "tag": "vICMSUFIni"
637
+ },
638
+ {
639
+ "name": "valor_pis",
640
+ "description": "Valor do PIS.",
641
+ "type": "Decimal[13.2]",
642
+ "required": false,
643
+ "tag": "vPIS"
644
+ },
645
+ {
646
+ "name": "valor_cofins",
647
+ "description": "Valor do COFINS.",
648
+ "type": "Decimal[13.2]",
649
+ "required": false,
650
+ "tag": "vCOFINS"
651
+ },
652
+ {
653
+ "name": "valor_ir",
654
+ "description": "Valor do Imposto de Renda.",
655
+ "type": "Decimal[13.2]",
656
+ "required": false,
657
+ "tag": "vIR"
658
+ },
659
+ {
660
+ "name": "valor_inss",
661
+ "description": "Valor do INSS.",
662
+ "type": "Decimal[13.2]",
663
+ "required": false,
664
+ "tag": "vINSS"
665
+ },
666
+ {
667
+ "name": "valor_csll",
668
+ "description": "Valor do CSLL.",
669
+ "type": "Decimal[13.2]",
670
+ "required": false,
671
+ "tag": "vCSLL"
672
+ },
673
+ {
674
+ "name": "ibs_cbs_situacao_tributaria",
675
+ "description": "Código da Situação Tributária do IBS/CBS",
676
+ "type": "String[3]",
677
+ "required": true,
678
+ "reforma_tributaria": true,
679
+ "tag": "CST"
680
+ },
681
+ {
682
+ "name": "ibs_cbs_classificacao_tributaria",
683
+ "description": "Código de Classificação Tributária do IBS/CBS",
684
+ "type": "String[6]",
685
+ "required": true,
686
+ "reforma_tributaria": true,
687
+ "tag": "cClassTrib"
688
+ },
689
+ {
690
+ "name": "ibs_cbs_base_calculo",
691
+ "description": "Base de cálculo do IBS e CBS",
692
+ "type": "Decimal[13.2]",
693
+ "required": false,
694
+ "reforma_tributaria": true,
695
+ "tag": "vBC"
696
+ },
697
+ {
698
+ "name": "ibs_uf_aliquota",
699
+ "description": "Alíquota do IBS de competência das UF",
700
+ "type": "Decimal[3.2-4]",
701
+ "required": false,
702
+ "reforma_tributaria": true,
703
+ "tag": "pIBSUF"
704
+ },
705
+ {
706
+ "name": "ibs_uf_percentual_diferimento",
707
+ "description": "Percentual do diferimento",
708
+ "type": "Decimal[3.2-4]",
709
+ "required": false,
710
+ "reforma_tributaria": true,
711
+ "tag": "pDif"
712
+ },
713
+ {
714
+ "name": "ibs_uf_valor_diferido",
715
+ "description": "Valor do Diferimento",
716
+ "type": "Decimal[13.2]",
717
+ "required": false,
718
+ "reforma_tributaria": true,
719
+ "tag": "vDif"
720
+ },
721
+ {
722
+ "name": "ibs_uf_valor_tributo_devolvido",
723
+ "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",
724
+ "type": "Decimal[13.2]",
725
+ "required": false,
726
+ "reforma_tributaria": true,
727
+ "tag": "vDevTrib"
728
+ },
729
+ {
730
+ "name": "ibs_uf_percentual_reducao_aliquota",
731
+ "description": "Percentual da redução de alíquota",
732
+ "type": "Decimal[3.2-4]",
733
+ "required": false,
734
+ "reforma_tributaria": true,
735
+ "tag": "pRedAliq"
736
+ },
737
+ {
738
+ "name": "ibs_uf_aliquota_efetiva",
739
+ "description": "Alíquota Efetiva do IBS de competência das UF que será aplicada a Base de Cálculo",
740
+ "type": "Decimal[3.2-4]",
741
+ "required": false,
742
+ "reforma_tributaria": true,
743
+ "tag": "pAliqEfet"
744
+ },
745
+ {
746
+ "name": "ibs_uf_valor",
747
+ "description": "Valor do IBS de competência da UF",
748
+ "type": "Decimal[13.2]",
749
+ "required": false,
750
+ "reforma_tributaria": true,
751
+ "tag": "vIBSUF"
752
+ },
753
+ {
754
+ "name": "ibs_mun_aliquota",
755
+ "description": "Alíquota do IBS de competência do Município",
756
+ "type": "Decimal[3.2-4]",
757
+ "required": false,
758
+ "reforma_tributaria": true,
759
+ "tag": "pIBSMun"
760
+ },
761
+ {
762
+ "name": "ibs_mun_percentual_diferimento",
763
+ "description": "Percentual do diferimento",
764
+ "type": "Decimal[3.2-4]",
765
+ "required": false,
766
+ "reforma_tributaria": true,
767
+ "tag": "pDif"
768
+ },
769
+ {
770
+ "name": "ibs_mun_valor_diferido",
771
+ "description": "Valor do Diferimento",
772
+ "type": "Decimal[13.2]",
773
+ "required": false,
774
+ "reforma_tributaria": true,
775
+ "tag": "vDif"
776
+ },
777
+ {
778
+ "name": "ibs_mun_valor_tributo_devolvido",
779
+ "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",
780
+ "type": "Decimal[13.2]",
781
+ "required": false,
782
+ "reforma_tributaria": true,
783
+ "tag": "vDevTrib"
784
+ },
785
+ {
786
+ "name": "ibs_mun_percentual_reducao_aliquota",
787
+ "description": "Percentual da redução de alíquota",
788
+ "type": "Decimal[3.2-4]",
789
+ "required": false,
790
+ "reforma_tributaria": true,
791
+ "tag": "pRedAliq"
792
+ },
793
+ {
794
+ "name": "ibs_mun_aliquota_efetiva",
795
+ "description": "Alíquota Efetiva do IBS de competência das UF que será aplicada a Base de Cálculo",
796
+ "type": "Decimal[3.2-4]",
797
+ "required": false,
798
+ "reforma_tributaria": true,
799
+ "tag": "pAliqEfet"
800
+ },
801
+ {
802
+ "name": "ibs_mun_valor",
803
+ "description": "Valor do IBS de competência do Município",
804
+ "type": "Decimal[13.2]",
805
+ "required": false,
806
+ "reforma_tributaria": true,
807
+ "tag": "vIBSMun"
808
+ },
809
+ {
810
+ "name": "ibs_valor_total",
811
+ "description": "Valor do IBS",
812
+ "type": "Decimal[13.2]",
813
+ "required": false,
814
+ "reforma_tributaria": true,
815
+ "tag": "vIBS"
816
+ },
817
+ {
818
+ "name": "cbs_aliquota",
819
+ "description": "Alíquota da CBS",
820
+ "type": "Decimal[4]",
821
+ "required": false,
822
+ "reforma_tributaria": true,
823
+ "tag": "pCBS"
824
+ },
825
+ {
826
+ "name": "cbs_percentual_diferimento",
827
+ "description": "Percentual do diferimento",
828
+ "type": "Decimal[3.2-4]",
829
+ "required": false,
830
+ "reforma_tributaria": true,
831
+ "tag": "pDif"
832
+ },
833
+ {
834
+ "name": "cbs_valor_diferido",
835
+ "description": "Valor do Diferimento",
836
+ "type": "Decimal[13.2]",
837
+ "required": false,
838
+ "reforma_tributaria": true,
839
+ "tag": "vDif"
840
+ },
841
+ {
842
+ "name": "cbs_valor_tributo_devolvido",
843
+ "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",
844
+ "type": "Decimal[13.2]",
845
+ "required": false,
846
+ "reforma_tributaria": true,
847
+ "tag": "vDevTrib"
848
+ },
849
+ {
850
+ "name": "cbs_percentual_reducao_aliquota",
851
+ "description": "Percentual da redução de alíquota",
852
+ "type": "Decimal[3.2-4]",
853
+ "required": false,
854
+ "reforma_tributaria": true,
855
+ "tag": "pRedAliq"
856
+ },
857
+ {
858
+ "name": "cbs_aliquota_efetiva",
859
+ "description": "Alíquota Efetiva do IBS de competência das UF que será aplicada a Base de Cálculo",
860
+ "type": "Decimal[3.2-4]",
861
+ "required": false,
862
+ "reforma_tributaria": true,
863
+ "tag": "pAliqEfet"
864
+ },
865
+ {
866
+ "name": "cbs_valor",
867
+ "description": "Valor da CBS",
868
+ "type": "Decimal[13.2]",
869
+ "required": false,
870
+ "reforma_tributaria": true,
871
+ "tag": "vCBS"
872
+ },
873
+ {
874
+ "name": "ibs_cbs_situacao_tributaria_regular",
875
+ "description": "Código da Situação Tributária do IBS e CBS",
876
+ "type": "String[3]",
877
+ "required": false,
878
+ "reforma_tributaria": true,
879
+ "tag": "CSTReg"
880
+ },
881
+ {
882
+ "name": "ibs_cbs_classificacao_tributaria_regular",
883
+ "description": "Código de Classificação Tributária do IBS e CBS",
884
+ "type": "String[6]",
885
+ "required": false,
886
+ "reforma_tributaria": true,
887
+ "tag": "cClassTribReg"
888
+ },
889
+ {
890
+ "name": "ibs_aliquota_efetiva_regular_uf",
891
+ "description": "Valor da alíquota do IBS da UF",
892
+ "type": "Decimal[3.2-4]",
893
+ "required": false,
894
+ "reforma_tributaria": true,
895
+ "tag": "pAliqEfetRegIBSUF"
896
+ },
897
+ {
898
+ "name": "ibs_valor_tributo_regular_uf",
899
+ "description": "Valor do Tributo do IBS da UF",
900
+ "type": "Decimal[13.2]",
901
+ "required": false,
902
+ "reforma_tributaria": true,
903
+ "tag": "vTribRegIBSUF"
904
+ },
905
+ {
906
+ "name": "ibs_aliquota_efetiva_regular_municipio",
907
+ "description": "Valor da alíquota do IBS do Município",
908
+ "type": "Decimal[3.2-4]",
909
+ "required": false,
910
+ "reforma_tributaria": true,
911
+ "tag": "pAliqEfetRegIBSMun"
912
+ },
913
+ {
914
+ "name": "ibs_valor_tributo_regular_municipio",
915
+ "description": "Valor do Tributo do IBS do Município",
916
+ "type": "Decimal[13.2]",
917
+ "required": false,
918
+ "reforma_tributaria": true,
919
+ "tag": "vTribRegIBSMun"
920
+ },
921
+ {
922
+ "name": "cbs_aliquota_efetiva_regular",
923
+ "description": "Valor da alíquota da CBS",
924
+ "type": "Decimal[3.2-4]",
925
+ "required": false,
926
+ "reforma_tributaria": true,
927
+ "tag": "pAliqEfetRegCBS"
928
+ },
929
+ {
930
+ "name": "cbs_valor_tributo_regular",
931
+ "description": "Valor do Tributo da CBS",
932
+ "type": "Decimal[13.2]",
933
+ "required": false,
934
+ "reforma_tributaria": true,
935
+ "tag": "vTribRegCBS"
936
+ },
937
+ {
938
+ "name": "ibs_aliquota_uf",
939
+ "description": "Alíquota IBS da UF utilizada",
940
+ "type": "Decimal[3.2-4]",
941
+ "required": false,
942
+ "reforma_tributaria": true,
943
+ "tag": "pAliqIBSUF"
944
+ },
945
+ {
946
+ "name": "ibs_valor_tributo_uf",
947
+ "description": "Valor do Tributo do IBS da UF",
948
+ "type": "Decimal[13.2]",
949
+ "required": false,
950
+ "reforma_tributaria": true,
951
+ "tag": "vTribIBSUF"
952
+ },
953
+ {
954
+ "name": "ibs_aliquota_municipio",
955
+ "description": "Alíquota IBS do Município utilizada",
956
+ "type": "Decimal[3.2-4]",
957
+ "required": false,
958
+ "reforma_tributaria": true,
959
+ "tag": "pAliqIBSMun"
960
+ },
961
+ {
962
+ "name": "ibs_valor_tributo_municipio",
963
+ "description": "Valor do Tributo do Município da UF",
964
+ "type": "Decimal[13.2]",
965
+ "required": false,
966
+ "reforma_tributaria": true,
967
+ "tag": "vTribIBSMun"
968
+ },
969
+ {
970
+ "name": "ibs_cbs_aliquota",
971
+ "description": "Alíquota IBS do CBS utilizada",
972
+ "type": "Decimal[3.2-4]",
973
+ "required": false,
974
+ "reforma_tributaria": true,
975
+ "tag": "pAliqCBS"
976
+ },
977
+ {
978
+ "name": "cbs_valor_tributo",
979
+ "description": "Valor do Tributo da CBS",
980
+ "type": "Decimal[13.2]",
981
+ "required": false,
982
+ "reforma_tributaria": true,
983
+ "tag": "vTribCBS"
984
+ },
985
+ {
986
+ "name": "ibs_valor_estornado",
987
+ "description": "Valor do IBS a ser estornado",
988
+ "type": "Decimal[13.2]",
989
+ "required": false,
990
+ "reforma_tributaria": true,
991
+ "tag": "vIBSEstCred"
992
+ },
993
+ {
994
+ "name": "cbs_valor_estornado",
995
+ "description": "Valor do CBS a ser estornado",
996
+ "type": "Decimal[13.2]",
997
+ "required": false,
998
+ "reforma_tributaria": true,
999
+ "tag": "vCBSEstCred"
1000
+ },
1001
+ {
1002
+ "name": "valor_total_dfe",
1003
+ "description": "Valor total do documento fiscal",
1004
+ "type": "Decimal[13.2]",
1005
+ "required": false,
1006
+ "reforma_tributaria": true,
1007
+ "tag": "vTotDFe"
1008
+ },
1009
+ {
1010
+ "name": "descricao_servico",
1011
+ "description": "Descrição do serviço prestado",
1012
+ "type": "String[1-40]",
1013
+ "required": false,
1014
+ "tag": "xDescServ"
1015
+ },
1016
+ {
1017
+ "name": "quantidade",
1018
+ "description": "Descrição do serviço prestado",
1019
+ "type": "Decimal[11.4]",
1020
+ "required": false,
1021
+ "tag": "qCarga"
1022
+ },
1023
+ {
1024
+ "name": "documentos_referenciados",
1025
+ "description": "Informações dos documentos referenciados",
1026
+ "type": "Coleção[0-100]",
1027
+ "required": false,
1028
+ "collection_type": "InfoDocumentoReferenciaXML",
1029
+ "collection": {
1030
+ "object_type": "InfoDocumentoReferenciaXML",
1031
+ "object_description": "Informações dos documentos referenciados. Tag XML infDocRef.",
1032
+ "object_attributes": [
1033
+ {
1034
+ "name": "numero",
1035
+ "description": "Número",
1036
+ "type": "String[1-20]",
1037
+ "required": false,
1038
+ "tag": "nDoc"
1039
+ },
1040
+ {
1041
+ "name": "serie",
1042
+ "description": "Série",
1043
+ "type": "String[1-3]",
1044
+ "required": false,
1045
+ "tag": "serie"
1046
+ },
1047
+ {
1048
+ "name": "subserie",
1049
+ "description": "Subsérie",
1050
+ "type": "String[1-3]",
1051
+ "required": false,
1052
+ "tag": "subserie"
1053
+ },
1054
+ {
1055
+ "name": "data_emissao",
1056
+ "description": "Data de Emissão",
1057
+ "type": null,
1058
+ "required": false,
1059
+ "tag": "dEmi"
1060
+ },
1061
+ {
1062
+ "name": "valor",
1063
+ "description": "Valor Transportado",
1064
+ "type": "Decimal[13.2]",
1065
+ "required": false,
1066
+ "tag": "vDoc"
1067
+ }
1068
+ ]
1069
+ }
1070
+ },
1071
+ {
1072
+ "name": "seguros_carga",
1073
+ "description": "Informações de Seguro da Carga",
1074
+ "type": "Coleção[0-100]",
1075
+ "required": false,
1076
+ "collection_type": "InfoSeguroCargaXML",
1077
+ "collection": {
1078
+ "object_type": "InfoSeguroCargaXML",
1079
+ "object_description": "Informações do seguro de carga. Tag XML seg.",
1080
+ "object_attributes": [
1081
+ {
1082
+ "name": "responsavel_seguro",
1083
+ "description": "Responsável pelo seguro",
1084
+ "type": null,
1085
+ "required": false,
1086
+ "enum": "* +4+: Emitente do CT-e\\n* +5+: Tomador de Serviço",
1087
+ "tag": "respSeg"
1088
+ },
1089
+ {
1090
+ "name": "nome_seguradora",
1091
+ "description": "Nome da Seguradora",
1092
+ "type": "String[1-40]",
1093
+ "required": false,
1094
+ "tag": "xSeg"
1095
+ },
1096
+ {
1097
+ "name": "numero_apolice",
1098
+ "description": "Número da Apólice",
1099
+ "type": "String[1-20]",
1100
+ "required": false,
1101
+ "tag": "nApol"
1102
+ }
1103
+ ]
1104
+ }
1105
+ },
1106
+ {
1107
+ "name": "chave_cte_original_sub",
1108
+ "description": "CTe Substituição: Chave de acesso do CT-e a ser substituído (original)",
1109
+ "type": "String[44]",
1110
+ "required": false,
1111
+ "tag": "chCte"
1112
+ },
1113
+ {
1114
+ "name": "chave_cte_anulacao_sub",
1115
+ "description": "CTe Substituição: Chave de acesso do CT-e de Anulação",
1116
+ "type": "String[44]",
1117
+ "required": false,
1118
+ "tag": "refCteAnu"
1119
+ },
1120
+ {
1121
+ "name": "chave_nfe_tomador_sub",
1122
+ "description": "CTe Substituição: Chave de acesso da NF-e emitida pelo Tomador",
1123
+ "type": "String[44]",
1124
+ "required": false,
1125
+ "tag": "refNFe"
1126
+ },
1127
+ {
1128
+ "name": "cnpj_emissor_sub",
1129
+ "description": "CTe Substituição: CNPJ. Se este campo for informado <b>não</b> deve ser informado o CPF.",
1130
+ "type": "String[14]",
1131
+ "required": false,
1132
+ "tag": "CNPJ"
1133
+ },
1134
+ {
1135
+ "name": "cpf_emissor_sub",
1136
+ "description": "CTe Substituição: CPF. Se este campo for informado <b>não</b> deve ser informado o CNPJ.",
1137
+ "type": "Integer[11]",
1138
+ "required": false,
1139
+ "tag": "CPF"
1140
+ },
1141
+ {
1142
+ "name": "modelo_documento_sub",
1143
+ "description": "CTe Substituição: Modelo do Documento Fiscal",
1144
+ "type": "String[2]",
1145
+ "required": false,
1146
+ "tag": "mod"
1147
+ },
1148
+ {
1149
+ "name": "serie_documento_sub",
1150
+ "description": "CTe Substituição: Serie do documento fiscal",
1151
+ "type": "Integer[1-3]",
1152
+ "required": false,
1153
+ "tag": "serie"
1154
+ },
1155
+ {
1156
+ "name": "subserie_documento_sub",
1157
+ "description": "CTe Substituição: Subserie do documento fiscal",
1158
+ "type": "Integer[1-3]",
1159
+ "required": false,
1160
+ "tag": "subserie"
1161
+ },
1162
+ {
1163
+ "name": "numero_documento_sub",
1164
+ "description": "CTe Substituição: Número do documento fiscal",
1165
+ "type": "Integer[1-6]",
1166
+ "required": false,
1167
+ "tag": "nro"
1168
+ },
1169
+ {
1170
+ "name": "valor_documento_sub",
1171
+ "description": "CTe Substituição: Valor do documento fiscal.",
1172
+ "type": "Decimal[13.2]",
1173
+ "required": false,
1174
+ "tag": "valor"
1175
+ },
1176
+ {
1177
+ "name": "data_emissao_documento_sub",
1178
+ "description": "CTe Substituição: Data de emissão do documento fiscal.",
1179
+ "type": null,
1180
+ "required": false,
1181
+ "tag": "dEmi"
1182
+ },
1183
+ {
1184
+ "name": "chave_cte_sub",
1185
+ "description": "CTe Substituição: Chave de acesso do CT-e emitido pelo Tomador",
1186
+ "type": "Integer[44]",
1187
+ "required": false,
1188
+ "tag": "refCte"
1189
+ },
1190
+ {
1191
+ "name": "chave_cte_cancelado",
1192
+ "description": "Chave do CT-e cancelada",
1193
+ "type": "String[44]",
1194
+ "required": false,
1195
+ "tag": "chCte"
1196
+ },
1197
+ {
1198
+ "name": "numero_fatura",
1199
+ "description": "Número da fatura",
1200
+ "type": "String[1-60]",
1201
+ "required": false,
1202
+ "tag": "nFat"
1203
+ },
1204
+ {
1205
+ "name": "valor_original_fatura",
1206
+ "description": "Valor original da fatura",
1207
+ "type": "Decimal[13.2]",
1208
+ "required": false,
1209
+ "tag": "vOrig"
1210
+ },
1211
+ {
1212
+ "name": "valor_desconto_fatura",
1213
+ "description": "Valor do desconto da fatura",
1214
+ "type": "Decimal[13.2]",
1215
+ "required": false,
1216
+ "tag": "vDesc"
1217
+ },
1218
+ {
1219
+ "name": "valor_liquido_fatura",
1220
+ "description": "Valor líquido da fatura",
1221
+ "type": "Decimal[13.2]",
1222
+ "required": false,
1223
+ "tag": "vLiq"
1224
+ },
1225
+ {
1226
+ "name": "duplicatas",
1227
+ "description": "Dados das duplicatas",
1228
+ "type": "Coleção[1-100]",
1229
+ "required": false,
1230
+ "collection_type": "DadoDuplicataXML",
1231
+ "collection": {
1232
+ "object_type": "DadoDuplicataXML",
1233
+ "object_description": "Dados das duplicatas. Tag XML dup.",
1234
+ "object_attributes": [
1235
+ {
1236
+ "name": "numero",
1237
+ "description": "Número da duplicata",
1238
+ "type": "String[1-60]",
1239
+ "required": false,
1240
+ "tag": "nDup"
1241
+ },
1242
+ {
1243
+ "name": "data_vencimento",
1244
+ "description": "Data de vencimento da duplicata",
1245
+ "type": null,
1246
+ "required": false,
1247
+ "tag": "dVenc"
1248
+ },
1249
+ {
1250
+ "name": "valor",
1251
+ "description": "Valor da duplicata",
1252
+ "type": "Decimal[13.2]",
1253
+ "required": false,
1254
+ "tag": "vDup"
1255
+ }
1256
+ ]
1257
+ }
1258
+ },
1259
+ {
1260
+ "name": "chave_cte_complementado",
1261
+ "description": "Chave do CT-e complementado",
1262
+ "type": "String[44]",
1263
+ "required": false,
1264
+ "tag": "chCTe"
1265
+ },
1266
+ {
1267
+ "name": "chave_cte_original_anulado",
1268
+ "description": "CTe Anulação: Chave de acesso do CT-e original a ser anulado e substituído",
1269
+ "type": "String[44]",
1270
+ "required": false,
1271
+ "tag": "chCte"
1272
+ },
1273
+ {
1274
+ "name": "data_declaracao_anulacao",
1275
+ "description": "CTe Anulação: Data de emissão da declaração do tomador não contribuinte do ICMS",
1276
+ "type": null,
1277
+ "required": false,
1278
+ "tag": "dEmi"
1279
+ },
1280
+ {
1281
+ "name": "pessoas_autorizadas",
1282
+ "description": "Pessoas autorizadas a acessar o XML da CT-e",
1283
+ "type": "Coleção[0-10]",
1284
+ "required": false,
1285
+ "collection_type": "PessoaAutorizadaXML",
1286
+ "collection": {
1287
+ "object_type": "PessoaAutorizadaXML",
1288
+ "object_description": "Pessoa autorizada a acessar o XML da CT-e. Tag XML autXML",
1289
+ "object_attributes": [
1290
+ {
1291
+ "name": "cnpj",
1292
+ "description": "CNPJ autorizado",
1293
+ "type": "String[14]",
1294
+ "required": false,
1295
+ "tag": "CNPJ"
1296
+ },
1297
+ {
1298
+ "name": "cpf",
1299
+ "description": "CPF autorizado",
1300
+ "type": "Integer[11]",
1301
+ "required": false,
1302
+ "tag": "CPF"
1303
+ }
1304
+ ]
1305
+ }
1306
+ },
1307
+ {
1308
+ "name": "cnpj_responsavel_tecnico",
1309
+ "description": "CNPJ da pessoa a ser contatada na empresa desenvolvedora do sistema utilizado na emissão do documento fiscal eletrônico",
1310
+ "type": "String[14]",
1311
+ "required": false,
1312
+ "tag": "CNPJ"
1313
+ },
1314
+ {
1315
+ "name": "contato_responsavel_tecnico",
1316
+ "description": "Nome da pessoa a ser contatada na empresa desenvolvedora do sistema",
1317
+ "type": "String[2-60]",
1318
+ "required": false,
1319
+ "tag": "xContato"
1320
+ },
1321
+ {
1322
+ "name": "email_responsavel_tecnico",
1323
+ "description": "E-mail da pessoa a ser contatada na empresa desenvolvedora do sistema",
1324
+ "type": "String[6-60]",
1325
+ "required": false,
1326
+ "tag": "email"
1327
+ },
1328
+ {
1329
+ "name": "telefone_responsavel_tecnico",
1330
+ "description": "Telefone da pessoa a ser contatada na empresa desenvolvedora do sistema",
1331
+ "type": "String[6-14]",
1332
+ "required": false,
1333
+ "tag": "fone"
1334
+ }
1335
+ ]