REST API Reference for Billing Care

Search Agreements

get

/agreements

Searches agreements by agreement name, agreement ID, lifecycle status, or a planned-end-date range. The result limit defaults to 50 when it is omitted.

Request

Query Parameters

agreementId: string

External agreement ID.
agreementName: string

Agreement name. Use * as a wildcard.
lifecycleStatus: integer(int32)

Agreement lifecycle status: 0 draft, 1 inactive, 2 active, or 3 closed.
limit: integer(int32)

Maximum result row. Defaults to 50 when omitted.

Default Value: 50
offset: integer(int32)

First result row. Must be non-negative and not greater than limit.
plannedEndDateGTE: integer(int64)

Inclusive lower bound for plannedEndDate, as Unix epoch seconds. When supplied without plannedEndDateLTE, agreements that never end are also returned.
plannedEndDateLTE: integer(int64)

Inclusive upper bound for plannedEndDate, as Unix epoch seconds. Supply the same value for plannedEndDateGTE and plannedEndDateLTE for an exact match.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The agreements were returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object agreement

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Agreement"
    }
}

Nested Schema : agreement

Type: object

Show Source

accounts: array accounts
agreementId: string
characteristics: object AgreementCharacteristic

One characteristic object containing zero or more attributes.
closedDate: integer (int64)
completedDate: integer (int64)
createdDate: integer (int64)
description: string
documentNumber: string
documentURL: string
effectiveDate: integer (int64)
endDate: integer (int64)
extension: object extension

The extended attributes.
id: object ResourceRef
initializeDate: integer (int64)
lastModifiedDate: integer (int64)
lifecycleStatus: integer (int32)
name: string
offers: array offers
plannedEndDate: integer (int64)
profiles: array profiles
startDate: integer (int64)
status: integer (int32)
version: string

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "agreementId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "documentNumber":{
            "type":"string"
        },
        "documentURL":{
            "type":"string"
        },
        "lifecycleStatus":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "version":{
            "type":"string"
        },
        "startDate":{
            "type":"integer",
            "format":"int64"
        },
        "endDate":{
            "type":"integer",
            "format":"int64"
        },
        "plannedEndDate":{
            "type":"integer",
            "format":"int64"
        },
        "createdDate":{
            "type":"integer",
            "format":"int64"
        },
        "lastModifiedDate":{
            "type":"integer",
            "format":"int64"
        },
        "closedDate":{
            "type":"integer",
            "format":"int64"
        },
        "effectiveDate":{
            "type":"integer",
            "format":"int64"
        },
        "completedDate":{
            "type":"integer",
            "format":"int64"
        },
        "initializeDate":{
            "type":"integer",
            "format":"int64"
        },
        "accounts":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementAssociation"
            }
        },
        "offers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementOffer"
            }
        },
        "profiles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementProductProfile"
            }
        },
        "characteristics":{
            "$ref":"#/components/schemas/AgreementCharacteristic"
        }
    },
    "xml":{
        "name":"agreement",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : accounts

Type: array

Show Source

Array of: object AgreementAssociation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementAssociation"
    }
}

Nested Schema : AgreementCharacteristic

Type: object

One characteristic object containing zero or more attributes.

Show Source

attributes: array attributes
id: object ResourceRef

{
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementCharacteristicAttribute"
            }
        }
    },
    "description":"One characteristic object containing zero or more attributes."
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : ResourceRef

Type: object

Show Source

id(required): string

The ID.
uri: string

The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : offers

Type: array

Show Source

Array of: object AgreementOffer

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementOffer"
    }
}

Nested Schema : profiles

Type: array

Show Source

Array of: object AgreementProductProfile

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementProductProfile"
    }
}

Nested Schema : AgreementAssociation

Type: object

Show Source

