Preparar la próxima planilla o un pago extra, aguinaldo o Bono 14

POST

https://app.recurrente.com/api/payroll_runs

POST

/api/payroll_runs

curl -X POST https://app.recurrente.com/api/payroll_runs \
     -H "X-SECRET-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "id": "pr_ab12cd34",
  "account_id": "string",
  "kind": "regular",
  "label": "Planilla del 15 de noviembre",
  "status": "draft",
  "pay_on": "2023-01-15",
  "period_start_on": "2023-01-15",
  "period_end_on": "2023-01-15",
  "totals": [
    {
      "currency": "string",
      "amount_in_cents": 1
    }
  ],
  "confirmed_at": "2024-01-15T09:30:00Z",
  "reviewed_at": "2024-01-15T09:30:00Z",
  "lines": [
    {
      "member_id": "string",
      "member_name": "string",
      "status": "pending",
      "amount_in_cents": 1,
      "currency": "string",
      "days_worked": 1,
      "extra_amount_in_cents": 1,
      "transfer_id": "string",
      "items": [
        {
          "kind": "earning",
          "code": "igss_laboral",
          "label": "IGSS laboral",
          "amount_in_cents": 1,
          "adjustment_id": "string"
        }
      ]
    }
  ],
  "created_at": "2024-01-15T09:30:00Z"
}

Recurrente prepara cada planilla regular dos días hábiles antes de su día de pago. Con kind: regular (el valor por defecto) la preparas ahora para el próximo día de pago; si ya existe, la recibes a ella. extra, aguinaldo y bono14 se preparan para hoy, fuera del calendario: un pago extra a todo el equipo o, con member_id, a una sola persona. Una planilla nueva queda en draft hasta que la pagues.

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.

Request

This endpoint expects an object.

kindenumOptionalDefaults to regular

Allowed values:

member_idstringOptional

Solo con kind: extra, para pagarle a una sola persona.

Response

La planilla en borrador

idstringOptional

account_idstringOptional

kindenumOptional

Allowed values:

labelstringOptional

statusenumOptional

draft hasta que la pagas; in_review cuando es la primera de la cuenta y espera la revisión de Recurrente; paid; cancelled.

Allowed values:

pay_ondateOptional

period_start_ondateOptional

period_end_ondateOptional

totalslist of objectsOptional

Por moneda: en un borrador, lo que pagarla tomará del balance; ya confirmada, lo que envió.

confirmed_atdatetime or nullOptional

reviewed_atdatetime or nullOptional

lineslist of objectsOptional

created_atdatetimeOptional

Errors

422

Unprocessable Entity Error