Purchases | Memo Type

The MemoType represents a purchases memo with specific characteristics.

Overview

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

All Operations

This service includes the following operations:

• GET:
  • GET MemoTypes
  • GET MemoTypes (paged)
  • GET MemoType by identifier
  • GET MemoType by key
  • GET Print MemoType by identifier
  • GET Print MemoType by key
  • GET Original Print MemoTypeOriginal by identifier
  • GET Original Print MemoType by key
• POST:
  • POST MemoTypes
  • POST Memo Type
• PUT:
  • PUT Set Custom Attribute MemoType
  • PUT Set Custom Attribute MemoTypeSerie
  • PUT Set IsActive MemoType
  • PUT Set Company MemoType
  • PUT Set TypeKey MemoType
  • PUT Set Description MemoType
  • PUT Set AccountingSchema MemoType
  • PUT Set ContactType MemoType
  • PUT Set Notification MemoType
  • PUT Set AccountingNature MemoType
  • PUT Set SupplierPostingProfile MemoType
  • PUT Set DimensionCombination MemoType
  • PUT Set PurchasesAcctDetermination MemoType
  • PUT Set JournalType MemoType
  • PUT Set CompanyHasDimensions MemoType
  • PUT Set IsDefault MemoTypeSerie
  • PUT Set NumberOfCopies MemoTypeSerie
  • PUT Set TaxIncluded MemoTypeSerie
• DELETE:
  • DELETE Memo Type Serie by identifier
  • DELETE MemoType by identifier
  • DELETE MemoType by key

All Resources

This service uses the following resources:

• ApiMemoTypeDocumentTypeSeriesResource
• ApiMemoTypeResource
• MemoTypeResource
• MemoTypeSerieResource
• ExtensibilityCustomAttributeValueResource

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:

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:

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:

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:

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:

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:

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:

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:

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.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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:

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.

The following elements are optional:

customAttributes

(JSON Document) A key-value pair in JSON format that represents the extensibility custom attributes for this entity. The key should be the custom attribute name prefixed with "custom_", e.g. "custom_attributeName". While the "customAttributes" element is optional, please notice that specific custom attributes might be marked as required.

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:

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:

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:

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:

PUT Set CompanyHasDimensions MemoType

Updates the value of attribute 'CompanyHasDimensions' 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.

Resource URL:

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:

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:

PUT Set DimensionCombination MemoType

Updates the value of attribute 'DimensionCombination' 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:

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:

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:

PUT Set JournalType MemoType

Updates the value of attribute 'JournalType' 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:

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:

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:

PUT Set PurchasesAcctDetermination MemoType

Updates the value of attribute 'PurchasesAcctDetermination' 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:

PUT Set SupplierPostingProfile MemoType

Updates the value of attribute 'SupplierPostingProfile' 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:

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:

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:

PUT Set Custom Attribute MemoType

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the memo type.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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:

PUT Set Custom Attribute MemoTypeSerie

Updates the value of 'CustomAttribute' in the specified entity record.

The following elements are required:

companyKey	(string) The company key.
typeKey	(string) The key for the memo type.
lineId	(string) The detail identifier.
customAttributeName	(string) The custom attribute name.
value	(ExtensibilityCustomAttributeValueResource) The request body should contain the new value for the custom attribute. See ExtensibilityCustomAttributeValueResource.

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:

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:

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:

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:

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.
supplierPostingProfile	(string) The supplier posting profile used for supplier account determination.
purchasesAcctDetermination	(string) The purchases GL account determinations for line item.
journalType	(string) The journal type to be used for account posting.
companyHasDimensions	(bool) Company Has Dimensions.

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.
dimensionCombination	(string) The dimension combination used for line item dimension determination.

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.
supplierPostingProfile	(string) The supplier posting profile used for supplier account determination. (fk) Allowed value: the natural key of a record of type SupplierPostingProfile. These records are accessibly through the SupplierPostingProfiles service.
purchasesAcctDetermination	(string) The purchases GL account determinations for line item. (fk) Allowed value: the natural key of a record of type PurchasesAcctDetermination. These records are accessibly through the PurchasesAcctDeterminations service.
journalType	(string) The journal type to be used for account posting. (fk) Allowed value: the natural key of a record of type JournalType. These records are accessibly through the JournalTypes service.
companyHasDimensions	(bool) Company Has Dimensions.

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.
dimensionCombination	(string) The dimension combination used for line item dimension determination. (fk) Allowed value: the natural key of a record of type DimensionCombination. These records are accessibly through the DimensionCombinations 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.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingNature

1	Debit
2	Credit

AccountingSchema

1	Accrual	Acrrual Accounting Schema.
2	Cash