accountNo: string
action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
agreementAssociationRef: object ResourceRef
endDate: integer (int64)
firstName: string
id(required): object ResourceRef
lastName: string
lineage: string
middleName: string
startDate: integer (int64)

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "accountNo":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "middleName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "lineage":{
            "type":"string"
        },
        "startDate":{
            "type":"integer",
            "format":"int64"
        },
        "endDate":{
            "type":"integer",
            "format":"int64"
        },
        "agreementAssociationRef":{
            "$ref":"#/components/schemas/ResourceRef"
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

Array of: object AgreementCharacteristicAttribute

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementCharacteristicAttribute"
    }
}

Nested Schema : AgreementCharacteristicAttribute

Type: object

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
name(required): string
recId: integer (int32)
type: string
value: string

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "recId":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        }
    }
}

Nested Schema : AgreementOffer

Type: object

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
attributes: array attributes
description: string
endDate: integer (int64)
id(required): object ResourceRef
name: string
offerOverrideRef: object ResourceRef
permitted: string
startDate: integer (int64)
usageMap: array usageMap

Usage-map overrides owned by this individual agreement offer.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "offerOverrideRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permitted":{
            "type":"string"
        },
        "startDate":{
            "type":"integer",
            "format":"int64"
        },
        "endDate":{
            "type":"integer",
            "format":"int64"
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementProductCharacteristic"
            }
        },
        "usageMap":{
            "type":"array",
            "description":"Usage-map overrides owned by this individual agreement offer.",
            "items":{
                "$ref":"#/components/schemas/AgreementUsageMap"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

Array of: object AgreementProductCharacteristic

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementProductCharacteristic"
    }
}

Nested Schema : usageMap

Type: array

Usage-map overrides owned by this individual agreement offer.

Show Source

Array of: object AgreementUsageMap

Usage-map overrides owned by this individual agreement offer.

{
    "type":"array",
    "description":"Usage-map overrides owned by this individual agreement offer.",
    "items":{
        "$ref":"#/components/schemas/AgreementUsageMap"
    }
}

Nested Schema : AgreementProductCharacteristic

Type: object

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
id: object ResourceRef
name(required): string
recId: integer (int32)
type: string
value: string

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "recId":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : AgreementUsageMap

Type: object

Usage-map overrides owned by this individual agreement offer.

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
attribute: array attribute
dateRange: array dateRange
discountModels: array discountModels
endDate: integer (int64)
event(required): string
id: object ResourceRef
priceTagInfoObj: object ResourceRef
ratePlans: array ratePlans

{
    "required":[
        "event"
    ],
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "event":{
            "type":"string"
        },
        "endDate":{
            "type":"integer",
            "format":"int64"
        },
        "attribute":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementProductCharacteristic"
            }
        },
        "priceTagInfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "ratePlans":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementRatePlan"
            }
        },
        "discountModels":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementDiscountModel"
            }
        },
        "dateRange":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementDateRange"
            }
        }
    },
    "description":"Usage-map overrides owned by this individual agreement offer."
}

Nested Schema : attribute

Type: array

Show Source

Array of: object AgreementProductCharacteristic

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementProductCharacteristic"
    }
}

Nested Schema : dateRange

Type: array

Show Source

Array of: object AgreementDateRange

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementDateRange"
    }
}

Nested Schema : discountModels

Type: array

Show Source

Array of: object AgreementDiscountModel

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementDiscountModel"
    }
}

Nested Schema : ratePlans

Type: array

Show Source

Array of: object AgreementRatePlan

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementRatePlan"
    }
}

Nested Schema : AgreementDateRange

Type: object

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
end: integer (int64)

End of the override range. For an existing range in a PATCH request this, together with start, identifies the range; change dates by removing the range and adding a new one.
name: string
priceTags: array priceTags
start: integer (int64)

Start of the override range. For an existing range in a PATCH request, this, together with end, identifies the range; change dates by removing the range and adding a new one.

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "start":{
            "type":"integer",
            "description":"Start of the override range. For an existing range in a PATCH request, this, together with end, identifies the range; change dates by removing the range and adding a new one.",
            "format":"int64"
        },
        "end":{
            "type":"integer",
            "description":"End of the override range. For an existing range in a PATCH request this, together with start, identifies the range; change dates by removing the range and adding a new one.",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "priceTags":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementPriceTag"
            }
        }
    }
}

