Consultar un CT-e recibido

Parámetros, estructura de datos y respuestas del contrato versionado.

GET/fiscal/cte-subcontratacao/{access_key}

getInboundCteBase de Pruebas: https://api.fleetpay.site/v1

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

Documento recibido consultado por clave de acceso, con las direcciones completas de las partes, que se omiten en los listados para reducir el tamaño de cada página.

Autenticación

[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]

La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

access_keypath · stringObligatorio

Clave de acceso del CT-e recibido, 44 dígitos.

Restricciones

{
  "type": "string",
  "pattern": "^\\d{44}$"
}

Respuestas

200 Respuesta HTTP

CT-e recibido encontrado.

`application/json`

InboundCteEnvelope ↗

dataobjectObligatorio

InboundCte ↗

environmentobjectObligatorio

Environment ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

401 Respuesta HTTP

Clave de API FleetPay ausente o no válida.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

403 Respuesta HTTP

Ámbito fiscal deshabilitado en la clave, o clave sin transportista activo.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

404 Respuesta HTTP

Recurso no encontrado en el tenant autenticado.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

429 Respuesta HTTP

Límite por transportista excedido.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Retry-After

Segundos hasta un nuevo intento.

500 Respuesta HTTP

Fallo interno sin detalles de las integraciones operativas.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación

{
  "tags": [
    "CT-e de subcontratação"
  ],
  "summary": "Consultar um CT-e recebido",
  "description": "O documento recebido pela chave de acesso, com os endereços completos das partes — que a\nlistagem não traz para não engordar cada página.\n",
  "operationId": "getInboundCte",
  "parameters": [
    {
      "$ref": "#/components/parameters/InboundCteAccessKey"
    }
  ],
  "responses": {
    "200": {
      "$ref": "#/components/responses/InboundCteOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    }
  },
  "method": "GET",
  "path": "/fiscal/cte-subcontratacao/{access_key}"
}