Conventions
Convention creation
Beneficiaries
ContractsTemplates
Conventions
Materials
Operations
Subcontractors
Utils
Worksites
WorksitesDocuments
Conventions
Convention creation
POST
/
v1
/
conventions
curl --request POST \
--url https://api.opx.co/partners/v1/conventions \
--header 'Content-Type: application/json' \
--data '{
"contract_template_id": 123,
"installer_siret": "<string>",
"installer_contact_email": "jsmith@example.com"
}'
{
"data": {
"id": 123,
"contract_template_id": 123,
"reference": "<string>",
"rai_name": "<string>",
"status": "<string>",
"installer_name": "<string>",
"signed_date": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"incentive_type": "<string>",
"classic_volume": "<string>",
"precarity_volume": "<string>"
}
}
Body
application/json
Maximum length:
32
Response
200
application/json
`ConventionResource`
curl --request POST \
--url https://api.opx.co/partners/v1/conventions \
--header 'Content-Type: application/json' \
--data '{
"contract_template_id": 123,
"installer_siret": "<string>",
"installer_contact_email": "jsmith@example.com"
}'
{
"data": {
"id": 123,
"contract_template_id": 123,
"reference": "<string>",
"rai_name": "<string>",
"status": "<string>",
"installer_name": "<string>",
"signed_date": "<string>",
"start_date": "<string>",
"end_date": "<string>",
"incentive_type": "<string>",
"classic_volume": "<string>",
"precarity_volume": "<string>"
}
}