Logistics | Memo Reason

Service to manage entities of type 'MemoReason'.

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

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.

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 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 FiscalIssueReason MemoReason

Updates the value of attribute 'FiscalIssueReason' 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}/fiscalIssueReason

PUT /logisticsCore/memoReasons/{memoReasonKey}/fiscalIssueReason

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

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.
description	(string) The description for the memo reason.

The following elements are optional:

fiscalIssueReason

(string) Tax Issue Reason.

MemoReasonResource

The following elements are required:

memoReasonKey	(string) The key for the memo reason.
description	(string) The description for the memo reason.

The following elements are optional:

fiscalIssueReason

(string) Tax Issue Reason.
(fk) Allowed value: the natural key of a record of type FiscalIssueReason. These records are accessibly through the FiscalIssueReasons service.