Owner

What can you do with Owner?


Properties

Property Details
id
"id": 877
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": 47
Type: Number
ratePrecision
"ratePrecision": 365
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


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

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

DELETEapi/v1/Owner/{id:int}
Delete an instance of the Owner object.
GETapi/v1/Owner
Retrieve all of the Owner objects.
GETapi/v1/Owner/Metadata
Retrieve all of the meta data details of the Owner object.
GETapi/v1/Owner/Metadata/{option}
Retrieve all the meta data details of the Owner object based on provided options.
{option}Metadata options for the Owner object.
GETapi/v1/Owner/Paged
Retreive all of the Owner objects in a paged fashion.
GETapi/v1/Owner/Paged/Detail
Retreive all of the Owner objects in a paged fashion with all object details.
GETapi/v1/Owner/{id:int}
Retrieve an instance of the Owner object by it's ID.
{id:int}Unique identifier for the Owner object.
GETapi/v1/Owner/{id:int}/Detail
Retreive all of the Detail objects for the specified Owner.
{id:int}Unique identifier for the Owner object.
PATCHapi/v1/Owner/{id:int}
Update the Owner object and optionally make changes to any child objects.
POSTapi/v1/Owner
Create a new instance of the Owner object.
PUTapi/v1/Owner/{id:int}
Update an existing instance of the Owner object.