[{"label":"Latest (1.0)","version":"latest"}]

cloud-partner-navigator

ProformaHeaders

Header Details coming from Proforma

Properties

string

billingEngineSubscriptionId Optional

Display MSID of the subscription referred in the billing Engine

string

billingPeriod Optional

Billing period of the proforma

string

currency Optional

Currency used for making the transactions

array of ProformaCustomer

customers Optional

Customers for which subscription is active under Proforma

string

date Optional

Date affective of the Proforma

string

federalTaxId Optional

federal Tax Id of the Proforma

string

fileCreationDate Optional

File Creation Date of the Proforma

string

number Optional

Proforma Number of the Proforma

array of ProformaOffer

offers Optional

Offers active for the Proforma Customer

OrganizationRef

organizationRef Optional

Reference object containing minimal details of organization.

string

organizationalInfo Optional

Information of the organization in proforma

string

proformaFileName Optional

File Name of the Proforma

string

service Optional

Service provisioned in the subscription

string

status Optional

Current Status of the Proforma

string

subscriptionEndDate Optional

End date of the Subscription, post which it will expire

string

subscriptionStartDate Optional

Start date of the Subscription, starting which it will be active

JSON Example

{
	"billingEngineSubscriptionId": "string",
	"billingPeriod": "string",
	"currency": "string",
	"customers": [
		{
			"address": "string",
			"city": "string",
			"contactName": "string",
			"eaNumber": "string",
			"email": "string",
			"locationId": "string",
			"name": "string",
			"number": "string",
			"phone": "string",
			"prmid": "string",
			"state": "string",
			"type": "string"
		}
	],
	"date": "string",
	"federalTaxId": "string",
	"fileCreationDate": "string",
	"number": "string",
	"offers": [
		{
			"additionalAttributes": {
				"key": "string"
			},
			"billingEndDate": "string",
			"billingEngineOrderId": "string",
			"billingFrequency": "PREPAID",
			"billingModel": "COMMIT_REQUIRED",
			"billingStartDate": "string",
			"cbcId": "string",
			"currency": "string",
			"description": "string",
			"discountsavings": [
				{
					"attributes": {},
					"discountAmount": 0,
					"number": "string",
					"type": "RCD"
				}
			],
			"endDate": "string",
			"extendedDiscount": "string",
			"licenseUnit": "string",
			"name": "string",
			"offerCategory": "PRIMARY",
			"offerCost": {
				"creditSavings": [
					{
						"creditAmount": 0,
						"creditReference": "string",
						"type": "FLEX_EXCHANGE"
					}
				],
				"discountSavings": [
					{
						"attributes": {
							"key": "string"
						},
						"discountAmount": 0,
						"type": "RCD"
					}
				],
				"promotionSavings": [
					{
						"promotionAmount": 0,
						"promotionCode": "string",
						"promotionName": "string",
						"promotionPercent": 0,
						"promotionServiceDetails": [
							{
								"description": "string",
								"productFamily": "string",
								"serviceDefinitionId": "string"
							}
						],
						"promotionType": "PromotionSaving",
						"remainingAmount": 0,
						"sellerPromotionInstanceId": "string"
					}
				],
				"remainingContractValue": 0,
				"totalContractValue": 0,
				"totalCreditSavings": 0,
				"totalDiscountSavings": 0,
				"totalListPrice": 0,
				"totalNetPrice": 0,
				"totalPromotionSavings": 0,
				"totalSalePrice": 0,
				"unitListPrice": 0,
				"unitNetPrice": 0,
				"unitTotalContractValue": 0
			},
			"offerType": "ONDEMAND",
			"poNumber": "string",
			"prNumber": "string",
			"programOption": "string",
			"purchaseQuantity": 0,
			"quantityUom": "string",
			"referenceId": "string",
			"renewalDate": "string",
			"serviceEndDate": "string",
			"serviceRef": {
				"id": "string",
				"name": "string",
				"serviceIcon": "string"
			},
			"serviceStartDate": "string",
			"sku": "string",
			"skuDescription": "string",
			"startDate": "string",
			"status": "SUBMITTED",
			"tierName": "string",
			"totalListPrice": 0,
			"totalNetPrice": 0,
			"transactionType": "string",
			"unitListPrice": 0,
			"unitNetPrice": 0,
			"unitOfMeasure": "string",
			"usageItems": [
				{
					"chargeId": "string",
					"chargeType": "string",
					"name": "string",
					"offerCost": {
						"creditSavings": [
							{
								"creditAmount": 0,
								"creditReference": "string",
								"type": "FLEX_EXCHANGE"
							}
						],
						"discountSavings": [
							{
								"attributes": {
									"key": "string"
								},
								"discountAmount": 0,
								"type": "RCD"
							}
						],
						"promotionSavings": [
							{
								"promotionAmount": 0,
								"promotionCode": "string",
								"promotionName": "string",
								"promotionPercent": 0,
								"promotionServiceDetails": [
									{
										"description": "string",
										"productFamily": "string",
										"serviceDefinitionId": "string"
									}
								],
								"promotionType": "PromotionSaving",
								"remainingAmount": 0,
								"sellerPromotionInstanceId": "string"
							}
						],
						"remainingContractValue": 0,
						"totalContractValue": 0,
						"totalCreditSavings": 0,
						"totalDiscountSavings": 0,
						"totalListPrice": 0,
						"totalNetPrice": 0,
						"totalPromotionSavings": 0,
						"totalSalePrice": 0,
						"unitListPrice": 0,
						"unitNetPrice": 0,
						"unitTotalContractValue": 0
					},
					"uom": "string"
				}
			],
			"usageSubmissionModel": "string"
		}
	],
	"organizationRef": {
		"domain": "string",
		"id": "string",
		"name": "string"
	},
	"organizationalInfo": "string",
	"proformaFileName": "string",
	"service": "string",
	"status": "string",
	"subscriptionEndDate": "string",
	"subscriptionStartDate": "string"
}

[{"label":"Latest (1.0)","version":"latest"}]

cloud-partner-navigator

Property Of

ProformaDetails

ProformaHeaders

Properties

JSON Example

Property Of

Was this page helpful?