Download a payroll export's file
Returns the payroll file as it was made (its SHA-256 is on the payroll export), or, with another format or
layout, a copy made from its lines. The long layout has a row per person and pay code: employee_number,
name, department, site, period_start, period_end, pay_code, category, units, unit,
multiplier, correction, approved_by, approved_at, export_id. The wide layout has a row per person and a
column per pay code. An Excel file also has the other layout, each day's figures and breaks, and notes.
Scope: attendance:payroll · Plan: Pro and Enterprise, with the payroll export; in test mode too, the payroll export needs Pro.
AuthorizationBearer <token>Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
Scope: attendance:payroll
payroll_export_id*stringThe payroll export's ID.
^payroll_export_[0-7][0-9a-hjkmnp-tv-z]{25}$"payroll_export_01m5c4d5e6f7g8h9jkmnpqrstv"format?stringAnother format than the file was made in: a copy made from its lines.
"csv""xlsx"layout?stringAnother layout: a copy made from its lines.
"long""wide"The file, with Content-Disposition: attachment and its name.
response?filebinarycurl -X GET 'https://api.agoo.ardent.africa/v1/payroll-exports/payroll_export_01m5c4d5e6f7g8h9jkmnpqrstv/file'"string"Get a payroll export GET
Returns one payroll export. **Scope:** `attendance:payroll` · **Plan:** Pro and Enterprise, with the payroll export; in test mode too, the payroll export needs Pro.
List roster shifts GET
Returns roster shifts by day: drafts (not yet seen by staff), published shifts, and published shifts removed since (`cancelled`). Filter by site, person, open or not, state and days. A published shift with a change waiting for the next publish shows its published values and `pending_change: true`; one to be removed at the next publish shows `removing: true`. An open shift (`open: true`, `person_id` null) is one no one works yet: once published, staff who can take it may ask for it in Agoo Workspace. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.