Sales | Memo Type

Service to manage entities of type 'MemoType'.

Overview

URL	api/{tenantKey}/{orgKey}/salesCore/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 IsActive MemoType
  • PUT Set Company MemoType
  • PUT Set TypeKey MemoType
  • PUT Set Description MemoType
  • PUT Set FiscalDocumentType MemoType
  • PUT Set AccountingSchema MemoType
  • PUT Set AccountingNature MemoType
  • PUT Set ContactType MemoType
  • PUT Set Notification MemoType
  • PUT Set AutomaticallySettled MemoType
  • PUT Set DefaultFinancialAccount MemoType
  • PUT Set DefaultCashFlowItem MemoType
  • PUT Set NumberOfCopies MemoTypeSerie
  • PUT Set IsDefault MemoTypeSerie
  • PUT Set TaxIncluded MemoTypeSerie
  • PUT Set IsManual MemoTypeSerie
  • PUT Set IsExternal MemoTypeSerie
  • PUT Set EconomicActivityClass MemoTypeSerie
  • PUT Set CommunicationType MemoTypeSerie
  • PUT Set SalesChannel MemoTypeSerie
  • PUT Set ATValidationCode MemoTypeSerie
  • PUT Set ATManualCommunication MemoTypeSerie
  • PUT Set Led MemoTypeSerie
  • PUT Set Store MemoTypeSerie
  • PUT Set ExclusiveForPOSDevice 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

All Enumerations

This service uses the following enumerations:

• AccountingNature
• AccountingSchema
• ATCommunicationStatus
• CommunicationType

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 memo's type key.

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 memo's type 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:

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 memo's type 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:

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:

POST Memo Type

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

The following elements are required:

typeKey	(string) The memo's type key.
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:

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 memo's type key.
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 memo's type 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:

PUT Set ATManualCommunication MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set ATValidationCode MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set AutomaticallySettled MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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.

Resource URL:

PUT Set CommunicationType MemoTypeSerie

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

The following elements are required:

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

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 memo's type 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:

PUT Set ContactType MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set DefaultCashFlowItem MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set DefaultFinancialAccount MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set Description MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set EconomicActivityClass MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set ExclusiveForPOSDevice MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set FiscalDocumentType MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set IsActive MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set IsDefault MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set IsExternal MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set IsManual MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set Led MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set Notification MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set NumberOfCopies MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set SalesChannel MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set Store MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set TaxIncluded MemoTypeSerie

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

The following elements are required:

typeKey	(string) The memo's type 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:

PUT Set TypeKey MemoType

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

The following elements are required:

typeKey	(string) The memo's type 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:

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 memo's type 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:

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 memo's type 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:

Resources

ApiMemoTypeDocumentTypeSeriesResource

The following elements are required:

numberOfCopies	(int) The number of copies of the document to print.
isDefault	(bool) Indicates if this is the default serie for the document.
taxIncluded	(bool) When checked, the document unit prices will include taxes.
isManual	(bool) Defines if the memo type series is defined as manual. Internally determined.
isExternal	(bool) Defines if the memo type series is defined as external. Internally determined.
serie	(string) The range of identification values that group a set of product entities or objects.
communicationType	(enum CommunicationType) The type of comunication to be used. This is applicable only to Portuguese companies. See CommunicationType.
aTManualCommunication	(bool) Manual Communication.
exclusiveForPOSDevice	(bool) Indicates if this series is used exclusively in POS devices.

The following elements are optional:

economicActivityClass	(string) Indicates the company's activity.
salesChannel	(string) Indicates the sales channel used by default for this document type series.
aTValidationCode	(string) Validation Code.
led	(string) Place of issue of the document. It is required for electronic communication of the document in Cape Verde.
store	(string) Indicates the store used by default for this document type series. Must belong to the indicated sales channel.

ApiMemoTypeResource

The following elements are required:

company	(string) The memo's type company. The company code is the central organizational unit within the system.
typeKey	(string) The memo's type key.
accountingSchema	(enum AccountingSchema) The entity accounting's organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.
accountingNature	(enum AccountingNature) The nature for the memo type. It can be "credit" or "debit". See AccountingNature.
automaticallySettled	(bool) When active, the document is automatically settled, and there is no need to issue a payment.

The following elements are optional:

description	(string) The memo's type description.
fiscalDocumentType	(string) The fiscal's document type.
documentTypeSeries	(List of ApiMemoTypeDocumentTypeSeriesResource) The memo's type details. See ApiMemoTypeDocumentTypeSeriesResource.
contactType	(string) The contact type for the memo type.
notification	(string) The default notification for documents with this memo type.
defaultFinancialAccount	(string) The default financial account to be used in memos.
defaultCashFlowItem	(string) The type of cash flow item to be used when AutomaticallySettled is active.

MemoTypeResource

The following elements are required:

company	(string) The memo's type company. 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 memo's type key.
accountingSchema	(enum AccountingSchema) The entity accounting's organization method. This organization can follow the rules of "Cash" or "Accrual". See AccountingSchema.
isPortugueseCompany	(bool) Indicates if the invoice type is targeted at a company that is portuguese.
accountingNature	(enum AccountingNature) The nature for the memo type. It can be "credit" or "debit". See AccountingNature.
automaticallySettled	(bool) When active, the document is automatically settled, and there is no need to issue a payment.

The following elements are optional:

description	(string) The memo's type description.
fiscalDocumentType	(string) The fiscal's document type. (fk) Allowed value: the natural key of a record of type FiscalDocumentType. These records are accessibly through the FiscalDocumentTypes service.
documentTypeSeries	(List of MemoTypeSerieResource) The memo's type details. See MemoTypeSerieResource.
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.
defaultFinancialAccount	(string) The default financial account to be used in memos. (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
defaultCashFlowItem	(string) The type of cash flow item to be used when AutomaticallySettled is active. (fk) Allowed value: the natural key of a record of type CashFlowItem. These records are accessibly through the CashFlowItems service.

MemoTypeSerieResource

The following elements are required:

numberOfCopies	(int) The number of copies of the document to print.
isDefault	(bool) Indicates if this is the default serie for the document.
taxIncluded	(bool) When checked, the document unit prices will include taxes.
isManual	(bool) Defines if the memo type series is defined as manual. Internally determined.
isExternal	(bool) Defines if the memo type series is defined as external. Internally determined.
serie	(string) The range of identification values that group a set of product entities or objects.
communicationType	(enum CommunicationType) The type of comunication to be used. This is applicable only to Portuguese companies. See CommunicationType.
aTManualCommunication	(bool) Manual Communication.
exclusiveForPOSDevice	(bool) Indicates if this series is used exclusively in POS devices.

The following elements are optional:

currentDate	(DateTime) The current date for the memo type serie.
currentNumber	(int) The current document's number.
economicActivityClass	(string) Indicates the company's activity.
salesChannel	(string) Indicates the sales channel used by default for this document type series.
aTValidationCode	(string) Validation Code.
aTCommunicationStatus	(enum ATCommunicationStatus) Communication Status. See ATCommunicationStatus.
aTCommunicationDate	(DateTime) Communication Date.
led	(string) Place of issue of the document. It is required for electronic communication of the document in Cape Verde.
store	(string) Indicates the store used by default for this document type series. Must belong to the indicated sales channel.

Enumerations

AccountingNature

1	Credit
2	Debit

AccountingSchema

1	Accrual	Accrual Accounting Schema.
2	Cash

ATCommunicationStatus

1	Active
2	Finished
3	Annulled
4	NotCommunicated

CommunicationType

1	WebService
2	SAFT
3	NoCommunication
4	Manual