Get Contract Using GET

Get Contract Using GET

Get a contract identified by the contract id.

Pre-authorized roles: Operations, Read Only

Request
URI
GET
https://{api_host}//vcp.vmware.com/api/aggregator/v1/contracts/{contractId}
COPY
Path Parameters
string
contractId
Required

Contract id

contractId example
630c2f68-xxxx-xxxx-xxxx-61f8245eaca1

Responses
200

OK

Returns Contract of type(s) application/json
{
    "id": "630c2f68-xxxx-xxxx-xxxx-61f8245eaca1",
    "serviceProvider": {
        "name": "Sp Corp",
        "prmId": 1111111
    },
    "aggregatorContact": {
        "firstName": "Bob",
        "lastName": "Johnson",
        "email": "bobjohnson@aggcorp.com"
    },
    "serviceProviderContact": {
        "firstName": "James",
        "lastName": "Smith",
        "email": "jamessmith@spcorp.com"
    },
    "systemContact": {
        "firstName": "Maria",
        "lastName": "Williams",
        "email": "mariawilliams@vmware.com"
    },
    "licenseContact": {
        "firstName": "Ava",
        "lastName": "Brown",
        "email": "avabrown@spcorp.com"
    },
    "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
}
string
id
Optional

id

serviceProvider
Optional

serviceProvider

aggregatorContact
Optional

aggregatorContact

serviceProviderContact
Optional

serviceProviderContact

systemContact
Optional

systemContact

licenseContact
Optional

licenseContact

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

Possible values are : DRAFT, CREATE_IN_PROCESS, ACTIVE, PENDING_EXPIRATION, PENDING_TERMINATION, REJECTED, EXPIRED, TERMINATED, DEACTIVATED,
string
contractReferenceNumber
Optional

contractReferenceNumber

contractSKU
Optional

contractSKU

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

Possible values are : EDI, ONLINE, NONE,
billToAccount
Optional

billToAccount

string
entitlementAccount
Optional

Entitlement account

number
sellingPricePerPoint
Optional

Selling price per point

boolean
fillPurchaseOrderInMBO
Optional

Autofill purchase order number into monthly billing orders


400

Bad Request

Operation doesn't return any data structure

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Contract not found

Operation doesn't return any data structure