TAG LINE
TAG LINE
SMALL TITLE
Represents a business unit or corporate entity within the system. Currently limited to one business unit.
identity READ-ONLY | "identity": 4 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. |
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": 24 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": 13 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": 14 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. |
isReportingDatabaseEnabled | "isReportingDatabaseEnabled": true Type: Boolean Identifies if a reporting database is enabled in the system. |
displayName | "displayName": "Hello World" Type: String An optional display only name for the Owner. |
vatNumber | "vatNumber": "VAT0001IE" Type: String The VAT number of the owner. |
bankingReferenceIdentifier | "bankingReferenceIdentifier": "Hello World" Type: String Seller identifier or bank assigned creditor identifier |
registrationIdentifier | "registrationIdentifier": "Hello World" Type: String Seller legal registration identifier. |
electronicInvoiceEndpointIdentifier | "electronicInvoiceEndpointIdentifier": "Hello World" Type: String Whether or not the built in Customer portal option is active and available for your customers. |
billPrepaidAdjustments | "billPrepaidAdjustments": true Type: Boolean Controlls how the customer's prepaid periods are billed (default is true). If false, only charges dated up to the next bill day of the package are billed. |
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. 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:
| GET | Owner/ |
| Retrieve Owner information. | |
Retrieve Owner information. GET Owner/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Default Owner",
"fiscalYearStartingMonth": "1",
"amountPrecision": "2",
"largeLogo": "base64encoded",
"smallLogo": "base64encoded",
"primaryColor": "#000000",
"secondaryColor": "#0000FF",
"dynamicUsageClassExtensionAttributeId": 11,
"dynamicUsageClassExtensionAttributeName": "Sample Text Data",
"defaultLocaleId": 3,
"defaultLocaleName": "Sample Text Data",
"realTimeUsageTaxation": true,
"isCustomerPortalActive": true,
"roundingMethodTypeId": 14,
"roundingMethodTypeName": "Sample Text Data",
"usageBillingGraceDays": "10",
"isReportingDatabaseEnabled": true,
"displayName": "Sample Text Data",
"vatNumber": "VAT0001IE",
"bankingReferenceIdentifier": "Sample Text Data",
"registrationIdentifier": "Sample Text Data",
"electronicInvoiceEndpointIdentifier": "Sample Text Data",
"billPrepaidAdjustments": true
}
]
} | |
| GET | Owner/Paged |
| Retrieve Owner information. 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 Owner information. GET Owner/Paged 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",
"fiscalYearStartingMonth": "1",
"amountPrecision": "2",
"largeLogo": "base64encoded",
"smallLogo": "base64encoded",
"primaryColor": "#000000",
"secondaryColor": "#0000FF",
"dynamicUsageClassExtensionAttributeId": 21,
"dynamicUsageClassExtensionAttributeName": "Sample Text Data",
"defaultLocaleId": 16,
"defaultLocaleName": "Sample Text Data",
"realTimeUsageTaxation": true,
"isCustomerPortalActive": true,
"roundingMethodTypeId": 2,
"roundingMethodTypeName": "Sample Text Data",
"usageBillingGraceDays": "10",
"isReportingDatabaseEnabled": true,
"displayName": "Sample Text Data",
"vatNumber": "VAT0001IE",
"bankingReferenceIdentifier": "Sample Text Data",
"registrationIdentifier": "Sample Text Data",
"electronicInvoiceEndpointIdentifier": "Sample Text Data",
"billPrepaidAdjustments": true
}
]
}
} | |
| GET | Owner/Paged/Detail |
| Retrieve Owner information. 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 Owner information. GET Owner/Paged/Detail 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",
"fiscalYearStartingMonth": "1",
"amountPrecision": "2",
"largeLogo": "base64encoded",
"smallLogo": "base64encoded",
"primaryColor": "#000000",
"secondaryColor": "#0000FF",
"dynamicUsageClassExtensionAttributeId": 2,
"dynamicUsageClassExtensionAttributeName": "Sample Text Data",
"defaultLocaleId": 19,
"defaultLocaleName": "Sample Text Data",
"realTimeUsageTaxation": true,
"isCustomerPortalActive": true,
"roundingMethodTypeId": 8,
"roundingMethodTypeName": "Sample Text Data",
"usageBillingGraceDays": "10",
"isReportingDatabaseEnabled": true,
"displayName": "Sample Text Data",
"vatNumber": "VAT0001IE",
"bankingReferenceIdentifier": "Sample Text Data",
"registrationIdentifier": "Sample Text Data",
"electronicInvoiceEndpointIdentifier": "Sample Text Data",
"billPrepaidAdjustments": true,
"details": {
"currentRatePlan": {
"identity": 51,
"name": "Sample Text Data",
"displayName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z"
},
"currencies": [
{
"identity": 97,
"name": "Sample Text Data",
"code": "Sample Text Data",
"symbol": "Sample Text Data",
"isDefault": true
}
],
"contacts": [
{
"identity": 4,
"contactTypeId": 74,
"contactTypeName": "Sample Text Data",
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"isUsedForTax": true,
"updated": "2021-04-26T15:25:27.587Z",
"name": "Sample Text Data",
"details": {
"contactPoints": [
{
"identity": 42,
"contactPointTypeId": 53,
"contactPointTypeName": "Sample Text Data",
"value": "Sample Text Data",
"contactId": 10,
"updated": "2021-04-26T15:25:27.587Z"
}
],
"address": {
"identity": 30,
"address1": "Sample Text Data",
"address2": "Sample Text Data",
"stateId": 95,
"stateName": "Sample Text Data",
"countryId": 57,
"countryName": "Sample Text Data",
"zipCode": "Sample Text Data",
"latitude": 74.84,
"longitude": 50.67,
"cityName": "Sample Text Data",
"taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z",
"isIncorporated": true,
"updated": "2021-04-26T15:25:27.587Z",
"stateCode": "Sample Text Data",
"countryCode": "Sample Text Data",
"fetchTaxJurisdicationAsync": true
}
}
}
],
"customerPortalSetting": {
"identity": 16,
"allowPayments": true,
"allowPaymentMethodCreation": true,
"allowPaymentMethodUpdate": true,
"allowPaymentProductCancellation": true,
"largeLogo": "Sample Text Data",
"smallLogo": "Sample Text Data",
"primaryColor": "Sample Text Data",
"secondaryColor": "Sample Text Data",
"title": "Sample Text Data",
"description": "Sample Text Data",
"useParentChildHierarchy": true
},
"samlSetting": {
"identity": 5,
"entityIdentifier": "Sample Text Data",
"federationMetadataURL": "Sample Text Data",
"isActive": true,
"scimToken": "Sample Text Data"
}
}
}
]
}
} | |
| GET | Owner/{id} |
| Retrieve Owner information. | |
| {id} | Unique identifier for the Owner object. |
Retrieve Owner information. GET Owner/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Default Owner",
"fiscalYearStartingMonth": "1",
"amountPrecision": "2",
"largeLogo": "base64encoded",
"smallLogo": "base64encoded",
"primaryColor": "#000000",
"secondaryColor": "#0000FF",
"dynamicUsageClassExtensionAttributeId": 25,
"dynamicUsageClassExtensionAttributeName": "Sample Text Data",
"defaultLocaleId": 17,
"defaultLocaleName": "Sample Text Data",
"realTimeUsageTaxation": true,
"isCustomerPortalActive": true,
"roundingMethodTypeId": 8,
"roundingMethodTypeName": "Sample Text Data",
"usageBillingGraceDays": "10",
"isReportingDatabaseEnabled": true,
"displayName": "Sample Text Data",
"vatNumber": "VAT0001IE",
"bankingReferenceIdentifier": "Sample Text Data",
"registrationIdentifier": "Sample Text Data",
"electronicInvoiceEndpointIdentifier": "Sample Text Data",
"billPrepaidAdjustments": true
}
} | |
| GET | Owner/{id}/Detail |
| Retrieve Owner information. 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 Owner information. GET Owner/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Default Owner",
"fiscalYearStartingMonth": "1",
"amountPrecision": "2",
"largeLogo": "base64encoded",
"smallLogo": "base64encoded",
"primaryColor": "#000000",
"secondaryColor": "#0000FF",
"dynamicUsageClassExtensionAttributeId": 8,
"dynamicUsageClassExtensionAttributeName": "Sample Text Data",
"defaultLocaleId": 17,
"defaultLocaleName": "Sample Text Data",
"realTimeUsageTaxation": true,
"isCustomerPortalActive": true,
"roundingMethodTypeId": 15,
"roundingMethodTypeName": "Sample Text Data",
"usageBillingGraceDays": "10",
"isReportingDatabaseEnabled": true,
"displayName": "Sample Text Data",
"vatNumber": "VAT0001IE",
"bankingReferenceIdentifier": "Sample Text Data",
"registrationIdentifier": "Sample Text Data",
"electronicInvoiceEndpointIdentifier": "Sample Text Data",
"billPrepaidAdjustments": true,
"details": {
"currentRatePlan": {
"identity": 51,
"name": "Sample Text Data",
"displayName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"start": "2021-04-26T15:25:27.587Z"
},
"currencies": [
{
"identity": 97,
"name": "Sample Text Data",
"code": "Sample Text Data",
"symbol": "Sample Text Data",
"isDefault": true
}
],
"contacts": [
{
"identity": 4,
"contactTypeId": 74,
"contactTypeName": "Sample Text Data",
"title": "Sample Text Data",
"firstName": "Sample Text Data",
"lastName": "Sample Text Data",
"isUsedForTax": true,
"updated": "2021-04-26T15:25:27.587Z",
"name": "Sample Text Data",
"details": {
"contactPoints": [
{
"identity": 42,
"contactPointTypeId": 53,
"contactPointTypeName": "Sample Text Data",
"value": "Sample Text Data",
"contactId": 10,
"updated": "2021-04-26T15:25:27.587Z"
}
],
"address": {
"identity": 30,
"address1": "Sample Text Data",
"address2": "Sample Text Data",
"stateId": 95,
"stateName": "Sample Text Data",
"countryId": 57,
"countryName": "Sample Text Data",
"zipCode": "Sample Text Data",
"latitude": 74.84,
"longitude": 50.67,
"cityName": "Sample Text Data",
"taxJurisdictionCodeUpdated": "2021-04-26T15:25:27.587Z",
"isIncorporated": true,
"updated": "2021-04-26T15:25:27.587Z",
"stateCode": "Sample Text Data",
"countryCode": "Sample Text Data",
"fetchTaxJurisdicationAsync": true
}
}
}
],
"customerPortalSetting": {
"identity": 16,
"allowPayments": true,
"allowPaymentMethodCreation": true,
"allowPaymentMethodUpdate": true,
"allowPaymentProductCancellation": true,
"largeLogo": "Sample Text Data",
"smallLogo": "Sample Text Data",
"primaryColor": "Sample Text Data",
"secondaryColor": "Sample Text Data",
"title": "Sample Text Data",
"description": "Sample Text Data",
"useParentChildHierarchy": true
},
"samlSetting": {
"identity": 5,
"entityIdentifier": "Sample Text Data",
"federationMetadataURL": "Sample Text Data",
"isActive": true,
"scimToken": "Sample Text Data"
}
}
}
} | |
| PATCH | 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 Owner/{id}
{
"details": {},
"owners": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"fiscalYearStartingMonth": "1",
"amountPrecision": "2",
"largeLogo": "base64encoded",
"smallLogo": "base64encoded",
"primaryColor": "#000000",
"secondaryColor": "#0000FF",
"dynamicUsageClassExtensionAttributeId": 9,
"defaultLocaleId": 23,
"realTimeUsageTaxation": true,
"isCustomerPortalActive": true,
"roundingMethodTypeId": 5,
"usageBillingGraceDays": "10",
"isReportingDatabaseEnabled": true,
"displayName": "Sample Text Data",
"vatNumber": "VAT0001IE",
"bankingReferenceIdentifier": "Sample Text Data",
"registrationIdentifier": "Sample Text Data",
"electronicInvoiceEndpointIdentifier": "Sample Text Data",
"billPrepaidAdjustments": true
}
]
}
}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",
"fiscalYearStartingMonth": "1",
"amountPrecision": "2",
"largeLogo": "base64encoded",
"smallLogo": "base64encoded",
"primaryColor": "#000000",
"secondaryColor": "#0000FF",
"dynamicUsageClassExtensionAttributeId": 23,
"dynamicUsageClassExtensionAttributeName": "Sample Text Data",
"defaultLocaleId": 20,
"defaultLocaleName": "Sample Text Data",
"realTimeUsageTaxation": true,
"isCustomerPortalActive": true,
"roundingMethodTypeId": 26,
"roundingMethodTypeName": "Sample Text Data",
"usageBillingGraceDays": "10",
"isReportingDatabaseEnabled": true,
"displayName": "Sample Text Data",
"vatNumber": "VAT0001IE",
"bankingReferenceIdentifier": "Sample Text Data",
"registrationIdentifier": "Sample Text Data",
"electronicInvoiceEndpointIdentifier": "Sample Text Data",
"billPrepaidAdjustments": true
}
}
]
}
} | |