Endpoint para emitir una nómina a la DIAN

post

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

Este endpoint permite emitir una nómina electrónica a la DIAN.

Recuerda visitar previamente las guías de Inicio y la guía de Habilitación en la DIAN - Nómina Electronica

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Objeto con la información de la nómina electrónica

company

object

Objeto con información de la empresa con la que se desea emitir la nómina electrónica. Este atributo es opcional, sino se envia este objeto, Alegra tomará la compañía asociada al token de autenticación

prefix

string

length ≥ 1

Prefijo de la nómina electrónica

number

double

required

Número de la nómina electrónica

governmentData

object

required

Objeto que contiene la información de la nómina electrónica en formato JSON según el estándar de la DIAN

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 cuando se envía una nómina electrónica 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