Skip to navigation
Referencia APIPayroll

Darle un bono o un descuento a una persona

category decide si es bono (Bono, Comisión, Horas extra, Viáticos) o descuento (Anticipo, Préstamo, Descuento). Con frequency: once se aplica solo en el día de pago applies_on; con every_payday, en cada día de pago desde esa fecha. Los viáticos no cuentan como salario para el IGSS ni el ISR. Las planillas en borrador de la persona se recalculan.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

payroll_member_idstringRequired

Request

This endpoint expects an object.
categoryenumRequired
reasonstringRequired
amount_in_centsintegerRequired
applies_ondateRequired

El día de pago en que se aplica (o desde el que se aplica).

currencystringOptional
Por defecto, la moneda de la persona.
frequencyenumOptionalDefaults to once
Allowed values:

Response

Bono o descuento agregado
idstringOptional
member_idstringOptional
statusenumOptional
Allowed values:
kindenumOptional
Allowed values:
categorystringOptional
reasonstringOptional
amount_in_centsintegerOptional
currencystringOptional
applies_ondateOptional
frequencyenumOptional
Allowed values:
created_atdatetimeOptional

Errors

422
Unprocessable Entity Error