TAG LINE
TAG LINE
SMALL TITLE

Template

(API Version v9)


What can you do with Template?


Properties

Property Details
identity
READ-ONLY
"identity": 26
Type: Number
This is the unique numeric identifier for the Template
ownerId
READ-ONLY
"ownerId": 10
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": "Hello World"
Type: String
dateFormat
"dateFormat": "Hello World"
Type: String
dateTimeFormat
"dateTimeFormat": "Hello World"
Type: String
description
"description": "Hello World"
Type: String
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": 6
Type: Number
createdByUserId
"createdByUserId": 24
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": 21
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": 12
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
documentStorageLocationId
"documentStorageLocationId": 19
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
documentIdentifier
"documentIdentifier": "Hello World"
Type: String
isCore
"isCore": true
Type: Boolean


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. Below you will find the child objects that can be updated as part of PATCH operations for the Template object.

Standard PATCH objects:

  • templateReportDefinition - create, update, delete

DataFlow PATCH objects:

  • template - create, update, delete
  • templateReportDefinition - create, update, delete

End Points

DELETETemplate/{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}
View Sample Response
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"
            }
        ]
    }
}
GETTemplate/
Retrieve all of the Template objects.
Retrieve all of the Template objects.
GET Template/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 15,
            "ownerName": "Sample Text Data",
            "name": "Sample Text Data",
            "dateFormat": "Sample Text Data",
            "dateTimeFormat": "Sample Text Data",
            "description": "Sample Text Data",
            "localeId": 11,
            "localeName": "Sample Text Data",
            "currencyPrecision": 11,
            "createdByUserId": 20,
            "createdByUserName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updatedByUserId": 16,
            "updatedByUserName": "Sample Text Data",
            "updated": "2021-04-26T15:25:27.587Z",
            "templateTypeId": 23,
            "templateTypeName": "Sample Text Data",
            "excludeZeroValueInvoiceItems": true,
            "documentStorageLocationId": 12,
            "documentStorageLocationName": "Sample Text Data",
            "fileName": "Sample Text Data",
            "documentIdentifier": "Sample Text Data",
            "isCore": true
        }
    ]
}
GETTemplate/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
View Sample Response
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": 3,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "dateFormat": "Sample Text Data",
                "dateTimeFormat": "Sample Text Data",
                "description": "Sample Text Data",
                "localeId": 23,
                "localeName": "Sample Text Data",
                "currencyPrecision": 20,
                "createdByUserId": 26,
                "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": 13,
                "templateTypeName": "Sample Text Data",
                "excludeZeroValueInvoiceItems": true,
                "documentStorageLocationId": 6,
                "documentStorageLocationName": "Sample Text Data",
                "fileName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "isCore": true
            }
        ]
    }
}
GETTemplate/{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}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 15,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "dateFormat": "Sample Text Data",
        "dateTimeFormat": "Sample Text Data",
        "description": "Sample Text Data",
        "localeId": 20,
        "localeName": "Sample Text Data",
        "currencyPrecision": 20,
        "createdByUserId": 15,
        "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": 11,
        "templateTypeName": "Sample Text Data",
        "excludeZeroValueInvoiceItems": true,
        "documentStorageLocationId": 2,
        "documentStorageLocationName": "Sample Text Data",
        "fileName": "Sample Text Data",
        "documentIdentifier": "Sample Text Data",
        "isCore": true
    }
}
GETTemplate/{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}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 6,
        "ownerName": "Sample Text Data",
        "name": "Sample Text Data",
        "dateFormat": "Sample Text Data",
        "dateTimeFormat": "Sample Text Data",
        "description": "Sample Text Data",
        "localeId": 1,
        "localeName": "Sample Text Data",
        "currencyPrecision": 11,
        "createdByUserId": 6,
        "createdByUserName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updatedByUserId": 1,
        "updatedByUserName": "Sample Text Data",
        "updated": "2021-04-26T15:25:27.587Z",
        "templateTypeId": 4,
        "templateTypeName": "Sample Text Data",
        "excludeZeroValueInvoiceItems": true,
        "documentStorageLocationId": 2,
        "documentStorageLocationName": "Sample Text Data",
        "fileName": "Sample Text Data",
        "documentIdentifier": "Sample Text Data",
        "isCore": true,
        "details": {
            "templateReportDefinitions": [
                {
                    "identity": 44,
                    "templateId": 17,
                    "templateName": "Sample Text Data",
                    "reportDefinitionId": 26,
                    "reportDefinitionName": "Sample Text Data",
                    "alias": "Sample Text Data"
                }
            ],
            "templateCurrencyFormats": [
                {
                    "identity": 60,
                    "templateId": 42,
                    "templateName": "Sample Text Data",
                    "currencyId": 41,
                    "currencyName": "Sample Text Data",
                    "localeId": 90,
                    "localeName": "Sample Text Data",
                    "currencyCode": "Sample Text Data"
                }
            ]
        }
    }
}
PATCHTemplate/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": "Sample Text Data",
                "dateFormat": "Sample Text Data",
                "dateTimeFormat": "Sample Text Data",
                "description": "Sample Text Data",
                "localeId": 20,
                "currencyPrecision": 25,
                "createdByUserId": 0,
                "updatedByUserId": 21,
                "updated": "2021-04-26T15:25:27.587Z",
                "templateTypeId": 10,
                "excludeZeroValueInvoiceItems": true,
                "documentStorageLocationId": 22,
                "fileName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "isCore": true
            }
        ]
    }
}
View Sample Response
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": 10,
                    "ownerName": "Sample Text Data",
                    "name": "Sample Text Data",
                    "dateFormat": "Sample Text Data",
                    "dateTimeFormat": "Sample Text Data",
                    "description": "Sample Text Data",
                    "localeId": 4,
                    "localeName": "Sample Text Data",
                    "currencyPrecision": 14,
                    "createdByUserId": 1,
                    "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": 4,
                    "templateTypeName": "Sample Text Data",
                    "excludeZeroValueInvoiceItems": true,
                    "documentStorageLocationId": 17,
                    "documentStorageLocationName": "Sample Text Data",
                    "fileName": "Sample Text Data",
                    "documentIdentifier": "Sample Text Data",
                    "isCore": true
                }
            }
        ]
    }
}
POSTTemplate/CreditNote
Create a new instance of the Template object.
Create a new instance of the Template object.
POST Template/CreditNote

