API Endpoints

Endpoint para reemplazar/ajustar una nómina electrónica

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

Este endpoint permite reemplazar/ajustar la nómina electrónica enviada como parámetro. Sólo se puede reemplazar una nómina aceptada por la DIAN (legalStatus ACCEPTED o ACCEPTED_WITH_OBSERVATIONS): una nómina rechazada no se reemplaza, se corrige y se envía de nuevo (AEP2015). Mientras otra anulación o reemplazo de la misma nómina esté en proceso, la solicitud se rechaza con AEP2016; una anulación o un reemplazo rechazado por la DIAN no bloquea un nuevo intento.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Id de la nómina electrónica que se desea reemplazar/ajustar

Body Params

Objeto con la información de la nómina electrónica que reemplazará a la anterior

string
required
length ≥ 1

Prefijo de la nómina electrónica

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

Updated 4 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago