Avenants

Détail d'un avenant

Retourne l'avenant et sa prime associée (via premiumId), avec composants.

GET
/provider/endorsements/{endorsementId}

Authorization

bearerAuth COMPANY_ADMIN, BROKER_ADMIN, SOUSCRIPTEUR, SUPERVISEUR, ACCOUNTANT, CLAIMS_HANDLER, BROKER_USER
AuthorizationBearer <token>

Jeton obtenu via POST /provider/token. Les valeurs listées par opération sont les rôles acceptés.

In: header

Scope: COMPANY_ADMIN, BROKER_ADMIN, SOUSCRIPTEUR, SUPERVISEUR, ACCOUNTANT, CLAIMS_HANDLER, BROKER_USER

Path Parameters

endorsementId*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://apigw-pp.pooltpv.app/subscription/api/v1/provider/endorsements/string"
{
  "endorsement": {
    "id": "string",
    "contractId": "string",
    "endorsementTypeId": "string",
    "endorsementCode": "AFFAIRE_NOUVELLE",
    "companyId": "string",
    "brokerId": "string",
    "premiumId": "string",
    "durationId": "string",
    "payload": {},
    "sequenceNumber": 0,
    "reference": "AV-AFFAIRE_NOUVELLE-1791274717947",
    "paymentReference": "pi_91cb5dddcb204a959396ab0f",
    "paymentLink": "string",
    "orderNumber": "string",
    "effectiveDate": "2026-10-06T08:38:39",
    "coverageStart": "2026-10-06T08:38:39",
    "coverageEnd": "2026-10-06T08:38:39",
    "status": "QUOTE",
    "premiumImpact": "INCREASE",
    "premiumDelta": 0,
    "reasonId": "string",
    "reasonCode": "string",
    "reasonComment": "string",
    "changes": {},
    "headerSnapshot": {},
    "vehicleChanges": {},
    "vehiclesAdded": 0,
    "vehiclesRemoved": 0,
    "issuedAt": "2026-10-06T08:38:39",
    "cancelledAt": "2026-10-06T08:38:39",
    "createdDate": "2026-10-06T08:38:39",
    "lastModifiedDate": "2026-10-06T08:38:39"
  },
  "premium": {
    "id": "string",
    "contractId": "string",
    "status": "QUOTE",
    "rcPremium": 0,
    "baseNetPremium": 0,
    "accessoryGuaranteesPremium": 0,
    "accessoryFees": 0,
    "exceptionalFees": 0,
    "commercialDiscount": 0,
    "bonusMalus": 0,
    "totalTaxes": 0,
    "totalPremiumTtc": 0,
    "totalPremiumIncludingTax": 0,
    "commissionRate": 0,
    "commissionAmount": 0,
    "duration": {
      "id": "string",
      "durationCode": "string",
      "durationLabel": "string",
      "numberOfMonths": 0,
      "fractionatedRate": 0,
      "isTemporary": true,
      "isActive": true,
      "displayOrder": 0,
      "createdAt": "2022-03-10T12:15:50",
      "lastModifiedDate": "2022-03-10T12:15:50",
      "createdByUserId": "string",
      "updatedByUserId": "string",
      "createdBy": {
        "id": "string",
        "username": "string",
        "phoneNumber": "string",
        "name": "string",
        "firstName": "string",
        "lastName": "string",
        "status": "string",
        "broker": {
          "id": "string",
          "brokerCode": "string",
          "brokerNumber": "string",
          "legalName": "string",
          "tradeName": "string",
          "approvalNumber": "string",
          "eatciOfficeCode": "string",
          "address": "string",
          "phone": "string",
          "email": "string",
          "type": "BROKER",
          "company": {
            "id": "string",
            "companyCode": "string",
            "companyNumber": "string",
            "companyLabel": "string",
            "legalName": "string",
            "approvalNumber": "string",
            "eatciOfficeCode": "string",
            "address": "string",
            "phone": "string",
            "email": "string",
            "website": "string",
            "logoUrl": "string",
            "isActive": true,
            "createdDate": "2022-03-10T12:15:50",
            "lastModifiedDate": "2022-03-10T12:15:50",
            "createdByUserId": "string",
            "updatedByUserId": "string",
            "createdBy": {},
            "updatedBy": {}
          },
          "mainOffice": {},
          "isMainOffice": true,
          "defaultCommissionRate": 0,
          "isActive": true,
          "createdAt": "2022-03-10T12:15:50",
          "lastModifiedDate": "2022-03-10T12:15:50",
          "createdByUserId": "string",
          "updatedByUserId": "string",
          "createdBy": {},
          "updatedBy": {}
        },
        "company": {
          "id": "string",
          "companyCode": "string",
          "companyNumber": "string",
          "companyLabel": "string",
          "legalName": "string",
          "approvalNumber": "string",
          "eatciOfficeCode": "string",
          "address": "string",
          "phone": "string",
          "email": "string",
          "website": "string",
          "logoUrl": "string",
          "isActive": true,
          "createdDate": "2022-03-10T12:15:50",
          "lastModifiedDate": "2022-03-10T12:15:50",
          "createdByUserId": "string",
          "updatedByUserId": "string",
          "createdBy": {},
          "updatedBy": {}
        },
        "country": "string",
        "email": "string",
        "eatciUsername": "string",
        "enabled": true,
        "emailVerified": true,
        "roles": [
          {
            "id": "string",
            "name": "string",
            "label": "string",
            "description": "string",
            "clientRole": true,
            "clientId": "string",
            "containerId": "string",
            "composite": true
          }
        ],
        "createdDate": "2022-03-10T12:15:50",
        "lastModifiedDate": "2022-03-10T12:15:50",
        "createdByUserId": "string",
        "updatedByUserId": "string",
        "createdBy": {},
        "updatedBy": {}
      },
      "updatedBy": {
        "id": "string",
        "username": "string",
        "phoneNumber": "string",
        "name": "string",
        "firstName": "string",
        "lastName": "string",
        "status": "string",
        "broker": {
          "id": "string",
          "brokerCode": "string",
          "brokerNumber": "string",
          "legalName": "string",
          "tradeName": "string",
          "approvalNumber": "string",
          "eatciOfficeCode": "string",
          "address": "string",
          "phone": "string",
          "email": "string",
          "type": "BROKER",
          "company": {
            "id": "string",
            "companyCode": "string",
            "companyNumber": "string",
            "companyLabel": "string",
            "legalName": "string",
            "approvalNumber": "string",
            "eatciOfficeCode": "string",
            "address": "string",
            "phone": "string",
            "email": "string",
            "website": "string",
            "logoUrl": "string",
            "isActive": true,
            "createdDate": "2022-03-10T12:15:50",
            "lastModifiedDate": "2022-03-10T12:15:50",
            "createdByUserId": "string",
            "updatedByUserId": "string",
            "createdBy": {},
            "updatedBy": {}
          },
          "mainOffice": {},
          "isMainOffice": true,
          "defaultCommissionRate": 0,
          "isActive": true,
          "createdAt": "2022-03-10T12:15:50",
          "lastModifiedDate": "2022-03-10T12:15:50",
          "createdByUserId": "string",
          "updatedByUserId": "string",
          "createdBy": {},
          "updatedBy": {}
        },
        "company": {
          "id": "string",
          "companyCode": "string",
          "companyNumber": "string",
          "companyLabel": "string",
          "legalName": "string",
          "approvalNumber": "string",
          "eatciOfficeCode": "string",
          "address": "string",
          "phone": "string",
          "email": "string",
          "website": "string",
          "logoUrl": "string",
          "isActive": true,
          "createdDate": "2022-03-10T12:15:50",
          "lastModifiedDate": "2022-03-10T12:15:50",
          "createdByUserId": "string",
          "updatedByUserId": "string",
          "createdBy": {},
          "updatedBy": {}
        },
        "country": "string",
        "email": "string",
        "eatciUsername": "string",
        "enabled": true,
        "emailVerified": true,
        "roles": [
          {
            "id": "string",
            "name": "string",
            "label": "string",
            "description": "string",
            "clientRole": true,
            "clientId": "string",
            "containerId": "string",
            "composite": true
          }
        ],
        "createdDate": "2022-03-10T12:15:50",
        "lastModifiedDate": "2022-03-10T12:15:50",
        "createdByUserId": "string",
        "updatedByUserId": "string",
        "createdBy": {},
        "updatedBy": {}
      },
      "fractionatedRateAsDecimal": 0
    },
    "fractionationRate": 0,
    "calculationDate": "2026-10-06T08:38:39",
    "calculatedByUserId": "string",
    "components": [
      {
        "id": "string",
        "premiumId": "string",
        "label": "string",
        "componentType": "PRIME_TECHNIQUE",
        "amount": 0,
        "distributable": true,
        "guaranteeId": "string",
        "vehicleId": "string",
        "createdDate": "2026-10-06T08:38:39",
        "updatedDate": "2026-10-06T08:38:39"
      }
    ]
  }
}
{
  "status": 404,
  "title": "Élément introuvable",
  "detail": "Contract not found",
  "exception": "CONTRACT_NOT_FOUND",
  "instance": "/api/v1/provider/contracts/abc",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 404,
  "title": "Élément introuvable",
  "detail": "Contract not found",
  "exception": "CONTRACT_NOT_FOUND",
  "instance": "/api/v1/provider/contracts/abc",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 404,
  "title": "Élément introuvable",
  "detail": "Contract not found",
  "exception": "CONTRACT_NOT_FOUND",
  "instance": "/api/v1/provider/contracts/abc",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}
{
  "status": 404,
  "title": "Élément introuvable",
  "detail": "Contract not found",
  "exception": "CONTRACT_NOT_FOUND",
  "instance": "/api/v1/provider/contracts/abc",
  "details": {
    "property1": "string",
    "property2": "string"
  }
}