Sales | Memo Type

The Memo Type represents a sales document with specific characteristics.

Overview

api/{tenantKey}/{orgKey}/salesCore/memoTypes

URL	api/{tenantKey}/{orgKey}/salesCore/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
ExtensibilityCustomAttributeValueResource

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes

GET /salesCore/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}/salesCore/memoTypes?page={page}&pageSize={pageSize}

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

GET /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}

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

GET /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/print

GET /salesCore/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}/salesCore/memoTypes/{id}/printOriginal?template={template}

GET /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/printOriginal

GET /salesCore/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.

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes

POST /salesCore/memoTypes

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.

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries

POST /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/accountingNature

PUT /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/accountingSchema

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

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTManualCommunication

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/aTValidationCode

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/communicationType

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/communicationType

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/company

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

PUT Set CompanyHasDimensions MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/companyHasDimensions

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/companyHasDimensions

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/contactType

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

PUT Set CustomerPostingProfile MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/customerPostingProfile

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/customerPostingProfile

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/description

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

PUT Set DimensionCombination MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/dimensionCombination

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/dimensionCombination

PUT Set DocumentNote MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentNote

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentNote

PUT Set DocumentNoteTitle MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentNoteTitle

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentNoteTitle

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/economicActivityClass

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/economicActivityClass

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/fiscalDocumentType

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/fiscalDocumentType

PUT Set GoodsReturn MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/goodsReturn

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/goodsReturn

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/isActive

PUT /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isDefault

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

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isExternal

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isExternal

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isManual

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/isManual

PUT Set IsPortugueseCompany MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/isPortugueseCompany

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/isPortugueseCompany

PUT Set JournalType MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/journalType

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/journalType

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/notification

PUT /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/numberOfCopies

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

PUT Set SalesAccountDetermination MemoType

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/salesAccountDetermination

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/salesAccountDetermination

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/taxIncluded

PUT /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/typeKey

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/typeKey

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/{customAttributeName}

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/{customAttributeName}

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

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/{customAttributeName}

PUT /salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}/{customAttributeName}

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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}/documentTypeSeries/{lineId}

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

DELETE /salesCore/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 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:

api/{tenantKey}/{orgKey}/salesCore/memoTypes/{companyKey}/{typeKey}

DELETE /salesCore/memoTypes/{companyKey}/{typeKey}

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) When checked, the memo type series is defined as manual. Internally determined.
isExternal	(bool) When checked, 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.

The following elements are optional:

economicActivityClass	(string) Indicates the company's activity.
aTValidationCode	(string) Validation Code.

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.
isPortugueseCompany	(bool) The invoice type is targeted at a company that is portuguese.
customerPostingProfile	(string) The customer posting profile used for customer GL account determination.
accountingNature	(enum AccountingNature) The nature for the memo type. It can be "credit" or "debit". See AccountingNature.
salesAccountDetermination	(string) The sales GL account determinations for line item.
journalType	(string) The journal type to be used for account posting.
goodsReturn	(bool) Flag to know if is goods return.
companyHasDimensions	(bool) Flag to know if company has dimensions.

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

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) The invoice type is targeted at a company that is portuguese.
customerPostingProfile	(string) The customer posting profile used for customer GL account determination. (fk) Allowed value: the natural key of a record of type CustomerPostingProfile. These records are accessibly through the CustomerPostingProfiles service.
accountingNature	(enum AccountingNature) The nature for the memo type. It can be "credit" or "debit". See AccountingNature.
salesAccountDetermination	(string) The sales GL account determinations for line item. (fk) Allowed value: the natural key of a record of type SalesAccountDetermination. These records are accessibly through the SalesAccountDeterminations 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.
goodsReturn	(bool) Flag to know if is goods return.
companyHasDimensions	(bool) Flag to know if company has dimensions.

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.
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.
documentNoteTitle	(string) The document note title.
documentNote	(string) The document note.

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) When checked, the memo type series is defined as manual. Internally determined.
isExternal	(bool) When checked, 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.

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.
aTValidationCode	(string) Validation Code.
aTCommunicationDate	(DateTime) Communication Date.
aTCommunicationStatus	(enum ATCommunicationStatus) Communication Status. See ATCommunicationStatus.

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

ATCommunicationStatus

1	Active
2	Finished
3	Annulled
4	NotCommunicated

CommunicationType

1	WebService
2	SAFT
3	NoCommunication
4	Manual