Logistics | Memo Reason

The Memo reason represents reason for the memos.

Overview

api/{tenantKey}/{orgKey}/logisticsCore/memoReasons

URL	api/{tenantKey}/{orgKey}/logisticsCore/memoReasons
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST MemoReasons
PUT:
DELETE:
- DELETE MemoReason by identifier
- DELETE MemoReason by key

All Resources

This service uses the following resources:

ApiMemoReasonResource
MemoReasonResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

AccountingNature

GET Operations

GET MemoReasons

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/memoReasons

GET /logisticsCore/memoReasons

GET MemoReasons (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 MemoReasonResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/memoReasons?page={page}&pageSize={pageSize}

GET /logisticsCore/memoReasons?page={page}&pageSize={pageSize}

GET MemoReason 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 MemoReasonResource.

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}/logisticsCore/memoReasons/{id}

GET /logisticsCore/memoReasons/{id}

GET MemoReason by key

Returns the entity record that matches the specified key.

The following elements are required:

memoReasonKey

(string) The key for the memo reason.

Response:

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

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}/logisticsCore/memoReasons/{memoReasonKey}

GET /logisticsCore/memoReasons/{memoReasonKey}

GET Print MemoReason 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}/logisticsCore/memoReasons/{id}/print?template={template}

GET /logisticsCore/memoReasons/{id}/print?template={template}

GET Print MemoReason by key

Prints the specified entity record.

The following elements are required:

memoReasonKey

(string) The key for the memo reason.

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}/logisticsCore/memoReasons/{memoReasonKey}/print

GET /logisticsCore/memoReasons/{memoReasonKey}/print

GET Original Print MemoReasonOriginal 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}/logisticsCore/memoReasons/{id}/printOriginal?template={template}

GET /logisticsCore/memoReasons/{id}/printOriginal?template={template}

GET Original Print MemoReason by key

Prints the specified entity record.

The following elements are required:

memoReasonKey

(string) The key for the memo reason.

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}/logisticsCore/memoReasons/{memoReasonKey}/printOriginal

GET /logisticsCore/memoReasons/{memoReasonKey}/printOriginal

POST Operations

POST MemoReasons

Creates a new entity record.

The following elements are required:

memoReasonResource

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

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/logisticsCore/memoReasons

POST /logisticsCore/memoReasons

PUT Operations

PUT Set AccountingNature MemoReason

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

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
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}/logisticsCore/memoReasons/{memoReasonKey}/accountingNature

PUT /logisticsCore/memoReasons/{memoReasonKey}/accountingNature

PUT Set Description MemoReason

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

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
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}/logisticsCore/memoReasons/{memoReasonKey}/description

PUT /logisticsCore/memoReasons/{memoReasonKey}/description

PUT Set FiscalMemoReason MemoReason

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

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
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}/logisticsCore/memoReasons/{memoReasonKey}/fiscalMemoReason

PUT /logisticsCore/memoReasons/{memoReasonKey}/fiscalMemoReason

PUT Set IsActive MemoReason

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

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
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}/logisticsCore/memoReasons/{memoReasonKey}/isActive

PUT /logisticsCore/memoReasons/{memoReasonKey}/isActive

PUT Set MemoReasonKey MemoReason

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

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
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}/logisticsCore/memoReasons/{memoReasonKey}/memoReasonKey

PUT /logisticsCore/memoReasons/{memoReasonKey}/memoReasonKey

PUT Set Custom Attribute MemoReason

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

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
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}/logisticsCore/memoReasons/{memoReasonKey}/{customAttributeName}

PUT /logisticsCore/memoReasons/{memoReasonKey}/{customAttributeName}

DELETE Operations

DELETE MemoReason 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}/logisticsCore/memoReasons/{id}

DELETE /logisticsCore/memoReasons/{id}

DELETE MemoReason by key

Deletes the entity record that matches the specified key.

The following elements are required:

memoReasonKey

(string) The key for the memo reason.

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}/logisticsCore/memoReasons/{memoReasonKey}

DELETE /logisticsCore/memoReasons/{memoReasonKey}

Resources

ApiMemoReasonResource

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
accountingNature	(enum AccountingNature) The accounting nature of the memo reason. See AccountingNature.

The following elements are optional:

description	(string) The description for the memo reason.
fiscalMemoReason	(string) The fiscal classification of the memo reason.

MemoReasonResource

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
accountingNature	(enum AccountingNature) The accounting nature of the memo reason. See AccountingNature.

The following elements are optional:

description	(string) The description for the memo reason.
fiscalMemoReason	(string) The fiscal classification of the memo reason. (fk) Allowed value: the natural key of a record of type FiscalMemoReason. These records are accessibly through the FiscalMemoReasons service.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

AccountingNature

1	Debit
2	Credit