ALalegra
Nóminas electrónicas

Endpoint para consultar cancelaciones de nóminas electrónicas

Este endpoint permite consultar todas las cancelaciones de nómina de una empresa

get/payroll-cancellations

Request

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

Query parameters

limitinteger

Cantidad de resultados a obtener, por defecto es 50.

fromstring

Id de la cancelación a partir de la cuál se desea iniciar la consulta.

idCompanystring

Id de la empresa. Este parámetro es opcional, sino se envia este objeto, Alegra tomará la empresa asociada al token de autenticación

prefixstring

Filtrar cancelaciones por prefijo

numberstring

Filtrar cancelaciones por número, para usar este filtro es obligatorio enviar el de prefijo

status'REGISTERED' | 'WAITING_RESPONSE' | 'FAILED' | 'SENT' | 'CANCELED' | 'REPLACED'

Filtrar cancelaciones por estado

legalStatus'ACCEPTED' | 'ACCEPTED_WITH_OBSERVATIONS' | 'REJECTED'

Filtrar cancelaciones por estado legal

Response

Objeto que representa la respuesta cuando se consultan las cancelaciones de nóminas electrónicas

payroll-cancellationsEmission[] (unresolved $ref)

Array con cancelaciones de nómina

Changes

No recorded changes to this operation across all 2 revisions of this API.