payment runs

Payment runs represent the execution of payroll processing for a specific payroll period. Each payment run tracks when it was created and closed/authorised

Get payment runs for a payroll

Retrieves payment runs for a specified payroll. By default, returns payment runs for the current payroll period. A different period can be specified using the payrollPeriod query parameter.

SecuritybearerAuth

Request

path Parameters

payrollGUID

required

string <uuid>

The unique identifier (GUID) of the payroll

Example: 7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5

query Parameters

payrollPeriod

integer

Optional payroll period ID to filter payment runs. If not provided, returns payment runs for the current period.

Example: payrollPeriod=12345

Responses

200

Payment Runs Response - Array

get/payrolls/{payrollGUID}/paymentruns

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payrolls/7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5/paymentruns"
},
"data": [{"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "paymentRuns",
"attributes": {"payrollPeriodId": 12345,
"payrollName": "Monthly Payroll",
"payrollGUID": "7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5",
"taxPeriod": "2025/01",
"createdDateTime": "2025-01-15T10:30:00Z",
"closedDateTime": "2025-01-20T14:45:00Z"
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/payrolls/7fcba8e6-397f-4be2-a9f0-8d53fcf48ab5/paymentruns/12345"
}
}
]
}

➔ Next to payment run details