POST

Registrar un pago de nómina

Scope:accounting:payrolls.write

https://api.holded.com/api/v2/payslips/{payslipId}/payments

Registra un pago sobre una nómina existente, descontando el importe de su saldo pendiente. Se permiten pagos parciales (un `amount` inferior al total pendiente). Los tres campos del cuerpo son opcionales: si se omite `amount` se usa el saldo pendiente completo, y si se omite `date` se usa la propia fecha de pago de la nómina (el inicio del mes siguiente al fin del periodo liquidado, o la fecha de fin de contrato si cae dentro de ese periodo). `bank_account_id` vincula el movimiento a una cuenta de tesorería, y debe pertenecer a esta cuenta. Las nóminas son lo que vende la gema de Recursos Humanos, así que este endpoint la exige activa en la cuenta y responde 402 si no lo está. Una nómina no es un registro salarial: si pides aquí el id de un registro salarial, la respuesta es 404 indicando el recurso que sí lo sirve.

Parámetros

Parámetros de ruta

payslipIdstringobligatorio

ID de la nómina (ObjectId hexadecimal de 24 caracteres)

Cuerpo de la petición

object

amountstring | null

Importe del pago. Si se omite, se usa el saldo pendiente completo

datestring<date> | null

Fecha del pago en formato ISO 8601. Si se omite, se usa la fecha de pago de la nómina

bank_account_idstring | null

Identificador de la cuenta de tesorería a la que se vincula el pago

Petición

python

import requests

url = "https://api.holded.com/api/v2/payslips/507f1f77bcf86cd799439011/payments"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "amount": "1450.00",
    "date": "2024-01-15",
    "bank_account_id": "string"
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Respuestas

Respuesta

json

{
  "payment_status": "PAID",
  "payment_pending": "0.00"
}

Respuestas exitosas

201Pago registradoapplication/json

object

payment_statusstring | null

Null when the payslip could not be re-read after the payment was registered — the write itself still succeeded.

Enum:PENDINGPAIDPARTIALLY_PAID

payment_pendingstring | null

Remaining pending balance after this payment. Null when the payslip could not be re-read after the payment was registered — the write itself still succeeded.

Respuestas de error

400El identificador de la nómina, el importe, la fecha o bank_account_id no son válidosapplication/json

401API key inválida o no proporcionadaapplication/json

402La gema de Recursos Humanos no está activa para esta cuentaapplication/json

object

typestring

titlestring

statusinteger

detailstring

403Permisos insuficientesapplication/json

404Nómina no encontradaapplication/json

409El periodo contable de la fecha de pago está cerrado, u otro pago se está registrando para esta nóminaapplication/json

object

typestring

titlestring

statusinteger

detailstring

422No se ha podido registrar el pago, o bank_account_id no pertenece a esta cuentaapplication/json

429Límite de solicitudes excedidoapplication/json