Preview a contractor payment group

POST {{baseUrl}}/v1/companies/:company_id/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

Request Body

{"check_date"=>"<date>", "contractor_payments"=>[{"contractor_uuid"=>"<string>", "payment_method"=>"Direct Deposit", "wage"=>"<number>", "hours"=>"<number>", "bonus"=>"<number>", "reimbursement"=>"<number>"}, {"contractor_uuid"=>"<string>", "payment_method"=>"Direct Deposit", "wage"=>"<number>", "hours"=>"<number>", "bonus"=>"<number>", "reimbursement"=>"<number>"}], "creation_token"=>"<string>"}

HEADERS

Key	Datatype	Description
`X-Gusto-API-Version`	string	Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
`Content-Type`	string
`Accept`	string

RESPONSES

status: OK

{&quot;uuid&quot;:&quot;nil&quot;,&quot;company_uuid&quot;:&quot;c54046f7-1be4-4c54-8194-f4842c30c86d&quot;,&quot;check_date&quot;:&quot;2024-05-07&quot;,&quot;debit_date&quot;:&quot;2024-05-01&quot;,&quot;status&quot;:&quot;Unfunded&quot;,&quot;creation_token&quot;:&quot;nil&quot;,&quot;contractor_payments&quot;:[{&quot;uuid&quot;:&quot;nil&quot;,&quot;contractor_uuid&quot;:&quot;2e6d0970-31bf-47ce-bdb4-713e4207ecf4&quot;,&quot;bonus&quot;:&quot;0.0&quot;,&quot;hours&quot;:&quot;40.0&quot;,&quot;hourly_rate&quot;:&quot;18.0&quot;,&quot;may_cancel&quot;:false,&quot;payment_method&quot;:&quot;Direct Deposit&quot;,&quot;reimbursement&quot;:&quot;75.0&quot;,&quot;status&quot;:&quot;Unfunded&quot;,&quot;wage&quot;:&quot;0.0&quot;,&quot;wage_type&quot;:&quot;Hourly&quot;,&quot;wage_total&quot;:&quot;720.0&quot;},{&quot;uuid&quot;:&quot;nil&quot;,&quot;contractor_uuid&quot;:&quot;a975fda0-fcf5-469a-a5fd-06e43d1cd99d&quot;,&quot;bonus&quot;:&quot;0.0&quot;,&quot;hours&quot;:&quot;0.0&quot;,&quot;hourly_rate&quot;:&quot;0.0&quot;,&quot;may_cancel&quot;:false,&quot;payment_method&quot;:&quot;Check&quot;,&quot;reimbursement&quot;:&quot;0.0&quot;,&quot;status&quot;:&quot;Unfunded&quot;,&quot;wage&quot;:&quot;1500.0&quot;,&quot;wage_type&quot;:&quot;Fixed&quot;,&quot;wage_total&quot;:&quot;1500.0&quot;}],&quot;totals&quot;:{&quot;debit_amount&quot;:&quot;2295.0&quot;,&quot;wage_amount&quot;:&quot;2220.0&quot;,&quot;reimbursement_amount&quot;:&quot;75.0&quot;}}