The Class ServiceInstanceDto.
| name | data type | constraints | description |
|---|---|---|---|
| id | number | The id. | |
| auditableField | array of AuditableFieldDto | ||
| code | string | required | The code |
| description | string | The description | |
| status | InstanceStatusEnum | The status. | |
| statusDate | number | The status date. | |
| updatedCode | string | The updated code. | |
| subscriptionDate | number | The subscription date. | |
| reactivationDate | number | The reactivation date. | |
| terminationDate | number | The termination date. | |
| priceVersionDateSetting | PriceVersionDateSettingEnum | the price version date setting. | |
| priceVersionDate | number | The price version date. | |
| quantity | number | The quantity. | |
| terminationReason | string | The termination reason. | |
| endAgreementDate | number | The end agreement date. | |
| customFields | CustomFieldsDto | The custom fields. | |
| recurringChargeInstance | array of ChargeInstanceDto | The recurring charge instances. | |
| subscriptionChargeInstance | array of ChargeInstanceDto | The subscription charge instances. | |
| terminationChargeInstance | array of ChargeInstanceDto | The termination charge instances. | |
| usageChargeInstance | array of ChargeInstanceDto | The usage charge instances. | |
| attributeInstances | array of AttributeInstanceDto | ||
| orderNumber | string | The order number. | |
| rateUntilDate | number | The rate until date. | |
| amountPS | number | The amount PS. | |
| calendarPSCode | string | The calendar PS code. | |
| paymentDayInMonthPS | number | The payment day in month PS. | |
| minimumAmountEl | string | Expression to determine minimum amount value. | |
| minimumLabelEl | string | Expression to determine rated transaction description to reach minimum amount value. | |
| dueDateDaysPS | number | The due date days PS. | |
| autoEndOfEngagement | boolean | ||
| minimumChargeTemplate | string | Corresponding to minimum one shot charge template code. | |
| subscribedTillDate | number | A date till which service is activate. After this date it will either be extended or terminated | |
| serviceRenewal | SubscriptionRenewalDto | The renewal service. | |
| deliveryDate | number | The delivery date |
Example
{
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"code" : "...",
"description" : "...",
"status" : "SUSPENDED",
"statusDate" : 12345,
"updatedCode" : "...",
"subscriptionDate" : 12345,
"reactivationDate" : 12345,
"terminationDate" : 12345,
"priceVersionDateSetting" : "EVENT",
"priceVersionDate" : 12345,
"quantity" : 12345.0,
"terminationReason" : "...",
"endAgreementDate" : 12345,
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "CHILD_ENTITY",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "MULTI_VALUE",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ],
"inheritedCustomField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "LONG",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "STORE_ONLY",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
}, {
"code" : "...",
"description" : "...",
"fieldType" : "DOUBLE",
"languageDescriptions" : [ { }, { } ],
"valueDate" : 12345,
"valuePeriodStartDate" : 12345,
"valuePeriodEndDate" : 12345,
"valuePeriodPriority" : 12345,
"stringValue" : "...",
"dateValue" : 12345,
"longValue" : 12345,
"doubleValue" : 12345.0,
"booleanValue" : true,
"value" : [ { }, { } ],
"mapValue" : {
"property1" : { },
"property2" : { }
},
"entityReferenceValue" : { },
"indexType" : "INDEX_NOT_ANALYZE",
"fileValue" : "...",
"formattedValue" : { },
"urlReferenceValue" : { },
"guiPosition" : "...",
"customTableCode" : "...",
"dataFilter" : "...",
"fields" : "..."
} ]
},
"recurringChargeInstance" : [ {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
}, {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
} ],
"subscriptionChargeInstance" : [ {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
}, {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
} ],
"terminationChargeInstance" : [ {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
}, {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
} ],
"usageChargeInstance" : [ {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
}, {
"status" : "...",
"amountWithTax" : 12345.0,
"id" : 12345,
"auditableField" : [ {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
}, {
"entityClass" : "...",
"fieldName" : "...",
"id" : 12345,
"changeOrigin" : "...",
"auditableField" : [ { }, { } ],
"originName" : "...",
"code" : "...",
"previousState" : "...",
"currentState" : "...",
"description" : "...",
"created" : "...",
"updatedCode" : "...",
"actor" : "..."
} ],
"amountWithoutTax" : 12345.0,
"sellerCode" : "...",
"code" : "...",
"userAccountCode" : "...",
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"description" : "...",
"updatedCode" : "..."
} ],
"attributeInstances" : [ {
"attributeCode" : "...",
"parentAttributeValueId" : 12345,
"assignedAttributeValueIds" : [ 12345, 12345 ],
"stringValue" : "...",
"dateValue" : 12345,
"doubleValue" : 12345.0,
"customFieldDto" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"booleanValue" : true
}, {
"attributeCode" : "...",
"parentAttributeValueId" : 12345,
"assignedAttributeValueIds" : [ 12345, 12345 ],
"stringValue" : "...",
"dateValue" : 12345,
"doubleValue" : 12345.0,
"customFieldDto" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"booleanValue" : true
} ],
"orderNumber" : "...",
"rateUntilDate" : 12345,
"amountPS" : 12345.0,
"calendarPSCode" : "...",
"paymentDayInMonthPS" : 12345,
"minimumAmountEl" : "...",
"minimumLabelEl" : "...",
"dueDateDaysPS" : 12345,
"autoEndOfEngagement" : true,
"minimumChargeTemplate" : "...",
"subscribedTillDate" : 12345,
"serviceRenewal" : {
"initialTermType" : "FIXED",
"renewalTermType" : "CALENDAR",
"initialyActiveFor" : 12345,
"initialyActiveForUnit" : "DAY",
"calendarInitialyActiveFor" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"calendarType" : "INTERVAL",
"fixedDates" : [ "...", "..." ],
"days" : [ { }, { } ],
"hours" : [ { }, { } ],
"periodLength" : 12345,
"periodUnit" : "HOUR_OF_DAY",
"nbPeriods" : 12345,
"joinCalendar1Code" : "...",
"joinCalendar2Code" : "...",
"intervalType" : "WDAY",
"intervals" : [ { }, { } ],
"weekendBegin" : 12345,
"weekendEnd" : 12345,
"endDate" : 12345,
"startDate" : 12345,
"initDateEL" : "...",
"holidays" : [ { }, { } ],
"languageDescriptions" : [ { }, { } ]
},
"autoRenew" : true,
"daysNotifyRenewal" : 12345,
"endOfTermAction" : "SUSPEND",
"terminationReasonCode" : "...",
"renewFor" : 12345,
"calendarRenewFor" : {
"id" : 12345,
"auditableField" : [ { }, { } ],
"code" : "...",
"description" : "...",
"updatedCode" : "...",
"calendarType" : "APPEND",
"fixedDates" : [ "...", "..." ],
"days" : [ { }, { } ],
"hours" : [ { }, { } ],
"periodLength" : 12345,
"periodUnit" : "SECOND",
"nbPeriods" : 12345,
"joinCalendar1Code" : "...",
"joinCalendar2Code" : "...",
"intervalType" : "DAY",
"intervals" : [ { }, { } ],
"weekendBegin" : 12345,
"weekendEnd" : 12345,
"endDate" : 12345,
"startDate" : 12345,
"initDateEL" : "...",
"holidays" : [ { }, { } ],
"languageDescriptions" : [ { }, { } ]
},
"renewForUnit" : "MONTH",
"extendAgreementPeriodToSubscribedTillDate" : true
},
"deliveryDate" : 12345
}