{
    "name": "Sample Text Data",
    "dateFormat": "Sample Text Data",
    "dateTimeFormat": "Sample Text Data",
    "description": "Sample Text Data",
    "localeId": 4,
    "currencyPrecision": 14,
    "createdByUserId": 13,
    "updatedByUserId": 9,
    "updated": "2021-04-26T15:25:27.587Z",
    "templateTypeId": 9,
    "excludeZeroValueInvoiceItems": true,
    "documentStorageLocationId": 0,
    "fileName": "Sample Text Data",
    "documentIdentifier": "Sample Text Data",
    "isCore": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 8,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "dateFormat": "Sample Text Data",
                "dateTimeFormat": "Sample Text Data",
                "description": "Sample Text Data",
                "localeId": 19,
                "localeName": "Sample Text Data",
                "currencyPrecision": 9,
                "createdByUserId": 17,
                "createdByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 0,
                "updatedByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "templateTypeId": 14,
                "templateTypeName": "Sample Text Data",
                "excludeZeroValueInvoiceItems": true,
                "documentStorageLocationId": 20,
                "documentStorageLocationName": "Sample Text Data",
                "fileName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "isCore": true
            }
        ]
    }
}
POSTTemplate/Invoice
Create a new instance of the Template object.
Create a new instance of the Template object.
POST Template/Invoice

{
    "name": "Sample Text Data",
    "dateFormat": "Sample Text Data",
    "dateTimeFormat": "Sample Text Data",
    "description": "Sample Text Data",
    "localeId": 6,
    "currencyPrecision": 17,
    "createdByUserId": 24,
    "updatedByUserId": 23,
    "updated": "2021-04-26T15:25:27.587Z",
    "templateTypeId": 7,
    "excludeZeroValueInvoiceItems": true,
    "documentStorageLocationId": 8,
    "fileName": "Sample Text Data",
    "documentIdentifier": "Sample Text Data",
    "isCore": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "dateFormat": "Sample Text Data",
                "dateTimeFormat": "Sample Text Data",
                "description": "Sample Text Data",
                "localeId": 20,
                "localeName": "Sample Text Data",
                "currencyPrecision": 10,
                "createdByUserId": 25,
                "createdByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 12,
                "updatedByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "templateTypeId": 4,
                "templateTypeName": "Sample Text Data",
                "excludeZeroValueInvoiceItems": true,
                "documentStorageLocationId": 16,
                "documentStorageLocationName": "Sample Text Data",
                "fileName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "isCore": true
            }
        ]
    }
}
PUTTemplate/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": "Sample Text Data",
    "dateFormat": "Sample Text Data",
    "dateTimeFormat": "Sample Text Data",
    "description": "Sample Text Data",
    "localeId": 17,
    "currencyPrecision": 26,
    "createdByUserId": 7,
    "updatedByUserId": 7,
    "updated": "2021-04-26T15:25:27.587Z",
    "templateTypeId": 9,
    "excludeZeroValueInvoiceItems": true,
    "documentStorageLocationId": 16,
    "fileName": "Sample Text Data",
    "documentIdentifier": "Sample Text Data",
    "isCore": true
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "name": "Sample Text Data",
                "dateFormat": "Sample Text Data",
                "dateTimeFormat": "Sample Text Data",
                "description": "Sample Text Data",
                "localeId": 1,
                "localeName": "Sample Text Data",
                "currencyPrecision": 6,
                "createdByUserId": 10,
                "createdByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 14,
                "updatedByUserName": "Sample Text Data",
                "updated": "2021-04-26T15:25:27.587Z",
                "templateTypeId": 14,
                "templateTypeName": "Sample Text Data",
                "excludeZeroValueInvoiceItems": true,
                "documentStorageLocationId": 6,
                "documentStorageLocationName": "Sample Text Data",
                "fileName": "Sample Text Data",
                "documentIdentifier": "Sample Text Data",
                "isCore": true
            }
        ]
    }
}
PUTTemplate/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": "Sample Text Data",
    "dateFormat": "Sample Text Data",
    "dateTimeFormat": "Sample Text Data",
    "description": "Sample Text Data",
    "localeId": 21,
    "currencyPrecision": 21,
    "createdByUserId": 21,
    "updatedByUserId": 22,
    "updated": "2021-04-26T15:25:27.587Z",
    "templateTypeId": 15,
    "excludeZeroValueInvoiceItems": true,
    "documentStorageLocationId": 17,
    "fileName": "Sample Text Data",
    "documentIdentifier": "Sample Text Data",
    "isCore": true
}
View Sample Response
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": "Sample Text Data",
                "dateFormat": "Sample Text Data",
                "dateTimeFormat": "Sample Text Data",
                "description": "Sample Text Data",
                "localeId": 0,
                "localeName": "Sample Text Data",
                "currencyPrecision": 7,
                "createdByUserId": 0,
                "createdByUserName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updatedByUserId": 16,
                "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": "Sample Text Data",
                "isCore": true
            }
        ]
    }
}