Owner

(API Version v2)

What can you do with Owner?

GET api/v2/Owner
GET api/v2/Owner/Paged
GET api/v2/Owner/Paged/Detail
GET api/v2/Owner/{id:int}
GET api/v2/Owner/{id:int}/Detail
PATCH api/v2/Owner/{id:int}

Properties

Property Details

id	"id": 4 Type: Number This is the unique numeric identifier for the Owner
name	"name": "Hello World" Type: String
tree	"tree": "Hello World" Type: String
fiscalYearStartingMonth	"fiscalYearStartingMonth": 10 Type: Number
ratePrecision	"ratePrecision": 6 Type: Number
largeLogo	"largeLogo": "Hello World" Type: String
smallLogo	"smallLogo": "Hello World" Type: String
primaryColor	"primaryColor": "Hello World" Type: String
secondaryColor	"secondaryColor": "Hello World" Type: String
dynamicUsageClassExtensionAttributeId	"dynamicUsageClassExtensionAttributeId": 16 Type: Number Unique identifier for the associated ExtensionAttribute object.
defaultLocaleId	"defaultLocaleId": 17 Type: Number Unique identifier for the associated Locale object.
realTimeUsageTaxation	"realTimeUsageTaxation": true Type: Boolean

Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

name
tree
fiscalYearStartingMonth
ratePrecision
largeLogo
smallLogo
primaryColor
secondaryColor
dynamicUsageClassExtensionAttributeId
defaultLocaleId
realTimeUsageTaxation

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:

usageRatePlan - update, delete
currency - create, update, delete

DataFlow PATCH objects:

owner - create, update, delete
usageRatePlan - update, delete
currency - create, update, delete

End Points

GET	api/v2/Owner
Retrieve all of the Owner objects.

GET	api/v2/Owner/Paged
Retreive all of the Owner objects in a paged fashion.

GET	api/v2/Owner/Paged/Detail
Retreive all of the Owner objects in a paged fashion with all object details.

GET	api/v2/Owner/{id:int}
Retrieve an instance of the Owner object by it's ID.
{id:int}	Unique identifier for the Owner object.

GET	api/v2/Owner/{id:int}/Detail
Retreive all of the Detail objects for the specified Owner.
{id:int}	Unique identifier for the Owner object.

PATCH	api/v2/Owner/{id:int}
Update the Owner object and optionally make changes to any child objects.