Contract
List all Contracts 🇫🇷
Changed onReturns all Contracts with french specific data. This list is paginated.
Required scopes: contracts:read
get/companies/{companyId}/contracts-fr
Request
- Base URLhttps://partner-api.payfit.com
- AuthOAuth 2Authorization codehttps://oauth.payfit.com/authorizeToken URLhttps://oauth.payfit.com/tokenScopescontracts:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
companyIdstring required
The id of the company
Query parameters
nextPageTokenstring
The encoded pagination token
maxResultsstring
Allows to define the maximum number of items to fetch at once. (Max: 50, Default: 10)
fieldsstring[]
Deprecated. The groups of fields to include in the response, in addition to the default fields. | Possible values are "securite-sociale" (it will require the collaborators:social-security:read oauth scope)
includeInProgressContractsstring
Allow to returns the in progress contracts (or in creation)
Response
All active, pending and last year archived contracts
Changes
- breaking
the response property
/////became nullable for the status - breaking
the response property
/////became nullable for the status
- breaking