Purchases | Memo Type

Service to manage entities of type 'MemoType'.

Overview

api/{tenantKey}/{orgKey}/purchasesCore/memoTypes

URL	api/{tenantKey}/{orgKey}/purchasesCore/memoTypes
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST MemoTypes
- POST Memo Type
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiMemoTypeDocumentTypeSeriesResource
ApiMemoTypeResource
MemoTypeResource
MemoTypeSerieResource

All Enumerations

This service uses the following enumerations:

AccountingNature
AccountingSchema

GET Operations

GET MemoTypes

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/memoTypes

GET /purchasesCore/memoTypes

GET MemoTypes (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 MemoTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/memoTypes?page={page}&pageSize={pageSize}

GET /purchasesCore/memoTypes?page={page}&pageSize={pageSize}

GET MemoType 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 MemoTypeResource.

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}/purchasesCore/memoTypes/{id}

GET /purchasesCore/memoTypes/{id}

GET MemoType by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the memo type.

Response:

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

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}/purchasesCore/memoTypes/{companyKey}/{typeKey}

GET /purchasesCore/memoTypes/{companyKey}/{typeKey}

GET Print MemoType 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}/purchasesCore/memoTypes/{id}/print?template={template}

GET /purchasesCore/memoTypes/{id}/print?template={template}

GET Print MemoType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the memo type.

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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/print

GET /purchasesCore/memoTypes/{companyKey}/{typeKey}/print

GET Original Print MemoTypeOriginal 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}/purchasesCore/memoTypes/{id}/printOriginal?template={template}

GET /purchasesCore/memoTypes/{id}/printOriginal?template={template}

GET Original Print MemoType by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the memo type.

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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/printOriginal

GET /purchasesCore/memoTypes/{companyKey}/{typeKey}/printOriginal

POST Operations

POST MemoTypes

Creates a new entity record.

The following elements are required:

memoTypeResource

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

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 ApiMemoTypeResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/purchasesCore/memoTypes

POST /purchasesCore/memoTypes

POST Memo Type

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

The following elements are required:

typeKey	(string) The key for the memo type.
companyKey	(string) The company key.
value	(ApiMemoTypeDocumentTypeSeriesResource) The ApiMemoTypeDocumentTypeSeriesResource instance. See ApiMemoTypeDocumentTypeSeriesResource.

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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries

POST /purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries

PUT Operations

PUT Set AccountingNature MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
companyKey	(string) The company key.
value	(enum AccountingNature) The request body should contain the new value for the attribute. See AccountingNature.

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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/accountingNature

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/accountingNature

PUT Set AccountingSchema MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/accountingSchema

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/accountingSchema

PUT Set Company MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/company

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/company

PUT Set ContactType MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/contactType

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/contactType

PUT Set Description MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/description

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/description

PUT Set IsActive MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/isActive

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/isActive

PUT Set IsDefault MemoTypeSerie

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

PUT Set Notification MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/notification

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/notification

PUT Set NumberOfCopies MemoTypeSerie

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

PUT Set TaxIncluded MemoTypeSerie

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

PUT Set TypeKey MemoType

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

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/typeKey

PUT /purchasesCore/memoTypes/{companyKey}/{typeKey}/typeKey

DELETE Operations

DELETE Memo Type Serie by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

typeKey	(string) The key for the memo type.
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}/purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE /purchasesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

DELETE MemoType 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}/purchasesCore/memoTypes/{id}

DELETE /purchasesCore/memoTypes/{id}

DELETE MemoType by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the memo type.

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}/purchasesCore/memoTypes/{companyKey}/{typeKey}

DELETE /purchasesCore/memoTypes/{companyKey}/{typeKey}

Resources

ApiMemoTypeDocumentTypeSeriesResource

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 range of identification values that group a set of product entities or objects.

The following elements are optional:

taxIncluded

(bool) When checked, the document unit prices will include taxes.

ApiMemoTypeResource

The following elements are required:

company	(string) The company code is the central organizational unit within the system.
typeKey	(string) The key for the memo type.
accountingNature	(enum AccountingNature) The nature for the memo type. It can be "credit" or "debit". See AccountingNature.

The following elements are optional:

description	(string) The description for the memo type.
documentTypeSeries	(List of ApiMemoTypeDocumentTypeSeriesResource) The list of available series for this document type. See ApiMemoTypeDocumentTypeSeriesResource.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.
contactType	(string) The contact type for the memo type.
notification	(string) The default notification for documents with this memo type.

MemoTypeResource

The following elements are required:

company	(string) 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 key for the memo type.
accountingNature	(enum AccountingNature) The nature for the memo type. It can be "credit" or "debit". See AccountingNature.

The following elements are optional:

description	(string) The description for the memo type.
documentTypeSeries	(List of MemoTypeSerieResource) The list of available series for this document type. See MemoTypeSerieResource.
accountingSchema	(enum AccountingSchema) The entity's accounting organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.
contactType	(string) The contact type for the memo type. (fk) Allowed value: the natural key of a record of type ContactType. These records are accessibly through the ContactTypes service.
notification	(string) The default notification for documents with this memo type. (fk) Allowed value: the natural key of a record of type Notification. These records are accessibly through the Notifications service.

MemoTypeSerieResource

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 range of identification values that group a set of product entities or objects.

The following elements are optional:

currentNumber	(int) The current document's number.
currentDate	(DateTime) The current date for the order type serie.
taxIncluded	(bool) When checked, the document unit prices will include taxes.

Enumerations

AccountingNature

1	Credit
2	Debit

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash