List Contracts Using GET

Get a list of contracts. Supported selectors: bolDate, eolDate, status, serviceProvider.prmId, contractId, contractNumber, contractReferenceNumber, contractSKU.code, contractSKU.contractType, contractSKU.productFamily.name, contractSKU.productFamily.code, contractSKU.productFamily.type, billingOrderPreference, billToAccount.accountNumber.

Pre-authorized roles: Operations, Read Only

Request

URI

GET

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

COPY

Query Parameters

string

filter

Optional

FIQL format

integer

limit

Optional

limit

integer

offset

Optional

offset

string

sort

Optional

sort

Responses

200

Returns PageOfContract of type(s) application/json

{
    "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": false
        }
    ],
    "total": 1
}

array of Contract

content

Optional

content

integer As int64 As int64

total

Optional

total

400

Bad Request

Operation doesn't return any data structure

401