Create a new external payroll for a company
POST {{baseUrl}}/v1/companies/:company_uuid/external_payrolls
Creates a new external payroll for the company.
scope: external_payrolls:write
Request Body
{"check_date"=>"<string>", "payment_period_start_date"=>"<string>", "payment_period_end_date"=>"<string>"}
HEADERS
| Key | Datatype | Required | 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
{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","company_uuid":"bcb305b0-2855-4025-8d22-e484a9e6b7c9","check_date":"2022-06-03","payment_period_start_date":"2022-05-15","payment_period_end_date":"2022-05-30","status":"unprocessed","external_payroll_items":[{"employee_uuid":"44f7cba9-7a3d-4f08-b7bd-6fcf5211f8ca","earnings":[{"amount":10000,"hours":0,"earning_type":"CompanyPayType","earning_id":1},{"amount":500,"hours":0,"earning_type":"CompanyEarningType","earning_id":4}],"benefits":[{"benefit_id":22,"company_contribution_amount":100,"employee_deduction_amount":50},{"benefit_id":25,"company_contribution_amount":0,"employee_deduction_amount":300}],"taxes":[{"tax_id":1,"amount":400},{"tax_id":2,"amount":60}]}],"applicable_earnings":[{"earning_type":"CompanyPayType","earning_id":1,"name":"Regular Wages","input_type":"amount","category":"default"},{"earning_type":"CompanyEarningType","earning_id":4,"name":"Cash Tips","input_type":"amount","category":"default"}],"applicable_benefits":[{"id":22,"description":"Kaiser","active":true},{"id":25,"description":"HSA","active":true}],"applicable_taxes":[{"id":1,"name":"Federal Income Tax","employer_tax":false,"resident_tax":false},{"id":2,"name":"Social Security","employer_tax":false,"resident_tax":false}],"metadata":{"deletable":true}}