[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Search Resellers Proforma Details

Description

Retrieves proforma details of a specified Reseller organization.

Request

Request

URL

URL


post
https://{api_host}/resellers/{orgId}/proforma-details/search
Copy

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


Request Body

Request Body

ProformaDetailsRequest of mimetype application/json Optional

Reseller request for proforma details

{
	"billingPeriod": "string"
}
string
billingPeriod Optional

Billing period for proforma details

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ProformaDetails of type application/json
{
	"name": "string",
	"partnerId": "string",
	"proformaHeaders": [
		{
			"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",
					"crossRefSku": "string",
					"crossRefSkuDescription": "string",
					"currency": "string",
					"description": "string",
					"discountsavings": [
						{
							"attributes": {},
							"discountAmount": 0,
							"number": "string",
							"type": "RCD"
						}
					],
					"endDate": "string",
					"extendedDiscount": "string",
					"licenseUnit": "string",
					"name": "string",
					"offerCategory": "PRIMARY",
					"offerCost": {
						"cNetPrice": 0,
						"creditSavings": [
							{
								"creditAmount": 0,
								"creditReference": "string",
								"type": "FLEX_EXCHANGE"
							}
						],
						"discountSavings": [
							{
								"attributes": {
									"key": "string"
								},
								"discountAmount": 0,
								"type": "RCD"
							}
						],
						"snsCredit": 0,
						"totalCreditSavings": 0,
						"totalDiscountSavings": 0,
						"totalListPrice": 0,
						"totalNetPrice": 0,
						"unitListPrice": 0,
						"unitNetPrice": 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",
					"startDate": "string",
					"status": "SUBMITTED",
					"tierName": "string",
					"totalListPrice": 0,
					"totalNetPrice": 0,
					"transactionType": "string",
					"unitListPrice": 0,
					"unitNetPrice": 0,
					"unitOfMeasure": "string",
					"usageItems": [
						{
							"chargeId": "string",
							"chargeType": "string",
							"crossRefSku": "string",
							"currency": "string",
							"description": "string",
							"name": "string",
							"offerCost": {
								"cNetPrice": 0,
								"creditSavings": [
									{
										"creditAmount": 0,
										"creditReference": "string",
										"type": "FLEX_EXCHANGE"
									}
								],
								"discountSavings": [
									{
										"attributes": {
											"key": "string"
										},
										"discountAmount": 0,
										"type": "RCD"
									}
								],
								"snsCredit": 0,
								"totalCreditSavings": 0,
								"totalDiscountSavings": 0,
								"totalListPrice": 0,
								"totalNetPrice": 0,
								"unitListPrice": 0,
								"unitNetPrice": 0
							},
							"productId": "string",
							"purchaseQuantity": 0,
							"tierName": "string",
							"uom": "string"
						}
					],
					"usageSubmissionModel": "string"
				}
			],
			"organizationRef": {
				"id": "string",
				"name": "string"
			},
			"organizationalInfo": "string",
			"proformaFileName": "string",
			"service": "string",
			"status": "string",
			"subscriptionEndDate": "string",
			"subscriptionStartDate": "string"
		}
	]
}
string
name Optional

Name of the partner proforma


string
partnerId Optional

Partner PRM Id from Partner Connect


array of ProformaHeaders
proformaHeaders Optional

Headers for the partner proforma

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"billingPeriod":"string"}' https://{api_host}/resellers/{orgId}/proforma-details/search


[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Feedback

Was this page helpful?