ContractInstanceDto

Data Transfer Object for Contract Service

idint64

Contract id

Example: 675432

createdByAdminboolean

Whether the contract was created by an admin

Example: true

encryptionboolean

Encryption status of the contract

Example: false

publicKeystring

Public key associated with the contract

Example: ABCD1234EFGH5678

sealingboolean

Sealing status of the contract

Example: true

createdByUserstring

User who created the contract

Example: admin_user

clientTypestring

Client type

Example: Corporate

clientTypeLabelstring

Label for the client type

Example: Corporate Client

citystring

City of the client

Example: New York

addressstring

Primary address

Example: 123 Main Street

address1string

Secondary address 1

Example: Apt 101

address2string

Secondary address 2

Example: Floor 2

address3string

Secondary address 3

Example: Building B

radicalstring

Radical

Example: COMM123456

postalCodestring

Postal code of the client

Example: 10001

countrystring

Country of the client

Example: USA

nationalIdentifierstring

National identifier

Example: 987654321

commercialOfferCodesstring[]

List of commercial offer codes

Example: ["293","112"]

commercialOfferTariffCodesstring[]

List of tariff codes for commercial offers

Example: ["293","112"]

enableForSubscribersstring

Subscriber enable status

Example: Enabled

enableForSubscribersLabelstring

Subscriber enable status label

Example: Active

agencyCodestring

Agency code

Example: 86

agencyNamestring

Agency name

Example: Central Agency

subscriptionDatestring

Subscription date

Example: 2024-12-25

creationDatestring

Creation date

Example: 2024-12-25

implementationDatestring

Implementation date

Example: 2024-12-26

billingAccountstring

Billing account details

Example: BILL12345

billingAccountNumberstring

Internal ID of the billing account

Example: 67899876433

billingAccountRibstring

RIB of the billing account

Example: RIB123456

groupConventionstring

Group convention status

Example: Yes

groupConventionBooleanboolean

Boolean for group convention

Example: true

contractIdentifierstring

Contract identifier

Example: B0001768690774A

initialContractIdint64

Initial contract ID in case of double validation

Example: 987654321

versionint64

Version of the contract

Example: 1

reasonstring

Reason or purpose of the contract

Example: New client subscription

emailAlertstring

Email alert status

Example: 0

emailAlertLabelstring

Label for the email alert status

Example: Non

smsAlertstring

SMS alert status

Example: 0

smsAlertLabelstring

Label for the SMS alert status

Example: Non

statestring

State of the contract

Example: 97

stateLabelstring

Label for the state of the contract

Example: Contract is active

userIdentityCardNumberstring

The user's identity card number

Example: ABC1234567890

commercialRelationIdentifierstring

Identifier for the commercial relation

Example: 801971

agencyCommercialAssignmentstring

Agency responsible for the commercial assignment

Example: Agency A

titleRCSstring

Title for the commercial relation in RCS

Example: Commercial Assignment Title

commercialGroupstring

Group name in the commercial relation

Example: Group A

userFullNamestring

Full name of the user responsible for the contract

Example: John Doe

productSubscriptions object[]

List of product subscriptions linked to the contract

Array [

productCodestring

Code of the product

Example: PROD001

offerCodestring

Offer code of the product

Example: OFFER1

offerLabelstring

Label for the offer

Example: Premium Offer

encryptionboolean

Encryption status of the product

Example: false

sealingboolean

Sealing status of the product

Example: true

]

subscriber object

Data Transfer Object for Subscriber

nationalitystring

Nationality of the subscriber

Example: French

languagestring

Default language of the subscriber

Example: en

firstNamestring

First name of the subscriber

Example: John

lastNamestring

Last name of the subscriber

Example: Doe

phoneNumberstring

Primary phone number of the subscriber

Example: +33 612345678

idDocumentTypestring

Type of identification document of the subscriber

Example: Passport

idDocumentNumberstring

Identification number of the subscriber

Example: A1234567

emailstring

Email address of the subscriber

