Saltar al contenido principal

Anular un dte

Este endpoint está diseñado para invalidar cualquier tipo de DTE. Para utilizarlo, necesitas realizar un POST request a /dte/invalidate, incluyendo la información necesaria en el cuerpo de la solicitud.

Detalles Técnicos

  • HTTP Method: POST
  • URL: https://api.facturallama.com/dte/invalidate
  • Headers:
    • X-API-Key: Tu API key.
    • X-API-Version: La versión de la API que estás utilizando.
    • Content-Type: application/json

Request Body

A continuación se presenta una descripción detallada de las propiedades que puedes incluir en el cuerpo de tu solicitud, así como las validaciones y formatos que debes tener en cuenta.

Propiedades Principales

PropiedadTipoValidaciónDescripción
dteIdUUIDObligatorio.Identificador único del DTE que sera invalidado.
dteReplaceIdUUIDOpcional.Identificador único del DTE que reemplazara al DTE invalidado. Este DTE debe tener un status de APPROVED.
branchOfficeObjectOpcional. Ver detalles.Datos de la sucursal y punto de venta.
reasonStringOpcional. Máximo: 250 caracteresDescripción de la razón de la invalidación.
managerObjectOpcional. Ver detalles.Persona responsable de la invalidación del documento.
requesterObjectOpcional. Ver detalles.Persona que solicita la invalidación del documento.

Propiedades Anidadas

branchOffice
PropiedadTipoValidaciónDescripción
mhCodeStringObligatorio. Debe ser un string de exactamente 4 caracteres.Identificador de la sucursal.
posNumberNumberObligatorio. Debe ser un número positivo. El valor no puede ser mayor a 999.Identificador del punto de venta.
manager
PropiedadTipoValidaciónDescripción
nameStringObligatorio. Máximo: 150 caracteres.Nombre de la tercera parte.
identificationDocumentObjectObligatorio. Ver detalles.Documento de identificación de la tercera parte.
manager.identificationDocument
PropiedadTipoValidaciónDescripción
typeEnumObligatorio.Tipo de documento. Valores: NIT, DUI, PASAPORTE, CARNET_RESIDENTE, OTRO.
numberStringObligatorio.Número del documento de identificación. DUI: #########; NIT: ##############
requester
PropiedadTipoValidaciónDescripción
nameStringObligatorio. Máximo: 150 caracteres.Nombre de la tercera parte.
identificationDocumentObjectObligatorio. Ver detalles.Documento de identificación de la tercera parte.
requester.identificationDocument
PropiedadTipoValidaciónDescripción
typeEnumObligatorio.Tipo de documento. Valores: NIT, DUI, PASAPORTE, CARNET_RESIDENTE, OTRO.
numberStringObligatorio.Número del documento de identificación. DUI: #########; NIT: ##############

Response Body

Una vez procesada tu solicitud, el servidor responderá con un conjunto de datos que confirmarán la invalidación del dte o, en caso de error, proporcionarán detalles sobre lo que salió mal.

PropiedadTipoDescripción
idUUIDIdentificador único del evento de invalidación del DTE.
companyIdUUIDIdentificador único de la empresa.
environmentEnumAmbiente. Valores: TEST, LIVE.
typeEnumTipo de documento fiscal.
versionIntegerVersión del evento de invalidación del DTE.
statusEnumEstado del evento de invalidación del DTE. Valores: APPROVED, REJECTED.
mhResponseObjectRespuesta del API del Ministerio de Hacienda.
generatedAtTimestampFecha y hora de creación del DTE asignado manualmente.
createdAtTimestampFecha y hora de creación del DTE.
updatedAtTimestampFecha y hora de creación del DTE.

Ejemplo

Copia y pega el código en una terminal o en tu editor de código favorito. Reemplaza <Tu API Key> con la API key que generaste en el paso anterior.

curl --location 'https://api.facturallama.com/dte/invalidate' \
--header 'X-API-Version: 1' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <API Key>' \
--data-raw '{
"dteId": "<TAX DOCUMENT UUID>"
}'