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

post

https://sandbox-api.alegra.com/e-provider/col/v1/events

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Objeto con la información requerida para el emisión del evento

number

string

required

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

type

string

enum

required

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

Allowed:

company

object

Detalles de la organización que emite el evento, en caso de omitir este objeto se usará la compañia principal asociada al usuario

associatedDocument

object

required

Objecto que contiene la información del documento de referencia

receiverParty

object

Información del receptor del evento
Campo oficial DIAN <ReceiverParty>

issuerParty

object

Persona o empresa que recibe la factura y el bien o servicio prestado. Obligatoriedad: Campo opcional, excepto en los siguientes casos donde es requerido:

030: Acuse de recibo de Factura Electrónica de Venta
032: Recibo del bien o prestación del servicio

Campo oficial DIAN <IssuerParty>

claimCode

string

enum

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

Allowed:

notes

array of strings

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

notes

object

Objeto para enviar un email de recepción de documento

Headers

Idempotency-Key

uuid

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

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.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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

400Objeto que representa una respuesta de error por validaciones

404Objeto que representa una respuesta de error por qué no se ha encontrado el recurso al que se intenta acceder

500Objeto que representa una respuesta de error por qué ha ocurrido un error interno en el sistema