← InicioFleetPay / Schema

EmittedCte

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.

idstringObligatorio

Clave de acceso del CT-e; es el identificador público del recurso.

pattern"^\\d{44}$"

access_keystringObligatorio

pattern"^\\d{44}$"

document_idinteger | nullOpcional

Identificador interno del documento creado en FleetPay.

service_datestring | null · dateOpcional

Fecha de emisión del CT-e, leída de ide/dhEmi.

service_costnumber | nullOpcional

Importe total del servicio, leído de vPrest/vTPrest.

shipperobjectOpcional

Tomador del servicio de transporte, identificado mediante el código toma del XML.

carrierobjectOpcional

Tu transportista — el elemento emit del XML.

nfe_access_keystring | nullOpcional

Clave de la NF-e de la carga transportada, cuando el CT-e hace referencia a una.

first_receptionbooleanObligatorio

true en la primera entrega de este documento (respuesta 201). En los reenvíos es false y no se reprocesa nada.

Definición JSON Original (Descripciones en Portugués)

{
  "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"
    }
  }
}