TAG LINE
SMALL TITLE

Owner

(API Version v4)


Represents a business unit or corporate entity within the system. Currently limited to one business unit.


What can you do with Owner?


Properties

Property Details
identity
READ-ONLY
"identity": 2
Type: Number
This is the unique numeric identifier for the Owner
name
READ-ONLY
"name": "Default Owner"
Type: String
User defined name for this Owner.
tree
"tree": "1"
Type: String
Represents the level in which this Owner exists in the corporate hierarchy.
fiscalYearStartingMonth
"fiscalYearStartingMonth": 1
Type: Number
Represents the month in which the fiscal year begins.
amountPrecision
"amountPrecision": 2
Type: Number
Number of decimal points to round when generating charges. Maximum allowed is 11.
largeLogo
"largeLogo": "base64encoded"
Type: String
Large logo to show in the menu and login screen
smallLogo
"smallLogo": "base64encoded"
Type: String
Small logo to show in the menu when displayed on a smaller screen form factor such as a tablet.
primaryColor
"primaryColor": "#000000"
Type: String
unused
secondaryColor
"secondaryColor": "#0000FF"
Type: String
unused
dynamicUsageClassExtensionAttributeId
"dynamicUsageClassExtensionAttributeId": 17
Type: Number
Unique identifier for the associated ExtensionAttribute object.
dynamicUsageClassExtensionAttributeName
"dynamicUsageClassExtensionAttributeName": "Sample Name"
Type: String
The name of the object associated with the dynamicUsageClassExtensionAttributeId property.
defaultLocaleId
"defaultLocaleId": 5
Type: Number
Unique identifier for the associated Locale object.
defaultLocaleName
"defaultLocaleName": "Sample Name"
Type: String
The name of the object associated with the defaultLocaleId property.
realTimeUsageTaxation
"realTimeUsageTaxation": true
Type: Boolean
Whether or not to tax usage at time of real-time rating.
isCustomerPortalActive
"isCustomerPortalActive": true
Type: Boolean
Whether or not the built in Customer portal option is active and available for your customers.
roundingMethodTypeId
"roundingMethodTypeId": 18
Type: Number
Unique identifier for the associated RoundingMethodType object.
roundingMethodTypeName
"roundingMethodTypeName": "Sample Name"
Type: String
The name of the object associated with the roundingMethodTypeId property.
usageBillingGraceDays
"usageBillingGraceDays": 10
Type: Number
This represents a late usage rating threshold. The threshold on how many days in the past the system will honor when usage arrives late in the system.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Owner object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

