valornumberOpcionalValor do contra-CT-e (e do repasse) desta chave. No rateio, converte o lote para por documento.
minimum0.01Estrutura preservada do contrato versionado da API.
Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
valornumberOpcionalValor do contra-CT-e (e do repasse) desta chave. No rateio, converte o lote para por documento.
minimum0.01tp_cteinteger | nullOpcionalFinalidade da chave (ide/tpCTe). Nos endpoints de edição de lote com repasse, apenas 0
(Normal) ou null são aceitos; 1 (Complemento de valores) responde 422
tp_cte_complementar_sem_repasse — emita complementos em um lote próprio sem repasse.
0 · 1 · nullchave_cte_complementadostring | nullOpcionalNão suportada em edição de lote com repasse (422 tp_cte_complementar_sem_repasse).
minLength44maxLength44tipo_servicointeger | nullOpcionalide/tpServ: 1 subcontratação, 2 redespacho, 3 redespacho intermediário (2 e 3
exigem origem e destino). null ou ausente: na alteração (PATCH) a chave mantém o
tipo que já tem; na inclusão (POST .../chaves) a chave nova entra como 1, sem herdar
o tipo informado na criação do lote. Não existe 0 (normal) em contra-CT-e, que sempre
referencia o CT-e de outra transportadora, nem 4 (multimodal), que a plataforma não
emite; os dois respondem 422. CT-e normal: POST /fiscal/cte com
prestacao.tp_serv: 0.
1 · 2 · 3 · nullregime_tributariointeger | nullOpcionalRegime tributário da chave, que escolhe a regra de tributação. É o NÚMERO:
1 Simples Nacional, 2 Simples Regular, 3 Lucro Presumido, 4 Lucro Real.
null ou ausente: na alteração (PATCH) a chave mantém o regime que já tem, e não há
como voltar à regra "Padrão" pela alteração (exclua a chave e inclua-a de novo sem o
campo); na inclusão (POST .../chaves) a chave nova entra sem regime, nas regras
"Padrão", sem herdar o regime informado na criação do lote. Mudar o regime de uma chave
já autorizada cancela o contra-CT-e na SEFAZ e o reemite com a regra nova, como as outras
alterações. O 0 não é opção nem "não informado": ele, número negativo ou acima de 4,
decimal com fração, booleano e texto respondem 422.
1 · 2 · 3 · 4 · nulltomadorobjectOpcionalTomador da chave. null ou ausente: na alteração (PATCH) a chave mantém o tomador que já
tem, e não há como voltar ao emitente da origem pela alteração (exclua a chave e inclua-a
de novo sem o campo); na inclusão (POST .../chaves) a chave nova entra sem tomador
escolhido, sem herdar o do lote. Trocar o tomador de uma chave já autorizada cancela o
contra-CT-e na SEFAZ e o reemite, como as outras alterações. Só o cnpj sem cadastro ou
com o cadastro incompleto responde 422 (tomador_nao_cadastrado /
tomador_cadastro_incompleto).
origemobjectOpcionaldestinoobjectOpcional{
"type": "object",
"properties": {
"valor": {
"type": "number",
"minimum": 0.01,
"description": "Valor do contra-CT-e (e do repasse) desta chave. No rateio, converte o lote para por documento."
},
"tp_cte": {
"type": [
"integer",
"null"
],
"enum": [
0,
1,
null
],
"description": "Finalidade da chave (`ide/tpCTe`). Nos endpoints de edição de lote com `repasse`, apenas `0`\n(Normal) ou `null` são aceitos; `1` (Complemento de valores) responde `422`\n`tp_cte_complementar_sem_repasse` — emita complementos em um lote próprio sem `repasse`.\n"
},
"chave_cte_complementado": {
"type": [
"string",
"null"
],
"minLength": 44,
"maxLength": 44,
"description": "Não suportada em edição de lote com `repasse` (`422 tp_cte_complementar_sem_repasse`)."
},
"tipo_servico": {
"type": [
"integer",
"null"
],
"enum": [
1,
2,
3,
null
],
"description": "`ide/tpServ`: `1` subcontratação, `2` redespacho, `3` redespacho intermediário (`2` e `3`\nexigem origem e destino). `null` ou ausente: na alteração (`PATCH`) a chave mantém o\ntipo que já tem; na inclusão (`POST .../chaves`) a chave nova entra como `1`, sem herdar\no tipo informado na criação do lote. Não existe `0` (normal) em contra-CT-e, que sempre\nreferencia o CT-e de outra transportadora, nem `4` (multimodal), que a plataforma não\nemite; os dois respondem `422`. CT-e normal: `POST /fiscal/cte` com\n`prestacao.tp_serv: 0`.\n"
},
"regime_tributario": {
"type": [
"integer",
"null"
],
"enum": [
1,
2,
3,
4,
null
],
"description": "Regime tributário da chave, que escolhe a regra de tributação. É o NÚMERO:\n`1` Simples Nacional, `2` Simples Regular, `3` Lucro Presumido, `4` Lucro Real.\n`null` ou ausente: na alteração (`PATCH`) a chave mantém o regime que já tem, e não há\ncomo voltar à regra \"Padrão\" pela alteração (exclua a chave e inclua-a de novo sem o\ncampo); na inclusão (`POST .../chaves`) a chave nova entra sem regime, nas regras\n\"Padrão\", sem herdar o regime informado na criação do lote. Mudar o regime de uma chave\njá autorizada cancela o contra-CT-e na SEFAZ e o reemite com a regra nova, como as outras\nalterações. O `0` não é opção nem \"não informado\": ele, número negativo ou acima de `4`,\ndecimal com fração, booleano e texto respondem `422`.\n"
},
"tomador": {
"$ref": "#/components/schemas/ContraCteTomador",
"description": "Tomador da chave. `null` ou ausente: na alteração (`PATCH`) a chave mantém o tomador que já\ntem, e não há como voltar ao emitente da origem pela alteração (exclua a chave e inclua-a\nde novo sem o campo); na inclusão (`POST .../chaves`) a chave nova entra sem tomador\nescolhido, sem herdar o do lote. Trocar o tomador de uma chave já autorizada cancela o\ncontra-CT-e na SEFAZ e o reemite, como as outras alterações. Só o `cnpj` sem cadastro ou\ncom o cadastro incompleto responde `422` (`tomador_nao_cadastrado` /\n`tomador_cadastro_incompleto`).\n"
},
"origem": {
"$ref": "#/components/schemas/ContraCteLoteEndereco"
},
"destino": {
"$ref": "#/components/schemas/ContraCteLoteEndereco"
}
}
}