Example: john.doe@example.com

rcsFirstNamestring

First name for the RCS contract

Example: John

rcsLastNamestring

Last name for the RCS contract

Example: Doe

genderstring

Gender of the subscriber

Example: Male

usernamestring

Username of the subscriber

Example: johndoe123

telecomOperatorstring

Telecom operator of the subscriber

Example: Orange

professionalProfilesint64[]

List of profile IDs associated with the subscriber

Example: [101,102,103]

profileSignaturestring[]

Profile signature codes associated with the subscriber

Example: ["SIG123","SIG456"]

initiatorboolean

Initiator of the profile

Example: true

endDateOfProfessionalProfiledate-time

End date of the signature validity for the subscriber

endDateOfProfessionalProfileFormattedstring

Formatted end date of the signature validity

Example: 2025-12-31

endSignatureDatedate-time

End date of the signature validity for the subscriber

endSignatureDateFormattedstring

Formatted end date of the signature validity

Example: 2025-12-31

ContractInstanceDto

{
  "id": 675432,
  "createdByAdmin": true,
  "encryption": false,
  "publicKey": "ABCD1234EFGH5678",
  "sealing": true,
  "createdByUser": "admin_user",
  "clientType": "Corporate",
  "clientTypeLabel": "Corporate Client",
  "city": "New York",
  "address": "123 Main Street",
  "address1": "Apt 101",
  "address2": "Floor 2",
  "address3": "Building B",
  "radical": "COMM123456",
  "postalCode": "10001",
  "country": "USA",
  "nationalIdentifier": "987654321",
  "commercialOfferCodes": [
    "293",
    "112"
  ],
  "commercialOfferTariffCodes": [
    "293",
    "112"
  ],
  "enableForSubscribers": "Enabled",
  "enableForSubscribersLabel": "Active",
  "agencyCode": 86,
  "agencyName": "Central Agency",
  "subscriptionDate": "2024-12-25",
  "creationDate": "2024-12-25",
  "implementationDate": "2024-12-26",
  "billingAccount": "BILL12345",
  "billingAccountNumber": "67899876433",
  "billingAccountRib": "RIB123456",
  "groupConvention": "Yes",
  "groupConventionBoolean": true,
  "contractIdentifier": "B0001768690774A",
  "initialContractId": 987654321,
  "version": 1,
  "reason": "New client subscription",
  "emailAlert": "0",
  "emailAlertLabel": "Non",
  "smsAlert": "0",
  "smsAlertLabel": "Non",
  "state": "97",
  "stateLabel": "Contract is active",
  "userIdentityCardNumber": "ABC1234567890",
  "commercialRelationIdentifier": 801971,
  "agencyCommercialAssignment": "Agency A",
  "titleRCS": "Commercial Assignment Title",
  "commercialGroup": "Group A",
  "userFullName": "John Doe",
  "productSubscriptions": [
    {
      "productCode": "PROD001",
      "offerCode": "OFFER1",
      "offerLabel": "Premium Offer",
      "encryption": false,
      "sealing": true
    }
  ],
  "subscriber": {
    "nationality": "French",
    "language": "en",
    "firstName": "John",
    "lastName": "Doe",
    "phoneNumber": "+33 612345678",
    "idDocumentType": "Passport",
    "idDocumentNumber": "A1234567",
    "email": "john.doe@example.com",
    "rcsFirstName": "John",
    "rcsLastName": "Doe",
    "gender": "Male",
    "username": "johndoe123",
    "telecomOperator": "Orange",
    "professionalProfiles": [
      101,
      102,
      103
    ],
    "profileSignature": [
      "SIG123",
      "SIG456"
    ],
    "initiator": true,
    "endDateOfProfessionalProfile": "2024-07-29T15:51:28.071Z",
    "endDateOfProfessionalProfileFormatted": "2025-12-31",
    "endSignatureDate": "2024-07-29T15:51:28.071Z",
    "endSignatureDateFormatted": "2025-12-31"
  }
}