A base class for all API DTO classes
| name | data type | constraints | description |
|---|---|---|---|
| quoteItems | array of QuoteOfferDTO | ||
| shortDescription | string | The shortDescription. | |
| prices | array of TaxPricesDto | List of quote prices | |
| actionStatus | ActionStatus | ||
| quoteCode | string | required | The product code. |
| currentVersion | number | The currentVersion. | |
| status | VersionStatusEnum | The status. | |
| statusDate | number | The statusDate. | |
| startDate | number | The startDate | |
| endDate | number | The endDate | |
| billingPlanCode | string | billing code | |
| discountPlanCode | string | Discount plan code | |
| contractCode | string | ||
| mediaCodes | array of string | ||
| comment | string | The comment. | |
| customFields | CustomFieldsDto |
Example
{
"quoteItems" : [ {
"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" : "...",
"updatedCode" : "...",
"quoteOfferId" : 12345,
"quoteCode" : "...",
"quoteVersion" : 12345,
"quoteLotCode" : "...",
"offerId" : 12345,
"offerCode" : "...",
"billableAccountCode" : "...",
"contractCode" : "...",
"products" : [ {
"quoteProductId" : 12345,
"quoteCode" : "...",
"productCode" : "...",
"quoteVersion" : 12345,
"productVersion" : 12345,
"quantity" : 12345.0,
"discountPlanCode" : "...",
"productAttributes" : [ { }, { } ],
"accountingArticlePrices" : [ { }, { } ],
"customFields" : { },
"deliveryDate" : 12345,
"terminationDate" : 12345,
"terminationReasonCode" : "...",
"actionType" : "TERMINATE"
}, {
"quoteProductId" : 12345,
"quoteCode" : "...",
"productCode" : "...",
"quoteVersion" : 12345,
"productVersion" : 12345,
"quantity" : 12345.0,
"discountPlanCode" : "...",
"productAttributes" : [ { }, { } ],
"accountingArticlePrices" : [ { }, { } ],
"customFields" : { },
"deliveryDate" : 12345,
"terminationDate" : 12345,
"terminationReasonCode" : "...",
"actionType" : "MODIFY"
} ],
"offerAttributes" : [ {
"quoteAttributeId" : 12345,
"quoteAttributeType" : "...",
"quoteAttributeCode" : "...",
"linkedQuoteAttribute" : [ { }, { } ],
"stringValue" : "...",
"doubleValue" : 12345.0,
"dateValue" : 12345,
"customFields" : { },
"booleanValue" : true
}, {
"quoteAttributeId" : 12345,
"quoteAttributeType" : "...",
"quoteAttributeCode" : "...",
"linkedQuoteAttribute" : [ { }, { } ],
"stringValue" : "...",
"doubleValue" : 12345.0,
"dateValue" : 12345,
"customFields" : { },
"booleanValue" : true
} ],
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"discountPlanCode" : "...",
"prices" : [ {
"taxRate" : 12345.0,
"unitPriceAmountWithoutTax" : 12345.0,
"prices" : [ { }, { } ]
}, {
"taxRate" : 12345.0,
"unitPriceAmountWithoutTax" : 12345.0,
"prices" : [ { }, { } ]
} ],
"sequence" : 12345,
"deliveryDate" : 12345,
"userAccountCode" : "...",
"quoteLineType" : "AMEND",
"subscriptionCode" : "..."
}, {
"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" : "...",
"updatedCode" : "...",
"quoteOfferId" : 12345,
"quoteCode" : "...",
"quoteVersion" : 12345,
"quoteLotCode" : "...",
"offerId" : 12345,
"offerCode" : "...",
"billableAccountCode" : "...",
"contractCode" : "...",
"products" : [ {
"quoteProductId" : 12345,
"quoteCode" : "...",
"productCode" : "...",
"quoteVersion" : 12345,
"productVersion" : 12345,
"quantity" : 12345.0,
"discountPlanCode" : "...",
"productAttributes" : [ { }, { } ],
"accountingArticlePrices" : [ { }, { } ],
"customFields" : { },
"deliveryDate" : 12345,
"terminationDate" : 12345,
"terminationReasonCode" : "...",
"actionType" : "CREATE"
}, {
"quoteProductId" : 12345,
"quoteCode" : "...",
"productCode" : "...",
"quoteVersion" : 12345,
"productVersion" : 12345,
"quantity" : 12345.0,
"discountPlanCode" : "...",
"productAttributes" : [ { }, { } ],
"accountingArticlePrices" : [ { }, { } ],
"customFields" : { },
"deliveryDate" : 12345,
"terminationDate" : 12345,
"terminationReasonCode" : "...",
"actionType" : "SUSPEND"
} ],
"offerAttributes" : [ {
"quoteAttributeId" : 12345,
"quoteAttributeType" : "...",
"quoteAttributeCode" : "...",
"linkedQuoteAttribute" : [ { }, { } ],
"stringValue" : "...",
"doubleValue" : 12345.0,
"dateValue" : 12345,
"customFields" : { },
"booleanValue" : true
}, {
"quoteAttributeId" : 12345,
"quoteAttributeType" : "...",
"quoteAttributeCode" : "...",
"linkedQuoteAttribute" : [ { }, { } ],
"stringValue" : "...",
"doubleValue" : 12345.0,
"dateValue" : 12345,
"customFields" : { },
"booleanValue" : true
} ],
"customFields" : {
"customField" : [ { }, { } ],
"inheritedCustomField" : [ { }, { } ]
},
"discountPlanCode" : "...",
"prices" : [ {
"taxRate" : 12345.0,
"unitPriceAmountWithoutTax" : 12345.0,
"prices" : [ { }, { } ]
}, {
"taxRate" : 12345.0,
"unitPriceAmountWithoutTax" : 12345.0,
"prices" : [ { }, { } ]
} ],
"sequence" : 12345,
"deliveryDate" : 12345,
"userAccountCode" : "...",
"quoteLineType" : "CREATE",
"subscriptionCode" : "..."
} ],
"shortDescription" : "...",
"prices" : [ {
"taxRate" : 12345.0,
"unitPriceAmountWithoutTax" : 12345.0,
"prices" : [ {
"priceType" : "ONE_SHOT_SUBSCRIPTION",
"amountWithTax" : 12345.0,
"unitPriceWithoutTax" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountWithoutTaxWithoutDiscount" : 12345.0,
"taxAmount" : 12345.0,
"taxRate" : 12345.0,
"priceOverCharged" : true,
"currencyCode" : "...",
"currencySymbol" : "...",
"recurrenceDuration" : 12345,
"recurrencePeriodicity" : "...",
"chargeCode" : "...",
"chargeLabel" : "...",
"taxCategory" : "...",
"taxCode" : "...",
"quantity" : 12345.0,
"discountedQuotePrice" : { },
"unitMultiplicator" : 12345.0,
"discountValue" : 12345.0,
"discountPlanType" : "PERCENTAGE",
"discountPlanItemCode" : "...",
"applyDiscountsOnOverridenPrice" : true,
"overchargedUnitAmountWithoutTax" : 12345.0,
"discountedAmount" : 12345.0,
"sequence" : 12345,
"id" : 12345,
"customFields" : { }
}, {
"priceType" : "ONE_SHOT_OTHER",
"amountWithTax" : 12345.0,
"unitPriceWithoutTax" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountWithoutTaxWithoutDiscount" : 12345.0,
"taxAmount" : 12345.0,
"taxRate" : 12345.0,
"priceOverCharged" : true,
"currencyCode" : "...",
"currencySymbol" : "...",
"recurrenceDuration" : 12345,
"recurrencePeriodicity" : "...",
"chargeCode" : "...",
"chargeLabel" : "...",
"taxCategory" : "...",
"taxCode" : "...",
"quantity" : 12345.0,
"discountedQuotePrice" : { },
"unitMultiplicator" : 12345.0,
"discountValue" : 12345.0,
"discountPlanType" : "FIXED",
"discountPlanItemCode" : "...",
"applyDiscountsOnOverridenPrice" : true,
"overchargedUnitAmountWithoutTax" : 12345.0,
"discountedAmount" : 12345.0,
"sequence" : 12345,
"id" : 12345,
"customFields" : { }
} ]
}, {
"taxRate" : 12345.0,
"unitPriceAmountWithoutTax" : 12345.0,
"prices" : [ {
"priceType" : "FIXED_DISCOUNT",
"amountWithTax" : 12345.0,
"unitPriceWithoutTax" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountWithoutTaxWithoutDiscount" : 12345.0,
"taxAmount" : 12345.0,
"taxRate" : 12345.0,
"priceOverCharged" : true,
"currencyCode" : "...",
"currencySymbol" : "...",
"recurrenceDuration" : 12345,
"recurrencePeriodicity" : "...",
"chargeCode" : "...",
"chargeLabel" : "...",
"taxCategory" : "...",
"taxCode" : "...",
"quantity" : 12345.0,
"discountedQuotePrice" : { },
"unitMultiplicator" : 12345.0,
"discountValue" : 12345.0,
"discountPlanType" : "FIXED",
"discountPlanItemCode" : "...",
"applyDiscountsOnOverridenPrice" : true,
"overchargedUnitAmountWithoutTax" : 12345.0,
"discountedAmount" : 12345.0,
"sequence" : 12345,
"id" : 12345,
"customFields" : { }
}, {
"priceType" : "RECURRING",
"amountWithTax" : 12345.0,
"unitPriceWithoutTax" : 12345.0,
"amountWithoutTax" : 12345.0,
"amountWithoutTaxWithoutDiscount" : 12345.0,
"taxAmount" : 12345.0,
"taxRate" : 12345.0,
"priceOverCharged" : true,
"currencyCode" : "...",
"currencySymbol" : "...",
"recurrenceDuration" : 12345,
"recurrencePeriodicity" : "...",
"chargeCode" : "...",
"chargeLabel" : "...",
"taxCategory" : "...",
"taxCode" : "...",
"quantity" : 12345.0,
"discountedQuotePrice" : { },
"unitMultiplicator" : 12345.0,
"discountValue" : 12345.0,
"discountPlanType" : "FIXED",
"discountPlanItemCode" : "...",
"applyDiscountsOnOverridenPrice" : true,
"overchargedUnitAmountWithoutTax" : 12345.0,
"discountedAmount" : 12345.0,
"sequence" : 12345,
"id" : 12345,
"customFields" : { }
} ]
} ],
"actionStatus" : {
"status" : "SUCCESS",
"errorCode" : { },
"message" : "...",
"entityId" : 12345,
"entityCode" : "...",
"nrAffected" : 12345,
"json" : "..."
},
"quoteCode" : "...",
"currentVersion" : 12345,
"status" : "PUBLISHED",
"statusDate" : 12345,
"startDate" : 12345,
"endDate" : 12345,
"billingPlanCode" : "...",
"discountPlanCode" : "...",
"contractCode" : "...",
"mediaCodes" : [ "...", "..." ],
"comment" : "...",
"customFields" : {
"customField" : [ {
"code" : "...",
"description" : "...",
"fieldType" : "LIST",
"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" : "BOOLEAN",
"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" : "TEXT_AREA",
"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" : "LIST",
"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" : "..."
} ]
}
}