VMware Cloud Provider Commerce Portal - Aggregator API Documentation Data Structures
AggContractCreateRequest
Request to create a contract
JSON Example
{
"contractSKUId": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"serviceProviderContact": "[email protected]",
"licenseContact": "[email protected]",
"aggregatorContact": "[email protected]",
"systemContact": "[email protected]",
"serviceProviderId": "33f574a8-xxxx-xxxx-xxxx-b10700000008",
"bolDate": "2022-03-21",
"currency": "USD",
"billingOrderPreference": "string",
"vmwarePurchaseOrder": "PO-100000",
"fillPurchaseOrderInMBO": "boolean",
"billToAccountId": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"entitlementAccount": 111111,
"term": "Required for CUSTOM/PREPAY, ignored for PAY-GO",
"minCommits": [
"number"
],
"prepayment": "Required for PREPAY, ignored for PAY-GO/CUSTOM",
"triggerPoint": "Optional for PREPAY, ignored for PAY-GO/CUSTOM",
"discount": "Required for CUSTOM/PREPAY, ignored for PAY-GO",
"spf": "Required for CUSTOM/PREPAY, ignored for PAY-GO",
"comment": "created by [email protected]",
"threshold": 900
}string
contractSKUId
Required
contractSKUId
string
serviceProviderContact
Required
Cloud service provider contact
string
licenseContact
Optional
Required for RENTAL, SOV and LPCAAS
string
aggregatorContact
Required
aggregatorContact
string
systemContact
Required
VMware contact
string
serviceProviderId
Required
Cloud service provider
string As date As date
bolDate
Required
Start date
string
currency
Required
currency
string
billingOrderPreference
Required
Order preference
string
vmwarePurchaseOrder
Required
Purchase Order with VMware
boolean
fillPurchaseOrderInMBO
Optional
Autofill purchase order number into monthly billing order
string
billToAccountId
Required
Bill-to location
string
entitlementAccount
Optional
entitlementAccount
integer As int32 As int32
term
Optional
Term (in Months)
array of number
minCommits
Optional
Minimum commits. Each element is the minimum commit for each month. If the request start date is the first day of the month, the length of minimum commits equals to term, otherwise the length of minimum commits equals to the term plus one. E.g. 1: Start date is 2022-03-01 and term is 12, then the minimum commits are [10,10,10,10,10,10,10,10,10,10,10,10]. E.g. 2: Start date is 2022-03-21 and term is 12, then the minimum commits are [3,10,10,10,10,10,10,10,10,10,10,10,7]. Minimum commits are not required for VELO.
number
prepayment
Optional
Total prepaid, must be greater than or equal to the sum of minimum commits
number
triggerPoint
Optional
Optional. Notify when balance is below trigger point
number
discount
Optional
discount
string
spf
Optional
spf
string
comment
Optional
comment
number
threshold
Optional
Usage threshold, required for MSP contract
AggContractDowngradeRequest
Request to downgrade a contract
JSON Example
{
"contractSKUId": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"effectiveDate": "2023-03-01",
"comment": "Lower Monthly Commit"
}string
contractSKUId
Required
New contract SKU
string As date As date
effectiveDate
Required
effectiveDate
string
comment
Required
comment
AggContractTerminateRequest
Request to terminate a contract
JSON Example
{
"effectiveDate": "2023-03-01",
"comment": "terminated by [email protected]",
"reason": "Service Provider Bankruptcy"
}string As date As date
effectiveDate
Required
Terminate date
string
comment
Required
comment
string
reason
Required
Service Provider Bankruptcy,Aggregator Swap,Service Provider Delinquent,COVID Impact,Partner Connect Fee,Competitor Offering,Merger and Acquisition
AggContractTopupRequest
Request to top up a contract
JSON Example
{
"prepayment": 240,
"term": 12,
"burnDownSchedule": [
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20
],
"comment": "top up by [email protected]",
"vmwarePurchaseOrder": "PO-100000"
}number
prepayment
Required
Top-Up Amount
integer As int32 As int32
term
Required
Term (in Months), must be greater than or equal to the contract term
array of number
burnDownSchedule
Required
Each element is a burndown schedule for each month. Only the burndown schedule since the current month can be changed. The length of the burndown schedule is the request term. Example: The contract burndown schedule is [10,10,10,10,10,10,10,10,10,10,10,10], start date is 2022-01-01, term is 12, and current date is 2022-03-01. Case 1: Request term is the same as original term, top up 20 from 2022-03 to 2022-12, then the burndown schedule is [10,10,20,20,20,20,20,20,20,20,20,20]. Case 2: Request to extend two months, top up 20 from 2022-03 to 2023-02, then the burndown schedule is [10,10,20,20,20,20,20,20,20,20,20,20,20,20].
string
comment
Optional
comment
string
vmwarePurchaseOrder
Required
Purchase Order with VMware
AggContractUpdateRequest
Request to update a contract
JSON Example
{
"serviceProviderContact": "[email protected]",
"licenseContact": "[email protected]",
"aggregatorContact": "[email protected]",
"billingOrderPreference": "string",
"vmwarePurchaseOrder": "PO-100000",
"fillPurchaseOrderInMBO": "boolean",
"billToAccountId": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"entitlementAccount": 111111
}string
serviceProviderContact
Optional
Cloud service provider contact
string
licenseContact
Optional
Valid for RENTAL, SOV and LPCAAS
string
aggregatorContact
Optional
aggregatorContact
string
billingOrderPreference
Optional
Order preference
string
vmwarePurchaseOrder
Optional
Purchase Order with VMware
boolean
fillPurchaseOrderInMBO
Optional
Autofill purchase order number into monthly billing orders
string
billToAccountId
Optional
Bill-to location
string
entitlementAccount
Optional
Entitlement account number
AggContractUpgradeRequest
Request to upgrade a contract
JSON Example
{
"contractSKUId": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"effectiveDate": "2023-03-01",
"comment": "Higher Monthly Commit"
}string
contractSKUId
Required
New contract SKU
string As date As date
effectiveDate
Required
effectiveDate
string
comment
Optional
comment
AggProductFamily
JSON Example
{
"id": "56929513-xxxx-xxxx-xxxx-513800000000",
"name": "Rental Commercial",
"code": "RENTAL",
"description": "Rental (also known as License Rental)",
"type": "RENTAL"
}string
id
Optional
id
string
name
Optional
name
string
code
Optional
code
string
description
Optional
description
string
type
Optional
type
AggregatorContact
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
ApproveBillingOrderRequest
Request to approve a monthly billing order
JSON Example
{
"serviceProviderPurchaseOrder": "PO-100000",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "string",
"comment": "approved by [email protected]"
}string
serviceProviderPurchaseOrder
Required
Purchase order from cloud services provider of the billing order
string
vmwarePurchaseOrder
Required
Purchase Order with VMware
string
billingOrderPreference
Required
billingOrderPreference
string
comment
Optional
comment
BaseAuthRequest
JSON Example
{
"type": "UserToken"
}string
type
Optional
type
BillToAccount
JSON Example
{
"accountNumber": 10001,
"location": "location-100010"
}string
accountNumber
Optional
Bill-to account number
string
location
Optional
location
BillToAccountDetail
JSON Example
{
"id": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"accountNumber": 10001,
"siteId": 1000001,
"location": "location-100010",
"countryRegion": "US"
}string
id
Optional
id
string
accountNumber
Optional
Bill-to account number
string
siteId
Optional
siteId
string
location
Optional
Bill-to location
string
countryRegion
Optional
countryRegion
BillingOrderCommentDTO
JSON Example
{
"user": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"createdTime": "2023-03-01T08:14:56Z",
"content": "approved by [email protected]"
}string As date-time As date-time
createdTime
Optional
createdTime
string
content
Optional
content
ClusterUsage
JSON Example
{
"clusterId": "cluster-test",
"quantity": 1
}string
clusterId
Optional
Cluster id of the cluster usage
number
quantity
Optional
Quantity of the cluster usage
CommentRequest
Request to add a comment to a monthly billing order
JSON Example
{
"comment": "approved by [email protected]"
}string
comment
Required
comment
Contract
JSON Example
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111
},
"aggregatorContact": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"serviceProviderContact": {
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]"
},
"systemContact": {
"firstName": "Maria",
"lastName": "Williams",
"email": "[email protected]"
},
"licenseContact": {
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
},
"eolDate": "2023-03-20",
"bolDate": "2022-03-21",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"contractNumber": 111111,
"region": "AMER",
"term": 12,
"graceTerm": 1,
"currency": "USD",
"contractId": 1111,
"discount": 20,
"spf": "SPF123",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"billToAccount": {
"accountNumber": 10001,
"location": "location-100010"
},
"entitlementAccount": 111111,
"sellingPricePerPoint": 0.88,
"fillPurchaseOrderInMBO": "boolean"
}string
id
Optional
id
string As date As date
eolDate
Optional
End date of the contract
string As date As date
bolDate
Optional
Begin date of the contract
string
status
Optional
status
string
contractReferenceNumber
Optional
contractReferenceNumber
string
contractNumber
Optional
contractNumber
string
region
Optional
Region of the cloud services provider
integer As int32 As int32
term
Optional
Term of the contract(in months)
integer As int32 As int32
graceTerm
Optional
Grace term(in months) when it's a PAY-GO contract
string
currency
Optional
currency
string
contractId
Optional
Contract id
number
discount
Optional
discount
string
spf
Optional
Contract SPF
string
vmwarePurchaseOrder
Optional
Purchase order with VMware
string
billingOrderPreference
Optional
Billing order preference
string
entitlementAccount
Optional
Entitlement account
number
sellingPricePerPoint
Optional
Selling price per point
boolean
fillPurchaseOrderInMBO
Optional
Autofill purchase order number into monthly billing orders
Property Of
ContractDowngradeBriefRequestDTO
JSON Example
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_APPROVAL",
"requestType": "DOWNGRADE",
"requestContractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101"
}string
id
Optional
Contract downgrade request id
string
status
Optional
Current status
string
requestType
Optional
requestType
string As date As date
effectiveDate
Optional
effectiveDate
string As date-time As date-time
createdTime
Optional
createdTime
string
token
Optional
token
ContractSKU
JSON Example
{
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
}string
code
Optional
code
string
contractType
Optional
contractType
ContractSKUDetails
JSON Example
{
"id": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"code": "VSPP3-1800-C",
"bolDate": "2010-10",
"eolDate": "2030-10",
"contractType": "PAY-GO",
"minCommit": 1800,
"term": 12,
"discount": "number",
"commitType": "MONTHLY",
"commitValue": "integer"
}string
id
Optional
id
string
code
Optional
code
string
bolDate
Optional
Begin month
string
eolDate
Optional
End month
string
contractType
Optional
contractType
integer As int64 As int64
minCommit
Optional
Minimum commit
integer As int32 As int32
term
Optional
term
number
discount
Optional
discount
string
commitType
Optional
SKU commit type
integer As int64 As int64
commitValue
Optional
SKU commit value
ContractTerminateBriefRequestDTO
JSON Example
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_APPROVAL",
"requestType": "TERMINATE",
"requestContractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101"
}string
id
Optional
Contract terminate request id
string
status
Optional
Current status
string
requestType
Optional
requestType
string As date As date
effectiveDate
Optional
effectiveDate
string As date-time As date-time
createdTime
Optional
createdTime
string
token
Optional
token
ContractTopUpBriefRequestDTO
JSON Example
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_APPROVAL",
"requestType": "TOPUP",
"requestContractSKU": {
"code": "VSPP3-PREPAY-C",
"contractType": "PRE-PAY",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101",
"vmwarePurchaseOrder": "PO-100000",
"term": 12,
"prepayment": 240,
"burnDownSchedule": [
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20,
20
]
}string
id
Optional
Contract top up request id
string
status
Optional
Current status
string
requestType
Optional
Current request type
string As date As date
effectiveDate
Optional
effectiveDate
string As date-time As date-time
createdTime
Optional
createdTime
string
token
Optional
token
string
vmwarePurchaseOrder
Optional
Purchase Order with VMware
integer As int32 As int32
term
Optional
term
number
prepayment
Optional
Total prepaid
array of number
burnDownSchedule
Optional
burnDownSchedule
ContractUpgradeBriefRequestDTO
JSON Example
{
"id": "f8b83357-xxxx-xxxx-xxxx-8366e586c8f9",
"status": "PENDING_EFFECTIVE_DATE",
"requestType": "UPGRADE",
"requestContractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"effectiveDate": "2023-03-01",
"createdTime": "2023-03-01T07:36:00.396Z",
"token": "C-100002-00012-2303-0000101"
}string
id
Optional
Contract upgrade request id
string
status
Optional
Current status
string
requestType
Optional
requestType
string As date As date
effectiveDate
Optional
effectiveDate
string As date-time As date-time
createdTime
Optional
createdTime
string
token
Optional
token
Deal
JSON Example
{
"contract": {
"contractNumber": 111111,
"contractReferenceNumber": "AMER1111RENTAL",
"currency": "USD"
},
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca2",
"dealNumber": 20001,
"productSKU": "VMW-VSANV2-STD-C",
"productCategory": "Cloud Infrastructure and Management",
"projectedDealValue": 10000,
"status": "CLOSED_WON",
"extendStatus": "NOT_EXTENDED",
"creationDate": "2022-08-03",
"expirationDate": "2023-01-30",
"expectedCloseDate": "2022-10-23",
"closeDate": "2022-11-01",
"fiscalQuarter": "Q3FY2022",
"serviceProviderContact": "[email protected]",
"aggregatorSalesContactLead": "[email protected]",
"aggregatorManager": "[email protected]",
"promotionEvent": "SALES_CAMPAIGN"
}string
id
Optional
id
string
dealNumber
Optional
Deal number
string
productSKU
Optional
productSKU
string
productCategory
Optional
Product category
number
projectedDealValue
Optional
Projected deal value
string
status
Optional
Enum: [DRAFT, PENDING_APPROVE, PENDING_REVISION, OPPORTUNITY, CLOSED_WON, CLOSED_LOST, CLOSED_EXPIRED, CLOSED_DENIED, CLOSED_ABANDONED, CLOSED_CONTRACT_TERMINATED, CLOSED_AGGREGATOR_SWAPPED, CLOSED_AS_LOST_PRODUCT_ACCESS]
string
extendStatus
Optional
Extend status
string As date As date
creationDate
Optional
creation date
string As date As date
expirationDate
Optional
Expiration date
string As date As date
expectedCloseDate
Optional
Expected close date
string As date As date
closeDate
Optional
Close date
string
fiscalQuarter
Optional
The fiscal quarter of VMware
string
serviceProviderContact
Optional
Cloud services provider contact
string
aggregatorSalesContactLead
Optional
Aggregator sales contact lead
string
aggregatorManager
Optional
Aggregator manager
string
promotionEvent
Optional
Promotion event. Enums: [Sales Campaign, Webinar, Training, Partner Meeting, Other]
DealContract
JSON Example
{
"contractNumber": 111111,
"contractReferenceNumber": "AMER1111RENTAL",
"currency": "USD"
}string
contractNumber
Optional
contractNumber
string
contractReferenceNumber
Optional
contractReferenceNumber
string
currency
Optional
currency
DealServiceProviderInfo
JSON Example
{
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
}string
name
Optional
name
string
prmId
Optional
prmId
string
countryRegion
Optional
countryRegion
InlineUserToken1
This data structure has no properties.
string
type
Optional
type
string
userToken
Optional
userToken
InlineUserToken1
This data structure has no properties.
string
type
Optional
type
string
userToken
Optional
userToken
LicenseContact
Valid for RENTAL and SOV
JSON Example
{
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
}string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
Metadata
JSON Example
{
"inMinCommit": true,
"minQuantity": "number",
"comment": "comment",
"readOnly": "boolean",
"clusterUsages": [
{
"clusterId": "cluster-test",
"quantity": 1
}
],
"priceDetail": {
"tieredPriceDetails": [
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
]
},
"subscriptionId": "Invalid for Rental",
"proformaNumber": "Invalid for Rental",
"invoiceNumber": "Invalid for Rental",
"sid": "Invalid for Rental",
"orderNumber": "Invalid for Rental",
"cspOrgId": "Invalid for Rental"
}boolean
inMinCommit
Optional
Flag to indicate whether it will be counted in minimum commitment
number
minQuantity
Optional
Minimum quantity of usage if the product's usage is reported
string
comment
Optional
Comment to explain why usage is manually changed
boolean
readOnly
Optional
readOnly
string
subscriptionId
Optional
Subscription id
string
proformaNumber
Optional
Proforma number
string
invoiceNumber
Optional
Invoice number
string
sid
Optional
Order sid
string
orderNumber
Optional
Order number
string
cspOrgId
Optional
CSP organization id
PageOfAggProductFamily
JSON Example
{
"content": [
{
"id": "56929513-xxxx-xxxx-xxxx-513800000000",
"name": "Rental Commercial",
"code": "RENTAL",
"description": "Rental (also known as License Rental)",
"type": "RENTAL"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfBillToAccountDetail
JSON Example
{
"content": [
{
"id": "533ea6cb-xxxx-xxxx-xxxx-b10700000008",
"accountNumber": 10001,
"siteId": 1000001,
"location": "location-100010",
"countryRegion": "US"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfBillingOrderCommentDTO
JSON Example
{
"content": [
{
"user": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"createdTime": "2023-03-01T08:14:56Z",
"content": "approved by [email protected]"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfContract
JSON Example
{
"content": [
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111
},
"aggregatorContact": {
"firstName": "Bob",
"lastName": "Johnson",
"email": "[email protected]"
},
"serviceProviderContact": {
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]"
},
"systemContact": {
"firstName": "Maria",
"lastName": "Williams",
"email": "[email protected]"
},
"licenseContact": {
"firstName": "Ava",
"lastName": "Brown",
"email": "[email protected]"
},
"eolDate": "2023-03-20",
"bolDate": "2022-03-21",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"contractNumber": 111111,
"region": "AMER",
"term": 12,
"graceTerm": 1,
"currency": "USD",
"contractId": 1111,
"discount": 20,
"spf": "SPF123",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"billToAccount": {
"accountNumber": 10001,
"location": "location-100010"
},
"entitlementAccount": 111111,
"sellingPricePerPoint": 0.88,
"fillPurchaseOrderInMBO": "boolean"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfContractSKUDetails
JSON Example
{
"content": [
{
"id": "e4d8668b-xxxx-xxxx-xxxx-0ba60000002f",
"code": "VSPP3-1800-C",
"bolDate": "2010-10",
"eolDate": "2030-10",
"contractType": "PAY-GO",
"minCommit": 1800,
"term": 12,
"discount": "number",
"commitType": "MONTHLY",
"commitValue": "integer"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfDeal
JSON Example
{
"content": [
{
"contract": {
"contractNumber": 111111,
"contractReferenceNumber": "AMER1111RENTAL",
"currency": "USD"
},
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca2",
"dealNumber": 20001,
"productSKU": "VMW-VSANV2-STD-C",
"productCategory": "Cloud Infrastructure and Management",
"projectedDealValue": 10000,
"status": "CLOSED_WON",
"extendStatus": "NOT_EXTENDED",
"creationDate": "2022-08-03",
"expirationDate": "2023-01-30",
"expectedCloseDate": "2022-10-23",
"closeDate": "2022-11-01",
"fiscalQuarter": "Q3FY2022",
"serviceProviderContact": "[email protected]",
"aggregatorSalesContactLead": "[email protected]",
"aggregatorManager": "[email protected]",
"promotionEvent": "SALES_CAMPAIGN"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfRebateSheet
JSON Example
{
"content": [
{
"productSKU": "VSPP3-1800-C",
"productDisplayName": "VMware Virtual SAN Standard",
"geo": "USC",
"startDate": "2022-10-29",
"endDate": "2023-01-30"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfRole
JSON Example
{
"content": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfServiceProviderDetails
JSON Example
{
"content": [
{
"id": "33f574a8-xxxx-xxxx-xxxx-b10700000008",
"name": "Sp Corp",
"prmId": 1111111,
"status": "ACTIVE"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfSimpleBillingOrder
JSON Example
{
"content": [
{
"id": "f6bc69ec-xxxx-xxxx-xxxx-eeafc4a7e0bb",
"contract": {
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"currency": "USD"
},
"usagePeriod": "2022-06",
"autoReportType": "AUTOMATED",
"serviceProviderPurchaseOrder": "VMW202206",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"status": "CLOSED",
"orderNumber": 1111111,
"summary": {
"minimumCommit": 1800,
"reported": "number",
"overage": "number",
"underage": 1800,
"total": 1800,
"listPrice": "number",
"sellingPrice": "number",
"discount": "number"
},
"closedTime": "2022-07-02T00:00:00Z"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfUsage
JSON Example
{
"content": [
{
"id": "c301189b-xxxx-xxxx-xxxx-9e175f966c18",
"code": "VMW-VSANV2-STD-C",
"category": "Cloud Infrastructure and Management",
"name": "VMware Virtual SAN Standard",
"siteId": "5ce44045-xxxx-xxxx-xxxx-6c5a1f54ad88",
"siteName": "my_site",
"customerNumber": 1111111111,
"customerName": "Genie Tenant",
"quantity": 10,
"ppu": 3,
"points": 30,
"uom": "GB vRAM",
"unitPrice": "number",
"listPrice": "number",
"discount": "number",
"sellingPrice": "number",
"metadata": {
"inMinCommit": true,
"minQuantity": "number",
"comment": "comment",
"readOnly": "boolean",
"clusterUsages": [
{
"clusterId": "cluster-test",
"quantity": 1
}
],
"priceDetail": {
"tieredPriceDetails": [
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
]
},
"subscriptionId": "Invalid for Rental",
"proformaNumber": "Invalid for Rental",
"invoiceNumber": "Invalid for Rental",
"sid": "Invalid for Rental",
"orderNumber": "Invalid for Rental",
"cspOrgId": "Invalid for Rental"
}
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfUsageMeter
JSON Example
{
"content": [
{
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "6a2ac963-xxxx-xxxx-xxxx-64151fe188f9",
"instanceId": "de16af2a-xxxx-xxxx-xxxx-8cd5d5bdad1e",
"name": "my_um",
"version": "4.0.0.0",
"mode": "PRODUCTION",
"connectionMode": "ONLINE",
"lastUploadTime": "2022-05-06T00:00:00Z",
"uploadHealthStatus": "GREEN",
"lastModifiedTime": "2022-05-06T00:00:00Z"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfUsageSite
JSON Example
{
"content": [
{
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site",
"countryRegion": "US",
"address": "1 S Main St, San Francisco",
"postCode": 94105,
"lastModifiedTime": "2022-05-06T00:00:00Z"
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PageOfUser
JSON Example
{
"content": [
{
"id": "8dec8aaa-xxxx-xxxx-xxxx-760aa839aeb3",
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]",
"status": "ACTIVE",
"roles": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
]
}
],
"total": 1
}integer As int64 As int64
total
Optional
total
PartnerProfile
JSON Example
{
"name": "test",
"prmId": 1111111
}string
name
Optional
name
string
prmId
Optional
prmId
PrepayContractSKU
JSON Example
{
"code": "VSPP3-PREPAY-C",
"contractType": "PRE-PAY",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
}string
code
Optional
code
string
contractType
Optional
contractType
PriceDetail
JSON Example
{
"tieredPriceDetails": [
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
]
}
ProductFamily
JSON Example
{
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}string
name
Optional
name
string
code
Optional
code
string
type
Optional
type
RebateSheet
JSON Example
{
"productSKU": "VSPP3-1800-C",
"productDisplayName": "VMware Virtual SAN Standard",
"geo": "USC",
"startDate": "2022-10-29",
"endDate": "2023-01-30"
}string
productSKU
Optional
productSKU
string
productDisplayName
Optional
productDisplayName
string
geo
Optional
geo
string As date As date
startDate
Optional
Effective start date
string As date As date
endDate
Optional
Effective end date
Role
JSON Example
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}string
id
Optional
id
string
name
Optional
name
SendBackBillingOrderRequest
Request to send back a monthly billing order
JSON Example
{
"comment": "sent back by [email protected]"
}string
comment
Required
comment
ServiceProvider
JSON Example
{
"name": "Sp Corp",
"prmId": 1111111
}string
name
Optional
name
string
prmId
Optional
prmId
ServiceProviderContact
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
ServiceProviderDetails
JSON Example
{
"id": "33f574a8-xxxx-xxxx-xxxx-b10700000008",
"name": "Sp Corp",
"prmId": 1111111,
"status": "ACTIVE"
}string
id
Optional
id
string
name
Optional
name
string
prmId
Optional
prmId
string
status
Optional
status
ServiceProviderInfo
JSON Example
{
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
}string
name
Optional
name
string
prmId
Optional
prmId
string
countryRegion
Optional
countryRegion
SimpleBillingOrder
JSON Example
{
"id": "f6bc69ec-xxxx-xxxx-xxxx-eeafc4a7e0bb",
"contract": {
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"currency": "USD"
},
"usagePeriod": "2022-06",
"autoReportType": "AUTOMATED",
"serviceProviderPurchaseOrder": "VMW202206",
"vmwarePurchaseOrder": "PO-100000",
"billingOrderPreference": "ONLINE",
"status": "CLOSED",
"orderNumber": 1111111,
"summary": {
"minimumCommit": 1800,
"reported": "number",
"overage": "number",
"underage": 1800,
"total": 1800,
"listPrice": "number",
"sellingPrice": "number",
"discount": "number"
},
"closedTime": "2022-07-02T00:00:00Z"
}string
id
Optional
id
string
usagePeriod
Optional
usagePeriod
string
autoReportType
Optional
autoReportType
string
serviceProviderPurchaseOrder
Optional
Purchase order from cloud services provider of the billing order
string
vmwarePurchaseOrder
Optional
Purchase order with VMware
string
billingOrderPreference
Optional
Billing order preference
string
status
Optional
Current billing order status
string
orderNumber
Optional
orderNumber
string As date-time As date-time
closedTime
Optional
Valid when a monthly billing order is closed
Property Of
SimpleContract
JSON Example
{
"id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
"status": "ACTIVE",
"contractReferenceNumber": "AMER1111RENTAL",
"contractSKU": {
"code": "VSPP3-1800-C",
"contractType": "PAY-GO",
"productFamily": {
"name": "Rental Commercial",
"code": "RENTAL",
"type": "RENTAL"
}
},
"currency": "USD"
}string
id
Optional
id
string
status
Optional
status
string
contractReferenceNumber
Optional
contractReferenceNumber
string
currency
Optional
currency
Summary
JSON Example
{
"minimumCommit": 1800,
"reported": "number",
"overage": "number",
"underage": 1800,
"total": 1800,
"listPrice": "number",
"sellingPrice": "number",
"discount": "number"
}number
minimumCommit
Optional
Minimum commitment
number
reported
Optional
Reported usages
number
overage
Optional
Overage usage which exceeds the minimum commitment
number
underage
Optional
Underage usage which is added to cover the minimum commitment
number
total
Optional
Total usages
number
listPrice
Optional
Total list price
number
sellingPrice
Optional
Total selling price
number
discount
Optional
Final discount
SystemContact
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
TieredPrice
JSON Example
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}string
unitRange
Optional
Unit range for tiered price
number
ppu
Optional
Points per unit in the unit range
number
quantity
Optional
Quantity in the unit range
number
split
Optional
Units split out of the total report units using this tiered price.
number
points
Optional
Points in the unit range.
Token
JSON Example
{
"tokenType": "bearer",
"accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJhdWQiOiJTRVNTSU9OIiwiY29udGV4dCI6IjE2MDAxYmY1LTRiYmUtNGE3YS1hMTJkLTE3OWM1Njk0YmI4YyIsImlhdCI6MTY4MjM5Mzg5NCwiZXhwIjoxNjgyMzk1Njk0fQ.Yw5Ys7t7whl28ptPXn4AouK2cIOR4fx6Cg_KOmdUBZDZD83UaifCRHbnpJrqgyNUSw7eHgjVFG_31aAOI9gvBw",
"expiresIn": 1800
}string
tokenType
Optional
Access token type. Currently it is always bearer.
string
accessToken
Optional
Access token in jwt token format, which will be used for subsequent resource API calls. Authorization: Bearer {accessToken}.
integer As int64 As int64
expiresIn
Optional
The seconds token will expire in.
Usage
JSON Example
{
"id": "c301189b-xxxx-xxxx-xxxx-9e175f966c18",
"code": "VMW-VSANV2-STD-C",
"category": "Cloud Infrastructure and Management",
"name": "VMware Virtual SAN Standard",
"siteId": "5ce44045-xxxx-xxxx-xxxx-6c5a1f54ad88",
"siteName": "my_site",
"customerNumber": 1111111111,
"customerName": "Genie Tenant",
"quantity": 10,
"ppu": 3,
"points": 30,
"uom": "GB vRAM",
"unitPrice": "number",
"listPrice": "number",
"discount": "number",
"sellingPrice": "number",
"metadata": {
"inMinCommit": true,
"minQuantity": "number",
"comment": "comment",
"readOnly": "boolean",
"clusterUsages": [
{
"clusterId": "cluster-test",
"quantity": 1
}
],
"priceDetail": {
"tieredPriceDetails": [
{
"unitRange": "0-100",
"ppu": 3,
"quantity": 100,
"split": 0.5,
"points": 150
}
]
},
"subscriptionId": "Invalid for Rental",
"proformaNumber": "Invalid for Rental",
"invoiceNumber": "Invalid for Rental",
"sid": "Invalid for Rental",
"orderNumber": "Invalid for Rental",
"cspOrgId": "Invalid for Rental"
}
}string
id
Optional
id
string
code
Optional
Product SKU code
string
category
Optional
Product category
string
name
Optional
Product name
string
siteId
Optional
Usage site id
string
siteName
Optional
Usage site name
string
customerNumber
Optional
End customer number
string
customerName
Optional
End customer name
number
quantity
Optional
Reported quantity
number
ppu
Optional
Points per unit
number
points
Optional
Total points
string
uom
Optional
Unit of measure
number
unitPrice
Optional
Unit price
number
listPrice
Optional
List price
number
discount
Optional
Final discount
number
sellingPrice
Optional
Selling price
UsageMeter
JSON Example
{
"serviceProvider": {
"name": "Sp Corp",
"prmId": 1111111,
"countryRegion": "US"
},
"id": "6a2ac963-xxxx-xxxx-xxxx-64151fe188f9",
"instanceId": "de16af2a-xxxx-xxxx-xxxx-8cd5d5bdad1e",
"name": "my_um",
"version": "4.0.0.0",
"mode": "PRODUCTION",
"connectionMode": "ONLINE",
"lastUploadTime": "2022-05-06T00:00:00Z",
"uploadHealthStatus": "GREEN",
"lastModifiedTime": "2022-05-06T00:00:00Z"
}string
id
Optional
id
string
instanceId
Optional
Instance UUID
string
name
Optional
name
string
version
Optional
version
string
mode
Optional
mode
string
connectionMode
Optional
connectionMode
string As date-time As date-time
lastUploadTime
Optional
lastUploadTime
string
uploadHealthStatus
Optional
uploadHealthStatus
string As date-time As date-time
lastModifiedTime
Optional
lastModifiedTime
UsageSite
JSON Example
{
"id": "04101966-xxxx-xxxx-xxxx-b21ff240d3f6",
"name": "my_site",
"countryRegion": "US",
"address": "1 S Main St, San Francisco",
"postCode": 94105,
"lastModifiedTime": "2022-05-06T00:00:00Z"
}string
id
Optional
id
string
name
Optional
name
string
countryRegion
Optional
countryRegion
string
address
Optional
address
string
postCode
Optional
postCode
string As date-time As date-time
lastModifiedTime
Optional
lastModifiedTime
User
JSON Example
{
"id": "8dec8aaa-xxxx-xxxx-xxxx-760aa839aeb3",
"firstName": "James",
"lastName": "Smith",
"email": "[email protected]",
"status": "ACTIVE",
"roles": [
{
"id": "81d7de9d-xxxx-xxxx-xxxx-64eea06d3ef1",
"name": "Administrator"
}
]
}string
id
Optional
id
string
firstName
Optional
firstName
string
lastName
Optional
lastName
string
email
Optional
string
status
Optional
status
UserToken
AllOf
JSON Example
{
"type": "string",
"userToken": "e6IsZmpOjEJ4g-bazyo5gl9Y"
}Node: apidepo-liferay-dxp-v1-be-w-1:8080: