TAG LINE
SMALL TITLE

Usage / Billing Type

(API Version v4)


What can you do with UsageBillingType?


Properties

Property Details
identity
READ-ONLY
"identity": 15
Type: Number
This is the unique numeric identifier for the UsageBillingType
ownerId
READ-ONLY
"ownerId": 9
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Hello World"
Type: String
number
"number": 22
Type: Number
usageBillingTypeTypeId
"usageBillingTypeTypeId": 3
Type: Number
Unique identifier for the associated UsageBillingTypeType object.
usageBillingTypeTypeName
"usageBillingTypeTypeName": "Sample Name"
Type: String
The name of the object associated with the usageBillingTypeTypeId property.


End Points

DELETEapi/v4/Usage/BillingType/{id}
Delete an instance of the UsageBillingType object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the UsageBillingType object.
Delete an instance of the UsageBillingType object.
DELETE api/v4/Usage/BillingType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "usageBillingType"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Usage/BillingType/
Retrieve all of the UsageBillingType objects.
Retrieve all of the UsageBillingType objects.
GET api/v4/Usage/BillingType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 7,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "number": 5,
            "usageBillingTypeTypeId": 26,
            "usageBillingTypeTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Usage/BillingType/Paged
Retrieve all of the UsageBillingType objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the UsageBillingType objects in a paged fashion.
GET api/v4/Usage/BillingType/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "number": 26,
                "usageBillingTypeTypeId": 7,
                "usageBillingTypeTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Usage/BillingType/{id}
Retrieve an instance of the UsageBillingType object by its ID.
{id}Unique identifier for the UsageBillingType object.
Retrieve an instance of the UsageBillingType object by its ID.
GET api/v4/Usage/BillingType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 22,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "number": 24,
        "usageBillingTypeTypeId": 18,
        "usageBillingTypeTypeName": "Sample Text Data"
    }
}
POSTapi/v4/Usage/BillingType/
Create a new instance of the UsageBillingType object.
Create a new instance of the UsageBillingType object.
POST api/v4/Usage/BillingType/

{
    "name": "Sample Text Data",
    "number": 4,
    "usageBillingTypeTypeId": 22
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 6,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "number": 23,
                "usageBillingTypeTypeId": 9,
                "usageBillingTypeTypeName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Usage/BillingType/Search
Retreive a list of UsageBillingType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of UsageBillingType objects based on search criteria.
POST api/v4/Usage/BillingType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 21,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "number": 13,
            "usageBillingTypeTypeId": 13,
            "usageBillingTypeTypeName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Usage/BillingType/{id}
Update an existing instance of the UsageBillingType object.
Update an existing instance of the UsageBillingType object.
PUT api/v4/Usage/BillingType/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "number": 20,
    "usageBillingTypeTypeId": 4
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 0,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "number": 5,
                "usageBillingTypeTypeId": 11,
                "usageBillingTypeTypeName": "Sample Text Data"
            }
        ]
    }
}