ROSEPEOPLE Developers - Web API Reference

Payroll | Bank Account

Service to manage entities of type 'BankAccount'. (Standalone subscriptions only).

Overview


URL api/{tenantKey}/{orgKey}/payroll/bankAccounts
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET BankAccounts

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /payroll/bankAccounts

GET BankAccounts (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 BankAccountResource.

Response status codes:

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

Resource URL:

GET /payroll/bankAccounts?page={page}&pageSize={pageSize}

GET BankAccount 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 BankAccountResource.

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 /payroll/bankAccounts/{id}

GET BankAccount by key

Returns the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
bankAccountKey (string) Bank Account.

Response:

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

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 /payroll/bankAccounts/{companyKey}/{bankAccountKey}

GET Print BankAccount 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 /payroll/bankAccounts/{id}/print?template={template}

GET Print BankAccount by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
bankAccountKey (string) Bank Account.

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 /payroll/bankAccounts/{companyKey}/{bankAccountKey}/print

GET Original Print BankAccountOriginal 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 /payroll/bankAccounts/{id}/printOriginal?template={template}

GET Original Print BankAccount by key

Prints the specified entity record.

The following elements are required:

companyKey (string) The company key.
bankAccountKey (string) Bank Account.

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 /payroll/bankAccounts/{companyKey}/{bankAccountKey}/printOriginal

POST Operations

POST BankAccounts

Creates a new entity record.

The following elements are required:

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

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

Response status codes:

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

Resource URL:

POST /payroll/bankAccounts

PUT Operations

PUT Set AccountNumber BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/accountNumber

PUT Set BankAccountKey BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/bankAccountKey

PUT Set BankingInstitution BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/bankingInstitution

PUT Set Company BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/company

PUT Set Country BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/country

PUT Set IBAN BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/iBAN

PUT Set IsActive BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/isActive

PUT Set Name BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/name

PUT Set PartyCode BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/partyCode

PUT Set SWIFT BankAccount

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

The following elements are required:

bankAccountKey (string) Bank Account.
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:

PUT /payroll/bankAccounts/{companyKey}/{bankAccountKey}/sWIFT

DELETE Operations

DELETE BankAccount 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:

DELETE /payroll/bankAccounts/{id}

DELETE BankAccount by key

Deletes the entity record that matches the specified key.

The following elements are required:

companyKey (string) The company key.
bankAccountKey (string) Bank Account.

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:

DELETE /payroll/bankAccounts/{companyKey}/{bankAccountKey}

Resources


ApiBankAccountResource

The following elements are required:

bankAccountKey (string) Bank Account.
name (string) Name.
country (string) Country.
company (string) Company.

The following elements are optional:

bankingInstitution (string) Banking Institution.
sWIFT (string) The society for Worldwide Interbank Financial Telecommunication number.
iBAN (string) The finacial account's International Bank Account Number.
partyCode (string) Party Code.
accountNumber (string) The account number.


BankAccountResource

The following elements are required:

bankAccountKey (string) Bank Account.
name (string) Name.
country (string) Country.
(fk) Allowed value: the natural key of a record of type Country.
company (string) Company.
(fk) Allowed value: the natural key of a record of type Company.

The following elements are optional:

bankingInstitution (string) Banking Institution.
sWIFT (string) The society for Worldwide Interbank Financial Telecommunication number.
iBAN (string) The finacial account's International Bank Account Number.
partyCode (string) Party Code.
accountNumber (string) The account number.