GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference
These docs are for v2024-03-01. Click to read the latest docs for v2026-02-01.

Preview a contractor payment group

post
https://api.gusto-demo.com/v1/companies//contractor_payment_groups/preview

Preview a group of contractor payments. Request will validate inputs and return preview of the contractor payment group including the expected debit_date. Uuid will be null in the response.

scope: payrolls:read

Path Params
string
required

The UUID of the company

Body Params
date
required

The payment check date

string

Optional token used to make contractor payment group creation idempotent. If provided, string must be unique for each group you intend to create.

contractor_payments
array of objects
required
contractor_payments*
Headers
string
enum
Defaults to 2024-03-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

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Updated 6 months 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 6 months ago