Bank Accounting | Bank Order

The Bank orders end point is used to record all business transactions and events to generate the SEPA File. The SEPA File is used to upload to your bank system and it will make the payments to the suppliers or receivables from the customers.

Overview

api/{tenantKey}/{orgKey}/bankAccounting/bankOrders

URL	api/{tenantKey}/{orgKey}/bankAccounting/bankOrders
Methods Supported	GET, PUT, POST, DELETE

All Operations

This service includes the following operations:

GET:
PUT:
POST:
- POST Bank Order
DELETE:

All Resources

This service uses the following resources:

ApiBankOrderBankOrderLinesResource
ApiBankOrderResource
BankOrderLineResource
BankOrderResource
MoneyResource
ExtensibilityCustomAttributeValueResource

All Enumerations

This service uses the following enumerations:

BankOrderLineState
BankOrderState

GET Operations

GET BankOrders

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/bankAccounting/bankOrders

GET /bankAccounting/bankOrders

GET BankOrders (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 BankOrderResource.

Response status codes:

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

Resource URL:

api/{tenantKey}/{orgKey}/bankAccounting/bankOrders?page={page}&pageSize={pageSize}

GET /bankAccounting/bankOrders?page={page}&pageSize={pageSize}

GET BankOrder 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 BankOrderResource.

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}/bankAccounting/bankOrders/{id}

GET /bankAccounting/bankOrders/{id}

GET BankOrder by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
bankOrderKey	(string) The bank order key.

Response:

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

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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}

GET /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}

GET Print BankOrder 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}/bankAccounting/bankOrders/{id}/print?template={template}

GET /bankAccounting/bankOrders/{id}/print?template={template}

GET Print BankOrder by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/print

GET /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/print

GET Original Print BankOrderOriginal 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}/bankAccounting/bankOrders/{id}/printOriginal?template={template}

GET /bankAccounting/bankOrders/{id}/printOriginal?template={template}

GET Original Print BankOrder by key

Prints the specified entity record.

The following elements are required:

companyKey	(string) The company key.
bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/printOriginal

GET /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/printOriginal

POST Operations

POST Bank Order

Inserts a new 'Bank Order Line' in the 'Bank Order'.

The following elements are required:

bankOrderKey	(string) The bank order key.
companyKey	(string) The company key.
value	(ApiBankOrderBankOrderLinesResource) The ApiBankOrderBankOrderLinesResource instance. See ApiBankOrderBankOrderLinesResource.

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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines

POST /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines

PUT Operations

PUT Set IsActive BankOrder

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

The following elements are required:

bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/isActive

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/isActive

PUT Set Note BankOrder

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

The following elements are required:

bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/note

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/note

PUT Set PaymentMethod BankOrder

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

The following elements are required:

bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/paymentMethod

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/paymentMethod

PUT Set Remarks BankOrder

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

The following elements are required:

bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/remarks

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/remarks

PUT Set Status BankOrder

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

The following elements are required:

bankOrderKey	(string) The bank order key.
companyKey	(string) The company key.
value	(enum BankOrderState) The request body should contain the new value for the attribute. See BankOrderState.

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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/status

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/status

PUT Set Status BankOrderLine

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

The following elements are required:

bankOrderKey	(string) The bank order key.
lineId	(string) The detail identifier.
companyKey	(string) The company key.
value	(enum BankOrderLineState) The request body should contain the new value for the attribute. See BankOrderLineState.

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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines/{lineId}/status

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines/{lineId}/status

PUT Set Custom Attribute BankOrder

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

The following elements are required:

companyKey	(string) The company key.
bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/{customAttributeName}

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/{customAttributeName}

PUT Set Custom Attribute BankOrderLine

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

The following elements are required:

companyKey	(string) The company key.
bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines/{lineId}/{customAttributeName}

PUT /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines/{lineId}/{customAttributeName}

DELETE Operations

DELETE Bank Order Line by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines/{lineId}

DELETE /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}/bankOrderLines/{lineId}

DELETE BankOrder 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}/bankAccounting/bankOrders/{id}

DELETE /bankAccounting/bankOrders/{id}

DELETE BankOrder by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey	(string) The company key.
bankOrderKey	(string) The bank order 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}/bankAccounting/bankOrders/{companyKey}/{bankOrderKey}

DELETE /bankAccounting/bankOrders/{companyKey}/{bankOrderKey}

Resources

ApiBankOrderBankOrderLinesResource

The following elements are required:

