← HomeFleetPay / Schema

EmittedCte

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

idstringRequired

CT-e access key; it is the resource's public identifier.

pattern"^\\d{44}$"

access_keystringRequired

pattern"^\\d{44}$"

document_idinteger | nullOptional

Internal identifier of the document created in FleetPay.

service_datestring | null · dateOptional

CT-e issue date, read from ide/dhEmi.

service_costnumber | nullOptional

Total service amount, read from vPrest/vTPrest.

shipperobjectOptional

Freight service payer, resolved using the XML toma code.

carrierobjectOptional

Your carrier — the XML emit element.

nfe_access_keystring | nullOptional

Key of the NF-e covering the cargo, when the CT-e references one.

first_receptionbooleanRequired

true for the first delivery of this document (response 201). On subsequent deliveries it is false and nothing is reprocessed.

Original JSON Definition (Portuguese Descriptions)

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