GETapi/v4/Owner/
Retrieve all of the Owner objects.
Retrieve all of the Owner objects.
GET api/v4/Owner/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Default Owner",
            "tree": "1",
            "fiscalYearStartingMonth": "1",
            "amountPrecision": "2",
            "largeLogo": "base64encoded",
            "smallLogo": "base64encoded",
            "primaryColor": "#000000",
            "secondaryColor": "#0000FF",
            "dynamicUsageClassExtensionAttributeId": 6,
            "dynamicUsageClassExtensionAttributeName": "Sample Text Data",
            "defaultLocaleId": 24,
            "defaultLocaleName": "Sample Text Data",
            "realTimeUsageTaxation": true,
            "isCustomerPortalActive": true,
            "roundingMethodTypeId": 12,
            "roundingMethodTypeName": "Sample Text Data",
            "usageBillingGraceDays": "10"
        }
    ]
}
GETapi/v4/Owner/Paged
Retrieve all of the Owner 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 Owner objects in a paged fashion.
GET api/v4/Owner/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,
                "name": "Default Owner",
                "tree": "1",
                "fiscalYearStartingMonth": "1",
                "amountPrecision": "2",
                "largeLogo": "base64encoded",
                "smallLogo": "base64encoded",
                "primaryColor": "#000000",
                "secondaryColor": "#0000FF",
                "dynamicUsageClassExtensionAttributeId": 17,
                "dynamicUsageClassExtensionAttributeName": "Sample Text Data",
                "defaultLocaleId": 9,
                "defaultLocaleName": "Sample Text Data",
                "realTimeUsageTaxation": true,
                "isCustomerPortalActive": true,
                "roundingMethodTypeId": 17,
                "roundingMethodTypeName": "Sample Text Data",
                "usageBillingGraceDays": "10"
            }
        ]
    }
}
GETapi/v4/Owner/Paged/Detail
Retrieve all of the Owner objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the Owner objects in a paged fashion with all object details.
GET api/v4/Owner/Paged/Detail
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,
                "name": "Default Owner",
                "tree": "1",
                "fiscalYearStartingMonth": "1",
                "amountPrecision": "2",
                "largeLogo": "base64encoded",
                "smallLogo": "base64encoded",
                "primaryColor": "#000000",
                "secondaryColor": "#0000FF",
                "dynamicUsageClassExtensionAttributeId": 15,
                "dynamicUsageClassExtensionAttributeName": "Sample Text Data",
                "defaultLocaleId": 27,
                "defaultLocaleName": "Sample Text Data",
                "realTimeUsageTaxation": true,
                "isCustomerPortalActive": true,
                "roundingMethodTypeId": 4,
                "roundingMethodTypeName": "Sample Text Data",
                "usageBillingGraceDays": "10",
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Owner/{id}
Retrieve an instance of the Owner object by its ID.
{id}Unique identifier for the Owner object.
Retrieve an instance of the Owner object by its ID.
GET api/v4/Owner/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Default Owner",
        "tree": "1",
        "fiscalYearStartingMonth": "1",
        "amountPrecision": "2",
        "largeLogo": "base64encoded",
        "smallLogo": "base64encoded",
        "primaryColor": "#000000",
        "secondaryColor": "#0000FF",
        "dynamicUsageClassExtensionAttributeId": 15,
        "dynamicUsageClassExtensionAttributeName": "Sample Text Data",
        "defaultLocaleId": 14,
        "defaultLocaleName": "Sample Text Data",
        "realTimeUsageTaxation": true,
        "isCustomerPortalActive": true,
        "roundingMethodTypeId": 24,
        "roundingMethodTypeName": "Sample Text Data",
        "usageBillingGraceDays": "10"
    }
}
GETapi/v4/Owner/{id}/Detail
Retrieve deep detail of the Owner object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the Owner object.
Retrieve deep detail of the Owner object by its ID.
GET api/v4/Owner/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Default Owner",
        "tree": "1",
        "fiscalYearStartingMonth": "1",
        "amountPrecision": "2",
        "largeLogo": "base64encoded",
        "smallLogo": "base64encoded",
        "primaryColor": "#000000",
        "secondaryColor": "#0000FF",
        "dynamicUsageClassExtensionAttributeId": 4,
        "dynamicUsageClassExtensionAttributeName": "Sample Text Data",
        "defaultLocaleId": 27,
        "defaultLocaleName": "Sample Text Data",
        "realTimeUsageTaxation": true,
        "isCustomerPortalActive": true,
        "roundingMethodTypeId": 10,
        "roundingMethodTypeName": "Sample Text Data",
        "usageBillingGraceDays": "10",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Owner/{id}
Update or Add the Owner object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the Owner object.
Update or Add the Owner object and optionally make changes to any child objects.
PATCH api/v4/Owner/{id}

{
    "details": {},
    "owners": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "tree": "1",
                "fiscalYearStartingMonth": "1",
                "amountPrecision": "2",
                "largeLogo": "base64encoded",
                "smallLogo": "base64encoded",
                "primaryColor": "#000000",
                "secondaryColor": "#0000FF",
                "dynamicUsageClassExtensionAttributeId": 20,
                "defaultLocaleId": 5,
                "realTimeUsageTaxation": true,
                "isCustomerPortalActive": true,
                "roundingMethodTypeId": 9,
                "usageBillingGraceDays": "10"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "owner",
                "instance": {
                    "identity": 1,
                    "name": "Default Owner",
                    "tree": "1",
                    "fiscalYearStartingMonth": "1",
                    "amountPrecision": "2",
                    "largeLogo": "base64encoded",
                    "smallLogo": "base64encoded",
                    "primaryColor": "#000000",
                    "secondaryColor": "#0000FF",
                    "dynamicUsageClassExtensionAttributeId": 9,
                    "dynamicUsageClassExtensionAttributeName": "Sample Text Data",
                    "defaultLocaleId": 20,
                    "defaultLocaleName": "Sample Text Data",
                    "realTimeUsageTaxation": true,
                    "isCustomerPortalActive": true,
                    "roundingMethodTypeId": 21,
                    "roundingMethodTypeName": "Sample Text Data",
                    "usageBillingGraceDays": "10"
                }
            }
        ]
    }
}
POSTapi/v4/Owner/Search
Retreive a list of Owner 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 Owner objects based on search criteria.
POST api/v4/Owner/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,
            "name": "Default Owner",
            "tree": "1",
            "fiscalYearStartingMonth": "1",
            "amountPrecision": "2",
            "largeLogo": "base64encoded",
            "smallLogo": "base64encoded",
            "primaryColor": "#000000",
            "secondaryColor": "#0000FF",
            "dynamicUsageClassExtensionAttributeId": 7,
            "dynamicUsageClassExtensionAttributeName": "Sample Text Data",
            "defaultLocaleId": 2,
            "defaultLocaleName": "Sample Text Data",
            "realTimeUsageTaxation": true,
            "isCustomerPortalActive": true,
            "roundingMethodTypeId": 25,
            "roundingMethodTypeName": "Sample Text Data",
            "usageBillingGraceDays": "10"
        }
    ]
}