Bank Accounting | Bank Order Type
The Bank Orders Types end point is used on Bank Orders and its define if the document is a payment or a receivable. RESERVED FOR INTERNAL USE.
Overview
| URL | api/{tenantKey}/{orgKey}/bankAccounting/bankOrderTypes |
| Methods Supported | GET |
All Operations
This service includes the following operations:
- GET:
All Resources
This service uses the following resources:
GET BankOrderTypes
Returns the list of all the entity records available.
Response:
| When successful, the response body contains the list of records available. See BankOrderTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET BankOrderTypes (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 BankOrderTypeResource. |
Response status codes:
| 200 | OK. The operation was completed successfully. |
| 400 | BadRequest. The request parameters are invalid. |
Resource URL:
GET BankOrderType 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 BankOrderTypeResource. |
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 BankOrderType by key
Returns the entity record that matches the specified key.
The following elements are required:
| bankOrderTypeKey | (string) The key of bank order type(ex: R). |
Response:
| When successful, the response body contains the entity record. See BankOrderTypeResource. |
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 BankOrderType 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 BankOrderType by key
Prints the specified entity record.
The following elements are required:
| bankOrderTypeKey | (string) The key of bank order type(ex: R). |
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 BankOrderTypeOriginal 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 BankOrderType by key
Prints the specified entity record.
The following elements are required:
| bankOrderTypeKey | (string) The key of bank order type(ex: R). |
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:
PUT Set Custom Attribute BankOrderType
Updates the value of 'CustomAttribute' in the specified entity record.
The following elements are required:
| bankOrderTypeKey | (string) The key of bank order type(ex: R) |
| 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: