Skip to navigation
Referencia APIPayroll

Actualizar a una persona de la planilla

Cambia solo lo que envíes. Las planillas en borrador se recalculan con el nuevo sueldo, tipo o moneda. Un phone_number nuevo es otra persona a quien pagar: le llega la invitación a ese número.

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

idstringRequired

Request

This endpoint expects an object.
namestringOptional
phone_numberstringOptional

Ocho dígitos se leen como un número de Guatemala.

emailstringOptional
job_titlestringOptional
worker_typeenumOptionalDefaults to empleado
Allowed values:
amount_in_centsintegerOptional
currencystringOptionalDefaults to GTQ
precapi_enrolledbooleanOptional

Solo para domestica. Por defecto, inscrita.

started_ondateOptional

Response

La persona actualizada
idstringOptional
account_idstringOptional
statusenumOptional
Allowed values:
namestringOptional
phone_numberstringOptional

Su WhatsApp, con código de país. Ahí le llegan la invitación, cada pago y su boleta.

emailstring or nullOptional
job_titlestring or nullOptional
worker_typeenumOptional

empleado (relación laboral: IGSS, ISR, bonificación incentivo y prestaciones), servicios (servicios profesionales, sin descuentos), temporal (pagado por día trabajado) o domestica (trabajadora de casa particular: PRECAPI en lugar del IGSS, sin ISR).

Allowed values:
amount_in_centsintegerOptional

Lo que se le paga según su tipo: el salario mensual bruto de un empleado o una trabajadora de casa, los honorarios por día de pago de servicios profesionales, el pago por día trabajado de un temporal.

currencystringOptional

Quetzales para todo tipo salvo servicios.

precapi_enrolledbooleanOptional
Si es una trabajadora de casa inscrita en PRECAPI.
started_ondate or nullOptional
ended_ondate or nullOptional

Su último día, cuando se prepara su liquidación.

joinedbooleanOptional
Si ya recibe en su propia cuenta de Recurrente. Mientras no, cada pago la espera en su WhatsApp.
invited_atdatetime or nullOptional
created_atdatetimeOptional

Errors

422
Unprocessable Entity Error