Planilla preparada | Documentación API de Recurrente

{
  "event_type": "payroll_run.create",
  "id": "pr_ab12cd34",
  "status": "draft",
  "api_version": "2024-04-24",
  "account_id": "ac_ab12cd34",
  "kind": "regular",
  "label": "Planilla del 15 de noviembre",
  "pay_on": "2026-11-15",
  "period_start_on": "2026-11-01",
  "period_end_on": "2026-11-15",
  "totals": [
    {
      "currency": "GTQ",
      "amount_in_cents": 242685
    }
  ],
  "lines": [
    {
      "member_id": "pm_ab12cd34",
      "member_name": "Ana Lucía Morales",
      "status": "pending",
      "amount_in_cents": 242685,
      "currency": "GTQ",
      "items": [
        {
          "kind": "earning",
          "code": "salario",
          "label": "Salario",
          "amount_in_cents": 255000
        },
        {
          "kind": "deduction",
          "code": "igss_laboral",
          "label": "IGSS laboral",
          "amount_in_cents": 12315
        }
      ]
    }
  ],
  "created_at": "2026-11-11T08:00:00Z"
}

Se emite cuando se prepara una planilla: Recurrente la prepara dos días hábiles antes de cada día de pago, o la prepara la API o el panel. Queda en draft hasta que la pagas con POST /payroll_runs/{payroll_run_id}/approval.

Payload

The payload of this webhook request is an object.

event_typestringRequiredformat: "^[a-z0-9_.-]+$"

Tipo exacto del evento enviado por Recurrente.

idstringRequired

statusenumRequired

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:

api_versionstringRequired

connectedboolean or nullOptional

Presente como true cuando el evento proviene de una cuenta conectada.

account_idstring or nullOptional

ID de la cuenta conectada que originó el evento.

kindenumOptional

Allowed values:

labelstringOptional

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

Response

200

Tu endpoint respondió exitosamente.