Company
Get a company's document 🌍
Changed onReturns a company's document. \ \ Please note that this endpoint will only work with URLs provided by other endpoints of the PayFit API, such as GET /auto-enrolment-documents or /income-taxes-documents. \ Other documents are not accessible via this endpoint.
Required scopes: contracts:payslips:read, pension:read
get/companies/{companyId}/documents/{documentId}
Request
- Base URLhttps://partner-api.payfit.com
- Auth
- OAuth 2Authorization codehttps://oauth.payfit.com/authorizeToken URLhttps://oauth.payfit.com/tokenScopescontracts:payslips:read
- or OAuth 2Authorization codehttps://oauth.payfit.com/authorizeToken URLhttps://oauth.payfit.com/tokenScopespension:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
companyIdstring required
The id of the company
documentIdstring required
The id of the document
Response
The document file requested
Changes
- info
the security scope
contracts:payslips:readwas added to the endpoint's security schemepartner-api-oauth - info
the security scope
pension:readwas removed from the endpoint's security schemepartner-api-oauth
- info