Retrieve invoicing data for companies
Retrieve data for active companies used to calculate invoices for Gusto Embedded Payroll. A company is considered active for an invoice period if they are an active partner managed company and have run payroll or created contractor payments since becoming a partner managed company. Companies suspended before the invoice period begins are excluded. A company suspended during an invoice period is still included in that period's response, because it was active for part of the period. This endpoint forces pagination, with 100 results returned at a time. You can learn more about our pagination here: pagination guide
📘 System Access Authentication
This endpoint uses the Bearer Auth scheme with the system-level access token in the HTTP Authorization header
scope: invoices:read
Request
- Base URLhttps://api.gusto-demo.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The month we are calculating the invoice for. Must be in YYYY-MM format
Query parameters
The page that is requested. When unspecified, will load all objects unless endpoint forces pagination.
Number of objects per page. For majority of endpoints will default to 25
Filter companies returned in the active_companies response, will return an error if company not active during provided invoice period. i.e. ?company_uuids=781922d8-e780-4b6b-bf74-ee303166d022,bbbca930-7322-491c-ba7f-98707a52a9c5
Headers
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Response
OK
Changes
No recorded changes to this operation across all 2 revisions of this API.