party	(string) Indicates the entity of the original document.
discountAmount	(MoneyResource) Discount. See MoneyResource .
withholdedAmount	(MoneyResource) The witholded amount of the sourcedoc. See MoneyResource .
transferAmount	(MoneyResource) The amount that will be transfered of the sourcedoc. See MoneyResource .
currency	(string) The currency of the sourcedoc.
accountPosting	(string) Account Posting.
status	(enum BankOrderLineState) The current status (updated automatically by a SEPA return file or manually). See BankOrderLineState.

The following elements are optional:

sourceDoc

(string) The original document identification.

ApiBankOrderResource

The following elements are required:

bankOrderKey	(string) The bank order key.
documentDate	(DateTime) Document's date.
currency	(string) The Bank Order currency. Indicates the money unit used by the generated document.
financialAccount	(string) FinancialAccount(ex: CGDDO).
bankAccountType	(string) Type of bank account type(ex: 01).
bankOrderType	(string) Type of bank order(ex: Payment).
company	(string) The Bank Order's company. The company code is the central organizational unit within the system.
exchangeRate	(decimal) Exchange Rate.
paymentMethod	(string) Method of payment(ex:TRA).
status	(enum BankOrderState) Status of the document(ex:Done). See BankOrderState.

The following elements are optional:

note	(string) The Bank Order note.
remarks	(string) The Bank Order remarks.
bankOrderLines	(List of ApiBankOrderBankOrderLinesResource) Bank Order Lines. See ApiBankOrderBankOrderLinesResource.

BankOrderLineResource

The following elements are required:

party	(string) Indicates the entity of the original document.
documentAmount	(MoneyResource) The document amount of the original document. See MoneyResource .
discountAmount	(MoneyResource) Discount. See MoneyResource .
withholdedAmount	(MoneyResource) The witholded amount of the sourcedoc. See MoneyResource .
transferAmount	(MoneyResource) The amount that will be transfered of the sourcedoc. See MoneyResource .
currency	(string) The currency of the sourcedoc.
accountPosting	(string) Account Posting.
status	(enum BankOrderLineState) The current status (updated automatically by a SEPA return file or manually). See BankOrderLineState.

The following elements are optional:

sourceDoc	(string) The original document identification.
exportTransactionGroupId	(string) Export Transaction Group Id.
exportTransactionId	(string) Export Transaction Id.
externalStatusCode	(string) External Status.
externalStatusReportId	(string) External Status Report Id.

BankOrderResource

The following elements are required:

bankOrderKey	(string) The bank order key.
numberOfOpenItems	(int) Number of documents included in the bank order.
documentDate	(DateTime) Document's date.
currency	(string) The Bank Order currency. Indicates the money unit used by the generated document. (fk) Allowed value: the natural key of a record of type Currency. These records are accessibly through the Currencies service.
financialAccount	(string) FinancialAccount(ex: CGDDO). (fk) Allowed value: the natural key of a record of type FinancialAccount. These records are accessibly through the FinancialAccounts service.
bankAccountType	(string) Type of bank account type(ex: 01). (fk) Allowed value: the natural key of a record of type BankAccountType. These records are accessibly through the BankAccountTypes service.
bankOrderType	(string) Type of bank order(ex: Payment). (fk) Allowed value: the natural key of a record of type BankOrderType. These records are accessibly through the BankOrderTypes service.
totalAmount	(MoneyResource) The Bank Order total. Indicates the total amount of open items. See MoneyResource .
company	(string) The Bank Order's 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.
exchangeRate	(decimal) Exchange Rate.
paymentMethod	(string) Method of payment(ex:TRA). (fk) Allowed value: the natural key of a record of type PaymentMethod. These records are accessibly through the PaymentMethods service.
status	(enum BankOrderState) Status of the document(ex:Done). See BankOrderState.

The following elements are optional:

note	(string) The Bank Order note.
remarks	(string) The Bank Order remarks.
bankOrderLines	(List of BankOrderLineResource) Bank Order Lines. See BankOrderLineResource.

MoneyResource

The following elements are required:

amount

(decimal) The amount.

The following elements are optional:

baseAmount	(decimal) The base amount.
reportingAmount	(decimal) The reporting amount.
fractionDigits	(int) The fraction digits.
symbol	(string) The symbol.

Notes: For the POST operation it is not necessary to send the fields: BaseAmount, ReportingAmount, FractionDigits and Symbol. Will be ignored.

ExtensibilityCustomAttributeValueResource

The following elements are required:

value

(object) The custom attribute value.

Enumerations

BankOrderLineState

1	Pending
2	Failed
3	Successful

BankOrderState

1	Pending
2	Closed
3	ClosedWithErrors