GuidesAPI ReferenceChangelogAPI StatusAPI PolicyGusto Security
API Reference

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. The returned creation_token is a required parameter in order to create the contractor payment group.

scope: payrolls:read

Path Params
string
required

The UUID of the company

Body Params
contractor_payments
array of objects
required
contractor_payments*
date

Date when payments should be processed

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 6 days 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 days ago