Eventos electrónicos

Endpoint para emitir un evento relacionado a una factura electrónica

Changed on

Endpoint para emitir un evento relacionado a una factura electrónico a partir de los datos recibidos en la petición

post/events

Request

  • Base URL
    https://sandbox-api.alegra.com/e-provider/col/v1
  • URL
    https://sandbox-api.alegra.com/e-provider/col/v1/events
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring uuid
Example:550e8400-e29b-41d4-a716-446655440000

Llave que identifica una operación lógica, generada por el integrador. Cuando se envía, la API garantiza que la operación se ejecute a lo sumo una vez para esa llave: un reintento tras un timeout, un error de red o un fallo del cliente devuelve el resultado de la primera ejecución en lugar de emitir un segundo documento.

Debe ser un UUID versión 4 en su forma canónica con guiones. Cualquier otro valor se rechaza con 400. Se acepta en mayúsculas o minúsculas: la API normaliza a minúsculas, de modo que la misma llave escrita distinto sigue siendo la misma operación.

Genera una llave nueva por cada operación lógica, guárdala junto con la operación y reutilízala en todos los reintentos de esa misma operación. Reutilizar una llave con un cuerpo diferente devuelve 422.

La respuesta almacenada refleja el resultado de la petición original y no se actualiza después: para conocer el estado actual del documento usa el endpoint GET o el webhook.

Las llaves se conservan 7 días.

Request body

numberstring required

Número del evento que se emite, el valor es alfanumérico y único por evento dentro de la misma compañia

type'030' | '031' | '032' | '033' | '034' required

Código del tipo de evento, este elemento acepta una de las siguientes opciones:<br>030 Acuse de recibo de Factura Electrónica de Venta<br>031 Reclamo de la Factura Electrónica de Venta<br>032 Recibo del bien o prestación del servicio<br>033 Aceptación expresa<br>034 Aceptación Tácita<br><i>Campo oficial DIAN <ResponseCode></i>

claimCode'01' | '02' | '03' | '04'

Código motivo de rechazo, este elemento acepta una de las siguientes opciones:<br>01 Documento con inconsistencias<br>02 Mercancía no entregada<br>03 Mercancía entregada parcialmente<br>04 Servicio no prestado<br><i>Campo oficial DIAN <@listID en ResponseCode></i>

notesstring[]

Información adicional que se quiera agregar en el evento<br><i>Campo oficial DIAN <Note></i>

Response

Objeto que representa la respuesta de la API cuando se emite un evento electronico a la DIAN

Changes

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status