List Billing Orders Using GET

Get a list of monthly billing orders. Supported selectors: contract.contractReferenceNumber, contract.contractSKU.code, contract.contractSKU.contractType, contract.contractSKU.productFamily.name, contract.contractSKU.productFamily.code, contract.contractSKU.productFamily.type, usagePeriod, status, orderNumber, billingOrderPreference.

Pre-authorized roles: Operations, Read Only

Request

URI

GET

https://{api_host}//vcp.vmware.com/api/aggregator/v1/billingOrders

COPY

Query Parameters

string

filter

Optional

FIQL format

integer

limit

Optional

limit

integer

offset

Optional

offset

string

sort

Optional

sort

Responses

200

Summary for different product families.

| Properties    | VELO | Rental & Others(MSP, SOV, ISV, etc) |
| ------------  | ---- | ----------------------------------- |
| minimumCommit |      |               *                     |
| reported      |      |               *                     |
| overage       |      |               *                     |
| underage      |      |               *                     |
| total         |      |               *                     |
| listPrice     |  *   |               *                     |
| sellingPrice  |  *   |               *                     |
| discount      |  *   |               *                     |

Returns PageOfSimpleBillingOrder of type(s) application/json

{
    "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
}

array of SimpleBillingOrder

content

Optional

content

integer As int64 As int64

total

Optional

total

400

Bad Request

Operation doesn't return any data structure

401