Procurement APIs

GET procurement/suppliers/{supplierId}/bank-accounts/{supplierBankAccountId}

Supplier bank account details for provided identifier

HTTP method	GET
URI	https://api.rambase.net/procurement/suppliers/{supplierId}/bank-accounts/{supplierBankAccountId}
Supported formats	Xml, Html, Json (ex. $format=json)
- URI parameter {supplierId}	RamBase supplier identifier Integer, minimum 100
- URI parameter {supplierBankAccountId}	Supplier bank account identifier Integer, minimum 1
Custom fields	Custom fields supported
Successful HTTP status code	200
API resource identifier	2243, version 11

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$access_token String, optional	After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional	Set the database/company for the request
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$useMinimumVersion Integer, optional	Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$showCustomFields Boolean, optional	Set to "true" to include custom fields. Default value is false.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:

                                        <SupplierBankAccount>
                                    

<SupplierBankAccountId

SupplierBankAccountId

Supplier bank account identifier

>{Integer}</SupplierBankAccountId>

<Status

Status

Status of the supplier bank account

Possible domain values can be found here

>{Integer}</Status>

<Name

Name

Name of bank account

>{String}</Name>

<CreatedAt

CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>

<Currency

Currency

Currency used for the bank account

>{String}</Currency>

<AccountNumber

AccountNumber

Account number used to identify the bank account

>{String}</AccountNumber>

<Type

Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

>{String}</Type>

<BankCode

BankCode

A code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

>{String}</BankCode>

<ExternalClearingSystemIdentificationCode

ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

<Code

Code

Clearing code of the bank account

Possible domain values can be found here

>{String}</Code>

<BankIdentifier

BankIdentifier

Clearing bank identifier of the bank account

>{String}</BankIdentifier>

                                             </ExternalClearingSystemIdentificationCode>
                                    

                                             <Bank>
                                    

<SWIFTCode

SWIFTCode

The SWIFT (Society for Worldwide Interbank Financial Telecommunication) Code is a standard format for Business Identifier Codes (BIC) and it's used to uniquely identify banks and financial institutions globally. These codes are used when transferring money between banks, in particular for international wire transfers or SEPA payments.

>{String}</SWIFTCode>

<InternationalBankAccountNumber

InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

>{String}</InternationalBankAccountNumber>

<Address

Address

Address of the bank associated with the bank account

<CountryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

>{String}</CountryCode>

                                                  </Address>
                                    

                                             </Bank>
                                    

                                        </SupplierBankAccount>
                                    

{

                                             "supplierBankAccount": {
                                    

"supplierBankAccountId

SupplierBankAccountId

Supplier bank account identifier

": "{Integer}",

"status

Status

Status of the supplier bank account

Possible domain values can be found here

": "{Integer}",

"name

Name

Name of bank account

": "{String}",

"createdAt

CreatedAt

Date and time of creation

": "{Datetime}",

"currency

Currency

Currency used for the bank account

": "{String}",

"accountNumber

AccountNumber

Account number used to identify the bank account

": "{String}",

"type

Type

Type of the bank account, f.e. BBAN, Bankgiro, Plusgiro, ...

Possible domain values can be found here

": "{String}",

"bankCode

BankCode

A code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.

": "{String}",

"externalClearingSystemIdentificationCode

ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

": {

"code

Code

Clearing code of the bank account

Possible domain values can be found here

": "{String}",

"bankIdentifier

BankIdentifier

Clearing bank identifier of the bank account

": "{String}"

},

                                                  "bank": {
                                    

"sWIFTCode

SWIFTCode

": "{String}",

"internationalBankAccountNumber

InternationalBankAccountNumber

The International Bank Account Number (IBAN) is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of transcription errors.

": "{String}",

"address

Address

Address of the bank associated with the bank account

": {

"countryCode

CountryCode

Two-character code (ISO 3166) identifying the country.

": "{String}"

}

}

}

}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101304 HTTP 404	Carrier not found
Error 100053 HTTP 403	You have only admittance to your own suppliers