← InícioFleetPay / Schema

EmittedCte

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

idstringObrigatório

Chave de acesso do CT-e; é o identificador público do recurso.

pattern"^\\d{44}$"

access_keystringObrigatório

pattern"^\\d{44}$"

document_idinteger | nullOpcional

Identificador interno do documento criado na FleetPay.

service_datestring | null · dateOpcional

Data de emissão do CT-e, lida de ide/dhEmi.

service_costnumber | nullOpcional

Valor total da prestação, lido de vPrest/vTPrest.

shipperobjectOpcional

O TOMADOR do frete, resolvido pelo código toma do XML.

carrierobjectOpcional

A sua transportadora — o emit do XML.

nfe_access_keystring | nullOpcional

Chave da NF-e transportada, quando o CT-e referencia uma.

first_receptionbooleanObrigatório

true quando esta foi a primeira entrega deste documento (resposta 201). Nos reenvios é false e nada é reprocessado.

Definição JSON Completa

{
  "type": "object",
  "required": [
    "id",
    "access_key",
    "first_reception"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^\\d{44}$",
      "description": "Chave de acesso do CT-e; é o identificador público do recurso."
    },
    "access_key": {
      "type": "string",
      "pattern": "^\\d{44}$"
    },
    "document_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Identificador interno do documento criado na FleetPay."
    },
    "service_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date",
      "description": "Data de emissão do CT-e, lida de `ide/dhEmi`."
    },
    "service_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "Valor total da prestação, lido de `vPrest/vTPrest`."
    },
    "shipper": {
      "type": "object",
      "description": "O TOMADOR do frete, resolvido pelo código `toma` do XML.",
      "properties": {
        "document": {
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "carrier": {
      "type": "object",
      "description": "A sua transportadora — o `emit` do XML.",
      "properties": {
        "document": {
          "type": [
            "string",
            "null"
          ]
        }
      }
    },
    "nfe_access_key": {
      "type": [
        "string",
        "null"
      ],
      "description": "Chave da NF-e transportada, quando o CT-e referencia uma."
    },
    "first_reception": {
      "type": "boolean",
      "description": "`true` quando esta foi a primeira entrega deste documento (resposta `201`). Nos\nreenvios é `false` e nada é reprocessado.\n"
    }
  }
}