GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

Create a payroll digest batch

post
https://api.gusto-demo.com/v1/payroll_digests

Triggers an asynchronous computation of payroll digest data (statuses, blockers, pay periods, totals) across up to 25 companies that the partner is mapped to.

The batch is processed asynchronously. Use the returned batch UUID to poll GET /v1/payroll_digests/{payroll_digest_uuid} for status and results.

Idempotency is scoped per (partner, idempotency_key). A duplicate POST with the same idempotency_key returns a 409 Conflict referencing the existing batch UUID — no duplicate computation occurs.

📘 System Access Authentication

This endpoint uses the Bearer Auth scheme with the system-level access token in the HTTP Authorization header

scope: payroll_digests:write

Body Params
uuid
required

A partner-generated unique identifier to ensure idempotency of the batch request. Scoped per partner.

string
enum
required

The action to perform on the batch.

Allowed:
batch
array of objects
required
length between 1 and 25

Array of companies to fetch payroll digest data for. Maximum 25 companies per request.

batch*
string
enum
required

The type of entity to look up.

Allowed:
uuid
required

The UUID of a company that the partner is mapped to. Companies that the partner is not authorized to access will appear in the response's exclusions array.

Headers
string
enum
Defaults to 2026-02-01

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Allowed:
Responses

Updated about 3 hours ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago