← InicioFleetPay / Schema

ContraCteLoteChaveEdicao

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

valornumberOpcional

Valor del contra-CT-e (y del pago al conductor) de esta clave. En el prorrateo, convierte el lote a por documento.

minimum0.01
tp_cteinteger | nullOpcional

Finalidad de la clave (ide/tpCTe). En los endpoints de edición de lote con repasse, solo se aceptan 0 (Normal) o null; 1 (Complemento de valores) responde 422 tp_cte_complementar_sem_repasse — emita complementos en un lote propio sin repasse.

0 · 1 · null
chave_cte_complementadostring | nullOpcional

No soportada en edición de lote con repasse (422 tp_cte_complementar_sem_repasse).

minLength44
maxLength44
tipo_servicointeger | nullOpcional

ide/tpServ: 1 subcontratación, 2 redespacho, 3 redespacho intermediario (2 y 3 exigen origen y destino). null o ausente: en modificación (PATCH) conserva su tipo; en inclusión (POST .../chaves) entra como 1 sin heredar el tipo inicial del lote. 0 (normal) y 4 (multimodal) responden 422. CT-e normal: POST /fiscal/cte con prestacao.tp_serv: 0.

1 · 2 · 3 · null
regime_tributariointeger | nullOpcional

Régimen tributario de la clave: 1 Simples Nacional, 2 Simples Regular, 3 Lucro Presumido, 4 Lucro Real. null o ausente: en PATCH conserva el régimen sin volver a "Estándar" (elimine y reingrese la clave); en POST .../chaves entra con reglas "Estándar" sin heredar el régimen del lote. Cambiar el régimen en clave autorizada cancela y reemite en SEFAZ. 0, negativo, >4, decimal, booleano y texto responden 422.

1 · 2 · 3 · 4 · null
tomadorobjectOpcional

Pagador de la clave. null o ausente: en PATCH conserva el pagador sin volver al emisor de origen (elimine y reingrese la clave); en POST .../chaves entra sin pagador elegido, sin heredar el del lote. Cambiar el pagador en clave autorizada cancela y reemite en SEFAZ. cnpj sin registro o incompleto responde 422 (tomador_nao_cadastrado / tomador_cadastro_incompleto).

Definición JSON Original (Descripciones en Portugués)
{
  "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"
    }
  }
}