Accounting | External Invoice Template

Service to manage entities of type 'InvoiceTemplate'.

Overview

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates

URL	api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates
Methods Supported	GET

All Operations

This service includes the following operations:

GET:

All Resources

This service uses the following resources:

ExternalInvoiceTemplateLineResource
ExternalInvoiceTemplateResource

GET Operations

GET ExternalInvoiceTemplates

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See ExternalInvoiceTemplateResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates

GET /accounting/externalInvoiceTemplates

GET ExternalInvoiceTemplates (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See ExternalInvoiceTemplateResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates?page={page}&pageSize={pageSize}

GET /accounting/externalInvoiceTemplates?page={page}&pageSize={pageSize}

GET ExternalInvoiceTemplate by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See ExternalInvoiceTemplateResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates/{id}

GET /accounting/externalInvoiceTemplates/{id}

GET ExternalInvoiceTemplate by key

Returns the entity record that matches the specified key.

The following elements are required:

key	(string) The key for the External Invoice Template.

Response:

When successful, the response body contains the entity record. See ExternalInvoiceTemplateResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates/{key}

GET /accounting/externalInvoiceTemplates/{key}

GET Print ExternalInvoiceTemplate by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates/{id}/print?template={template}

GET /accounting/externalInvoiceTemplates/{id}/print?template={template}

GET Print ExternalInvoiceTemplate by key

Prints the specified entity record.

The following elements are required:

key	(string) The key for the External Invoice Template.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates/{key}/print

GET /accounting/externalInvoiceTemplates/{key}/print

GET Original Print ExternalInvoiceTemplateOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates/{id}/printOriginal?template={template}

GET /accounting/externalInvoiceTemplates/{id}/printOriginal?template={template}

GET Original Print ExternalInvoiceTemplate by key

Prints the specified entity record.

The following elements are required:

key	(string) The key for the External Invoice Template.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/accounting/externalInvoiceTemplates/{key}/printOriginal

GET /accounting/externalInvoiceTemplates/{key}/printOriginal

Resources

ExternalInvoiceTemplateLineResource

The following elements are required:

chartOfAccount	(string) The chart of accounts.
taxClass	(string) Tax Class.
taxTypeCode	(string) The code that identifies the type of tax that will be used to import documents from EInvoice.

The following elements are optional:

costAccount	(string) The cost account associated with the tax type code that will be used to import documents from EInvoice.
exemptionReasonCode	(string) The exemption reason associated to the tax type code.

ExternalInvoiceTemplateResource

The following elements are required:

key	(string) The key for the External Invoice Template.

The following elements are optional:

description	(string) The description for the External Invoice Template.
creditMemoReason	(string) The credit memo reason associated to this template. (fk) Allowed value: the natural key of a record of type MemoReason. These records are accessibly through the MemoReasons service.
debitMemoReason	(string) The debit memo reason associated to this template. (fk) Allowed value: the natural key of a record of type MemoReason. These records are accessibly through the MemoReasons service.
templateLines	(List of ExternalInvoiceTemplateLineResource) The taxes and cost accounts associated with this template, per chart of account, that will be used to import documents from EInvoice. See ExternalInvoiceTemplateLineResource.