Nested Schema : priceTags

Type: array

Show Source

Array of: object AgreementPriceTag

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementPriceTag"
    }
}

Nested Schema : AgreementPriceTag

Type: object

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
amount: number
description: string
name: string
percent: number
resourceId: integer (int32)
tagScope: string

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "name":{
            "type":"string"
        },
        "tagScope":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "amount":{
            "type":"number"
        },
        "percent":{
            "type":"number"
        },
        "resourceId":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : AgreementDiscountModel

Type: object

Show Source

end: integer (int64)
name: string
priceTags: array priceTags
start: integer (int64)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"integer",
            "format":"int64"
        },
        "end":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "priceTags":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementPriceTag"
            }
        }
    }
}

Nested Schema : priceTags

Type: array

Show Source

Array of: object AgreementPriceTag

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementPriceTag"
    }
}

Nested Schema : AgreementRatePlan

Type: object

Show Source

end: integer (int64)
name: string
priceTags: array priceTags
start: integer (int64)

{
    "type":"object",
    "properties":{
        "start":{
            "type":"integer",
            "format":"int64"
        },
        "end":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        },
        "priceTags":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementPriceTag"
            }
        }
    }
}

Nested Schema : priceTags

Type: array

Show Source

Array of: object AgreementPriceTag

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementPriceTag"
    }
}

Nested Schema : AgreementProductProfile

Type: object

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
dataArray: array dataArray
extrating: object Extrating

Information about an extended rating attribute.
id(required): object ResourceRef
name: string
serviceRef: object ResourceRef

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string"
        },
        "extrating":{
            "$ref":"#/components/schemas/Extrating"
        },
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "dataArray":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementProfileAttribute"
            }
        }
    }
}

Nested Schema : dataArray

Type: array

Show Source

Array of: object AgreementProfileAttribute

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementProfileAttribute"
    }
}

Nested Schema : Extrating

Type: object

Information about an extended rating attribute.

Show Source

label: string

The ERA's label name.
referenceCount: integer (int32)

A number that keeps the reference count. For purchases, the counter is incremented by one. For cancellations, the counter is decreased by one.
status: integer (int32)
The provisioning status. Can be one of the following:
- 0: No operation
- 1: Provisioning ERA
- 2: Provisioning ERA failed
- 3: ERA active
- 4: Unprovisioning ERA
- 5: Unprovisioning ERA failed
- 6: ERA unprovisioned
- 7: Suspending ERA
- 8: ERA suspension failed
- 9: ERA suspended

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string",
            "description":"The ERA's label name."
        },
        "referenceCount":{
            "type":"integer",
            "description":"A number that keeps the reference count. For purchases, the counter is incremented by one. For cancellations, the counter is decreased by one.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The provisioning status. Can be one of the following: <ul><li><b>0</b>: No operation</li><li><b>1</b>: Provisioning ERA</li><li><b>2</b>: Provisioning ERA failed</li><li><b>3</b>: ERA active</li><li><b>4</b>: Unprovisioning ERA</li><li><b>5</b>: Unprovisioning ERA failed</li><li><b>6</b>: ERA unprovisioned</li><li><b>7</b>: Suspending ERA</li><li><b>8</b>: ERA suspension failed</li><li><b>9</b>: ERA suspended</li></ul>",
            "format":"int32"
        }
    },
    "description":"Information about an extended rating attribute."
}

Nested Schema : AgreementProfileAttribute

Type: object

Show Source

action: string

Allowed Values: [ "ADD", "REMOVE", "REPLACE" ]
id: object ResourceRef
name(required): string
recId: integer (int32)
validFrom: integer (int64)
validTo: integer (int64)
value: string

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "enum":[
                "ADD",
                "REMOVE",
                "REPLACE"
            ]
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "recId":{
            "type":"integer",
            "format":"int32"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "validFrom":{
            "type":"integer",
            "format":"int64"
        },
        "validTo":{
            "type":"integer",
            "format":"int64"
        }
    }
}

400 Response

The request is not valid.

500 Response

An internal server error occurred.