Cerrar un MDF-e

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

POST/fiscal/mdfe/{mdfe_uuid}/encerramento

closeMdfeBase 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.

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

mdfe_uuidpath · stringObligatorio

UUID público del MDF-e.

Restricciones

{
  "type": "string",
  "format": "uuid"
}

Cuerpo de la Solicitud

Obligatorio

`application/json`

MdfeClosingInput ↗

closing_city_codestringObligatorio

pattern"^\\d{7}$"

closing_citystring | nullOpcional

minLength2

maxLength60

closing_statestring | nullOpcional

minLength2

maxLength2

closed_onstring · dateObligatorio

Fecha de calendario igual o anterior a la fecha actual.

Respuestas

200 Respuesta HTTP

Operación de MDF-e concluida.

`application/json`

MdfeOperationEnvelope ↗

dataobjectObligatorio

MdfeOperationData ↗

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.

422 Respuesta HTTP

Payload inválido, requisito pendiente o regla de negocio.

`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.

503 Respuesta HTTP

No fue posible confirmar u obtener el resultado en este momento. Consulta antes de repetir comandos.

`application/json`

ErrorEnvelope ↗

errorobjectObligatorio

ErrorBody ↗

Headers

X-Request-Id

Identificador de correlación de la llamada.

Definición Completa de la Operación

{
  "tags": [
    "MDF-e"
  ],
  "summary": "Encerrar MDF-e",
  "operationId": "closeMdfe",
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/MdfeClosingInput"
        }
      }
    }
  },
  "responses": {
    "200": {
      "$ref": "#/components/responses/MdfeOperationOk"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    },
    "403": {
      "$ref": "#/components/responses/Forbidden"
    },
    "404": {
      "$ref": "#/components/responses/NotFound"
    },
    "422": {
      "$ref": "#/components/responses/ValidationOrBusinessRuleFailed"
    },
    "429": {
      "$ref": "#/components/responses/RateLimited"
    },
    "500": {
      "$ref": "#/components/responses/InternalError"
    },
    "503": {
      "$ref": "#/components/responses/ServiceUnavailable"
    }
  },
  "method": "POST",
  "path": "/fiscal/mdfe/{mdfe_uuid}/encerramento",
  "parameters": [
    {
      "$ref": "#/components/parameters/MdfeUuid"
    }
  ]
}