TAG LINE
SMALL TITLE

Owner

(API Version v3)


What can you do with Owner?


Properties

Property Details
id
"id": 19
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": 25
Type: Number
ratePrecision
"ratePrecision": 18
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": 21
Type: Number
Unique identifier for the associated ExtensionAttribute object.
defaultLocaleId
"defaultLocaleId": 21
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:

DataFlow PATCH objects:


End Points

GETapi/v3/Owner
Retrieve all of the Owner objects.
GETapi/v3/Owner/Paged
Retreive all of the Owner objects in a paged fashion.
GETapi/v3/Owner/Paged/Detail
Retreive all of the Owner objects in a paged fashion with all object details.
GETapi/v3/Owner/{id:int}
Retrieve an instance of the Owner object by it's ID.
{id:int}Unique identifier for the Owner object.
GETapi/v3/Owner/{id:int}/Detail
Retreive all of the Detail objects for the specified Owner.
{id:int}Unique identifier for the Owner object.
PATCHapi/v3/Owner/{id:int}
Update the Owner object and optionally make changes to any child objects.