TAG LINE
TAG LINE
SMALL TITLE
Details of user defined templates within the system.
identity READ-ONLY | "identity": 1 Type: Number This is the unique numeric identifier for the Template |
ownerId READ-ONLY | "ownerId": 23 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "12 months" Type: String User defined name for the Template |
dateFormat | "dateFormat": "dd-MMM-yyyy" Type: String Date format used in the template. |
dateTimeFormat | "dateTimeFormat": "dd-MMM-yyyy HH:mm:ss" Type: String Date and time format used in the template. |
description | "description": "Hello World" Type: String Description of the template. |
localeId | "localeId": 15 Type: Number Unique identifier for the associated Locale object. |
localeName | "localeName": "Sample Name" Type: String The name of the object associated with the localeId property. |
currencyPrecision | "currencyPrecision": 2 Type: Number Number of decimal places in use for the currency. |
createdByUserId | "createdByUserId": 13 Type: Number Unique identifier for the associated User object. |
createdByUserName | "createdByUserName": "Sample Name" Type: String The name of the object associated with the createdByUserId property. |
created READ-ONLY | "created": "2021-04-26T15:25:27.587Z" Type: Date This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format. |
updatedByUserId | "updatedByUserId": 22 Type: Number Unique identifier for the associated User object. |
updatedByUserName | "updatedByUserName": "Sample Name" Type: String The name of the object associated with the updatedByUserId property. |
updated READ-ONLY | "updated": "2021-04-26T15:25:27.587Z" Type: Date The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format. |
templateTypeId | "templateTypeId": 13 Type: Number Unique identifier for the associated TemplateType object. |
templateTypeName | "templateTypeName": "Sample Name" Type: String The name of the object associated with the templateTypeId property. |
excludeZeroValueInvoiceItems | "excludeZeroValueInvoiceItems": true Type: Boolean Whether or not to include zero value charges. |
documentStorageLocationId | "documentStorageLocationId": 20 Type: Number Unique identifier for the associated StorageLocation object. |
documentStorageLocationName | "documentStorageLocationName": "Sample Name" Type: String The name of the object associated with the documentStorageLocationId property. |
fileName | "fileName": "Hello World" Type: String The file name of the template. |
documentIdentifier | "documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f" Type: String Unique identifier of the template document. |
isCore | "isCore": true Type: Boolean Whether or not the is core. |
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 Template object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | Template/{id} |
| Delete an instance of the Template object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the Template object. |
Delete an instance of the Template object. DELETE Template/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "template"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Template/ |
| Retrieve all of the Template objects. | |
Retrieve all of the Template objects. GET Template/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 20,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 24,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 21,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 2,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 24,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 11,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
]
} | |
| GET | Template/Paged |
| Retrieve all of the Template 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 Template objects in a paged fashion. GET Template/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,
"ownerId": 4,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 14,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 23,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 7,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 9,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 7,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
]
}
} | |
| GET | Template/{id} |
| Retrieve an instance of the Template object by its ID. | |
| {id} | Unique identifier for the Template object. |
Retrieve an instance of the Template object by its ID. GET Template/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 13,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 16,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 4,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 18,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 2,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 22,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
} | |
| GET | Template/{id}/Detail |
| Retrieve deep detail of the Template 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 Template object. |
Retrieve deep detail of the Template object by its ID. GET Template/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 19,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 11,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 0,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 10,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 12,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 8,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true,
"details": {
"templateReportDefinitions": [
{
"identity": 87,
"templateId": 76,
"templateName": "Sample Text Data",
"reportDefinitionId": 21,
"reportDefinitionName": "Sample Text Data",
"alias": "Sample Text Data"
}
],
"templateCurrencyFormats": [
{
"identity": 45,
"templateId": 37,
"templateName": "Sample Text Data",
"currencyId": 45,
"currencyName": "Sample Text Data",
"localeId": 85,
"localeName": "Sample Text Data",
"currencyCode": "Sample Text Data"
}
]
}
}
} | |
| PATCH | Template/Invoice/{id} |
| Update or Add the Template 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 Template object. |
Update or Add the Template object and optionally make changes to any child objects. PATCH Template/Invoice/{id}
{
"details": {},
"templates": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 26,
"currencyPrecision": "2",
"createdByUserId": 23,
"updatedByUserId": 0,
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 17,
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 6,
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "template",
"instance": {
"identity": 1,
"ownerId": 26,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 7,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 6,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 13,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 4,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 0,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
}
]
}
} | |
| POST | Template/CreditNote |
| Create a new instance of the Template object. | |
Create a new instance of the Template object. POST Template/CreditNote
{
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 13,
"currencyPrecision": "2",
"createdByUserId": 7,
"updatedByUserId": 9,
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 9,
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 2,
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 19,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 22,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 18,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 15,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 1,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 8,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
]
}
} | |
| POST | Template/Invoice |
| Create a new instance of the Template object. | |
Create a new instance of the Template object. POST Template/Invoice
{
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 19,
"currencyPrecision": "2",
"createdByUserId": 25,
"updatedByUserId": 23,
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 13,
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 19,
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 3,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 27,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 25,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 26,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 10,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 4,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
]
}
} | |
| PUT | Template/CreditNote/{id} |
| Update an existing instance of the Template object. | |
Update an existing instance of the Template object. PUT Template/CreditNote/{id}
{
"identity": 1,
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 0,
"currencyPrecision": "2",
"createdByUserId": 18,
"updatedByUserId": 7,
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 6,
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 26,
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 16,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 12,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 8,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 14,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 9,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
]
}
} | |
| PUT | Template/Invoice/{id} |
| Update an existing instance of the Template object. | |
Update an existing instance of the Template object. PUT Template/Invoice/{id}
{
"identity": 1,
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 15,
"currencyPrecision": "2",
"createdByUserId": 20,
"updatedByUserId": 16,
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 25,
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 15,
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 15,
"ownerName": "Sample Text Data",
"name": "12 months",
"dateFormat": "dd-MMM-yyyy",
"dateTimeFormat": "dd-MMM-yyyy HH:mm:ss",
"description": "Sample Text Data",
"localeId": 26,
"localeName": "Sample Text Data",
"currencyPrecision": "2",
"createdByUserId": 24,
"createdByUserName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updatedByUserId": 2,
"updatedByUserName": "Sample Text Data",
"updated": "2021-04-26T15:25:27.587Z",
"templateTypeId": 25,
"templateTypeName": "Sample Text Data",
"excludeZeroValueInvoiceItems": true,
"documentStorageLocationId": 10,
"documentStorageLocationName": "Sample Text Data",
"fileName": "Sample Text Data",
"documentIdentifier": "32bb4ce1-cc03-4eb1-9d3b-381f74a1fa1f",
"isCore": true
}
]
}
} | |