Skip to main content

ContractSubscriptionDto

DTO representing the details of a contract subscription.

idint64

Unique identifier of the contract subscription

Example: 12345
associatedBankCodestring

Code of the associated bank

Example: 00004
createdByUserstring

User who created the contract subscription

Example: john_doe
associatedCountryCodestring

Code of the associated country

Example: TN
versionint64

Version of the contract subscription

Example: 1
contractIdentifierstring

Unique identifier of the contract

Example: B0001768690832A
subscriptionProductstring

Product associated with the subscription

Example: Premium Subscription
clientTypestring

Client type code

Example: P_SegmentClientContrat
clientTypeLabelstring

Label representing the client type

Example: Retail
statestring

State of the contract subscription

Example: 97
stateLabelstring

State label of the contract subscription

Example: Active
encryptionboolean

Indicates if encryption is enabled

Example: true
sealingboolean

Indicates if sealing is enabled

Example: false
publicKeystring

Public key associated with the contract

Example: MIIBIjANBgkqhkiG9...
commercialRelationTitlestring

Title of the commercial relationship

Example: Commercial Relationship 1
commercialRelationIdentifierstring

Identifier of the commercial relationship

Example: 2755966
commercialAgencystring

Agency managing the commercial relationship

Example: 86
subscriptionDatestring

Date when the subscription was made

Example: 2024-12-24
enableForSubscribersboolean

Indicates whether the subscription is enabled for subscribers

Example: true
billingAccountstring

Internal identifier for the billing account

Example: 77426922
clientAccountManagerstring

Account manager for the client

Example: 2c91808990a622a50190a7a521530001
numberOfSubscribersint32

Number of subscribers attached to contract

Example: 3
qualityRelativeToContractstring

Represents the quality or status relative to a contract

Example: 92
commercialRelationDto object

DTO representing the details of a commercial relationship.

idint64

Unique identifier for the commercial relation

Example: 12345
associatedBankCodestring

Code of the associated bank

Example: 00004
associatedCountryCodestring

Code of the associated country

Example: TN
versionint64

Version of the commercial relationship

Example: 1
commercialRelationIdentifierstring

Unique identifier for the commercial relation

Example: 2755966
titlestring

Title of the commercial relationship

Example: Commercial Relation 1
segmentstring

Segment of the commercial relation

Example: Retail
nationalIFNumberstring

National identification number for the commercial entity

Example: IFN123456
commerceRegisterNumberstring

Commercial register number of the company

Example: 9285554
addressLine1string

First line of the address

Example: 123 Main Street
addressLine2string

Second line of the address

Example: Suite 101
addressLine3string

Third line of the address

Example: Building A
phoneNumberstring

Phone number for the commercial relation

Example: +1-800-123-4567
tradeFinanceBankIdint64

Trade finance bank ID associated with the commercial relation

Example: 456789
ContractSubscriptionDto
{
  "id": 12345,
  "associatedBankCode": "00004",
  "createdByUser": "john_doe",
  "associatedCountryCode": "TN",
  "version": 1,
  "contractIdentifier": "B0001768690832A",
  "subscriptionProduct": "Premium Subscription",
  "clientType": "P_SegmentClientContrat",
  "clientTypeLabel": "Retail",
  "state": "97",
  "stateLabel": "Active",
  "encryption": true,
  "sealing": false,
  "publicKey": "MIIBIjANBgkqhkiG9...",
  "commercialRelationTitle": "Commercial Relationship 1",
  "commercialRelationIdentifier": 2755966,
  "commercialAgency": 86,
  "subscriptionDate": "2024-12-24",
  "enableForSubscribers": true,
  "billingAccount": 77426922,
  "clientAccountManager": "2c91808990a622a50190a7a521530001",
  "numberOfSubscribers": 3,
  "qualityRelativeToContract": "92",
  "commercialRelationDto": {
    "id": 12345,
    "associatedBankCode": "00004",
    "associatedCountryCode": "TN",
    "version": 1,
    "commercialRelationIdentifier": 2755966,
    "title": "Commercial Relation 1",
    "segment": "Retail",
    "nationalIFNumber": "IFN123456",
    "commerceRegisterNumber": 9285554,
    "addressLine1": "123 Main Street",
    "addressLine2": "Suite 101",
    "addressLine3": "Building A",
    "phoneNumber": "+1-800-123-4567",
    "tradeFinanceBankId": 456789
  }
}