ROSE Developers - Web API Reference

Bank Accounting | Process Deposit Slip

The Process Deposit Slips end point allows to transfer amounts from the petty cash account to the bank account. RESERVED FOR INTERNAL USE.

Overview


URL api/{tenantKey}/{orgKey}/bankAccounting/processDepositSlips
Methods Supported POST, GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Process Deposit Slip

Returns the list of entity records that can be processed by the 'DepositSlips' service.

The following elements are required:

pageIndex (int) The index of the page of the list that should be returned.
pageSize (int) The number of page elements that should be returned (max. is 1000).
company (string) Company.
pettyCash (string) Petty Cash.
bankAccount (string) Bank Account.
depositDate (DateTime) Deposit Date.

The following elements are optional:

total (decimal?) Total This is a query string parameter.
currency (string) Currency This is a query string parameter.
note (string) Reference This is a query string parameter.
journalTypeKey (string) Journal Type This is a query string parameter.

Response:

When successful, the response body contains the list of entity records available for processing. See DepositSlipRequestLine.

Response status codes:

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

Resource URL:

GET /bankAccounting/processDepositSlips/{pageIndex}/{pageSize}?total={total}&currency={currency}&note={note}&journalTypeKey={journalTypeKey}

POST Operations

POST Post Deposit Slip Request

This operation allows to transfer amounts from the petty cash account to the bank account.

The following elements are required:

depositSlipRequest (DepositSlipRequest) The Deposit Slip Request represents the petty cash movements will be deposit to a bank account.

Response:

When successful, the response body contains a unique identifier.

Resource URL:

POST /bankAccounting/processDepositSlips/postDepositSlipRequest

POST Process Deposit Slip

Instructs the 'DepositSlips' service to process the specified entity records.

The following elements are required:

list (DepositSlipRequestLine) List of the entity records that should be processed.
See DepositSlipRequestLine.
companyKey (string) The company key.

Response:

When successful, the response body is empty. The URL of the processed items is returned in the response location header.

Response status codes:

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

Resource URL:

POST /bankAccounting/processDepositSlips/{companyKey}

Resources


DepositSlipRequest

The following elements are required:

company (string) Company.
pettyCash (string) Petty Cash.
bankAccount (string) Bank Account.
depositDate (DateTime) Deposit Date.
selectedCount (int) Selected Count.

The following elements are optional:

total (decimal) Total.
currency (string) Currency.
note (string) Reference.
journalTypeKey (string) Journal Type.


DepositSlipRequestLine

The following elements are required:

selected (bool) Selected.
party (string) Party.
amount (decimal) Amount.
originalAmount (decimal) Original Amount.

The following elements are optional:

paymentMethod (string) Payment Method.
note (string) Reference.
date (DateTime) Date.
sourceDocId (Guid) Source Doc Id.
sourceDoc (string) Source Doc.
sourceSchemaEntity (Guid) Source Schema Entity.
paymentReference (string) Payment Reference.
isBalanceManaged (bool) Is Balance Managed.
sourceDocLine (int) Source Doc Line.
sourceLineId (Guid) Source Line Id.