[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
Search Distributors Proforma Details
DescriptionRetrieves proforma details of a specified Distributor organization
Request
URLURL
https://console.navigator.vmware.com/cphub/api/seller/v1/distributors/{orgId}/proforma-details/search
Path Parameters
Path Parameters
string
orgId
Required
ID of the partner organization in CSP
Request Body
Request Body
ProformaDetailsRequest
of mimetype application/json
Optional
Distributor request for proforma details
{
"billingPeriod": "string"
}
string
billingPeriod
Optional
Billing period for proforma details
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse 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",
"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"
}
]
}
string
name
Optional
Name of the partner proforma
string
partnerId
Optional
Partner PRM Id from Partner Connect
No error details were provided in the OpenAPI specification.
Code SamplesCode Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"billingPeriod":"string"}' https://console.navigator.vmware.com/cphub/api/seller/v1/distributors/{orgId}/proforma-details/search
[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator
