Financials | Receipt Type

Service to manage entities of type 'ReceiptType'.

Overview

api/{tenantKey}/{orgKey}/financialCore/receiptTypes

URL	api/{tenantKey}/{orgKey}/financialCore/receiptTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST ReceiptTypes
- POST Receipt Type
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiReceiptTypeDocumentTypeSeriesResource
ApiReceiptTypeResource
ReceiptTypeResource
ReceiptTypeSerieResource

All Enumerations

This service uses the following enumerations:

AccountingSchema
ATCommunicationStatus

GET Operations

GET ReceiptTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes

GET /financialCore/receiptTypes

GET ReceiptTypes (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 ReceiptTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes?page={page}&pageSize={pageSize}

GET /financialCore/receiptTypes?page={page}&pageSize={pageSize}

GET ReceiptType 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 ReceiptTypeResource.

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}/financialCore/receiptTypes/{id}

GET /financialCore/receiptTypes/{id}

GET ReceiptType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The receipt type's key.

Response:

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

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}/financialCore/receiptTypes/{companyKey}/{typeKey}

GET /financialCore/receiptTypes/{companyKey}/{typeKey}

GET Print ReceiptType 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}/financialCore/receiptTypes/{id}/print?template={template}

GET /financialCore/receiptTypes/{id}/print?template={template}

GET Print ReceiptType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The receipt type's key.

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}/financialCore/receiptTypes/{companyKey}/{typeKey}/print

GET /financialCore/receiptTypes/{companyKey}/{typeKey}/print

GET Original Print ReceiptTypeOriginal 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}/financialCore/receiptTypes/{id}/printOriginal?template={template}

GET /financialCore/receiptTypes/{id}/printOriginal?template={template}

GET Original Print ReceiptType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The receipt type's key.

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}/financialCore/receiptTypes/{companyKey}/{typeKey}/printOriginal

GET /financialCore/receiptTypes/{companyKey}/{typeKey}/printOriginal

POST Operations

POST ReceiptTypes

Creates a new entity record.

The following elements are required:

receiptTypeResource

(ApiReceiptTypeResource) The request body should contain the entity record that should be created.
See ApiReceiptTypeResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiReceiptTypeResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes

POST /financialCore/receiptTypes

POST Receipt Type

Inserts a new 'Receipt Type Serie' in the 'Receipt Type'.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(ApiReceiptTypeDocumentTypeSeriesResource) The ApiReceiptTypeDocumentTypeSeriesResource instance. See ApiReceiptTypeDocumentTypeSeriesResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries

POST /financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries

PUT Operations

PUT Set AccountingSchema ReceiptType

Updates the value of attribute 'AccountingSchema' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(enum AccountingSchema) The request body should contain the new value for the attribute. See AccountingSchema.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/accountingSchema

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/accountingSchema

PUT Set ATManualCommunication ReceiptTypeSerie

Updates the value of attribute 'ATManualCommunication' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

PUT Set ATValidationCode ReceiptTypeSerie

Updates the value of attribute 'ATValidationCode' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

PUT Set Company ReceiptType

Updates the value of attribute 'Company' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/company

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/company

PUT Set ContactType ReceiptType

Updates the value of attribute 'ContactType' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/contactType

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/contactType

PUT Set DefaultCashFlowItem ReceiptType

Updates the value of attribute 'DefaultCashFlowItem' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/defaultCashFlowItem

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/defaultCashFlowItem

PUT Set DefaultFinancialAccount ReceiptType

Updates the value of attribute 'DefaultFinancialAccount' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/defaultFinancialAccount

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/defaultFinancialAccount

PUT Set Description ReceiptType

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/description

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/description

PUT Set FiscalDocumentType ReceiptType

Updates the value of attribute 'FiscalDocumentType' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/fiscalDocumentType

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/fiscalDocumentType

PUT Set IsActive ReceiptType

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

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}/financialCore/receiptTypes/{companyKey}/{typeKey}/isActive

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/isActive

PUT Set IsDefault ReceiptTypeSerie

Updates the value of attribute 'IsDefault' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT Set Led ReceiptTypeSerie

Updates the value of attribute 'Led' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/led

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/led

PUT Set Notification ReceiptType

Updates the value of attribute 'Notification' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/notification

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/notification

PUT Set NumberOfCopies ReceiptTypeSerie

Updates the value of attribute 'NumberOfCopies' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(int) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT Set TypeKey ReceiptType

Updates the value of attribute 'TypeKey' in the specified entity record.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/financialCore/receiptTypes/{companyKey}/{typeKey}/typeKey

PUT /financialCore/receiptTypes/{companyKey}/{typeKey}/typeKey

DELETE Operations

DELETE Receipt Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

typeKey	(string) The receipt type's key.
companyKey	(string) The company key.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. 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}/financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE /financialCore/receiptTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE ReceiptType by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. 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}/financialCore/receiptTypes/{id}

DELETE /financialCore/receiptTypes/{id}

DELETE ReceiptType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The receipt type's key.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. 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}/financialCore/receiptTypes/{companyKey}/{typeKey}

DELETE /financialCore/receiptTypes/{companyKey}/{typeKey}

Resources

ApiReceiptTypeDocumentTypeSeriesResource

The following elements are required:

isDefault	(bool) Indicates if this is the default serie for the document.
numberOfCopies	(int) The number of copies of the document to print.
serie	(string) The serie for the reciept type.
aTManualCommunication	(bool) Manual Communication.

The following elements are optional:

aTValidationCode	(string) Validation Code.
led	(string) LED.

ApiReceiptTypeResource

The following elements are required:

company	(string) The company for the receipt type. The company code is the central organizational unit within the system.
typeKey	(string) The receipt type's key.
accountingSchema	(enum AccountingSchema) The associated accounting schema. See AccountingSchema.

The following elements are optional:

description	(string) The receipt type's description.
documentTypeSeries	(List of ApiReceiptTypeDocumentTypeSeriesResource) The associated document type series. See ApiReceiptTypeDocumentTypeSeriesResource.
defaultFinancialAccount	(string) The associated financial account to be used as default.
defaultCashFlowItem	(string) The associated cash flow item to be used as default.
contactType	(string) The associated contact type.
notification	(string) The associated notification.
fiscalDocumentType	(string) Fiscal Document Type.

ReceiptTypeResource

The following elements are required:

company	(string) The company for the receipt type. The company code is the central organizational unit within the system. (fk) Allowed value: the natural key of a record of type Company. These records are accessibly through the Companies service.
typeKey	(string) The receipt type's key.
accountingSchema	(enum AccountingSchema) The associated accounting schema. See AccountingSchema.

The following elements are optional:

description	(string) The receipt type's description.
documentTypeSeries	(List of ReceiptTypeSerieResource) The associated document type series. See ReceiptTypeSerieResource.
defaultFinancialAccount	(string) The associated financial account to be used as default. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
defaultCashFlowItem	(string) The associated cash flow item to be used as default. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.
contactType	(string) The associated contact type. (fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service.
notification	(string) The associated notification. (fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service.
fiscalDocumentType	(string) Fiscal Document Type. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.

ReceiptTypeSerieResource

The following elements are required:

isDefault	(bool) Indicates if this is the default serie for the document.
numberOfCopies	(int) The number of copies of the document to print.
serie	(string) The serie for the reciept type.
aTManualCommunication	(bool) Manual Communication.

The following elements are optional:

currentNumber	(int) The current receipt type serie's number.
currentDate	(DateTime) The current receipt type's date.
aTValidationCode	(string) Validation Code.
aTCommunicationStatus	(enum ATCommunicationStatus) Communication Status. See ATCommunicationStatus.
aTCommunicationDate	(DateTime) Communication Date.
led	(string) LED.

Enumerations

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash

ATCommunicationStatus

1	Active
2	Finished
3	Annulled
4	NotCommunicated