API Endpoints
Contáctanos

Endpoint para anular una nómina electrónica

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

Este endpoint permite anular la nómina electrónica enviada como parámetro

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 anular

Body Params

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

string
required
length ≥ 1

Prefijo de la anulación de la nómina electrónica

string
required

Número consecutivo de la anulación de la nómina electrónica

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 3 months ago

Did this page help you?
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 3 months ago

Did this page help you?