API

Procurement APIs

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

Store details for supplier bank account

HTTP method PUT
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 2245, version 13

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:
1
<SupplierBankAccount
SupplierBankAccount

This field is optional.

>
2
     <Name
Name

Name of bank account

This field is optional.

>{String}</Name>
3
     <Currency
Currency

Currency used for the bank account

Input must match the following regular expression pattern: ^[A-Z]{3}$

This field is optional.

>{String}</Currency>
4
     <AccountNumber
AccountNumber

Account number used to identify the bank account

Input must match the following regular expression pattern: [\d]+\-?[\d]+$

This field is optional.

>{String}</AccountNumber>
5
     <Type
Type

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

Applicable domain values can be found here

This field is optional.

>{String}</Type>
6
     <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.

This field is optional.

>{String}</BankCode>
7
     <ExternalClearingSystemIdentificationCode
ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

This field is optional.

>
8
          <Code
Code

Clearing code of the bank account

Applicable domain values can be found here

This field is optional.

>{String}</Code>
9
          <BankIdentifier
BankIdentifier

Clearing bank identifier of the bank account

This field is optional.

>{String}</BankIdentifier>
10
     </ExternalClearingSystemIdentificationCode>
11
     <Bank
Bank

This field is optional.

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

Input must match the following regular expression pattern: ^[A-Z]{4}[A-Z]{2}[0-9A-Z]{2}([0-9A-Z]{3})?$

This field is optional.

>{String}</SWIFTCode>
13
          <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.

This field is optional.

>{String}</InternationalBankAccountNumber>
14
          <Address
Address

Address of the bank associated with the bank account

This field is optional.

>
15
               <CountryCode
CountryCode

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

Input must match the following regular expression pattern: ^[A-Z]{2}$

This field is optional.

>{String}</CountryCode>
16
          </Address>
17
     </Bank>
18
</SupplierBankAccount>
1
{
2
     "supplierBankAccount
SupplierBankAccount

This field is optional.

": {
3
          "name
Name

Name of bank account

This field is optional.

": "{String}",
4
          "currency
Currency

Currency used for the bank account

Input must match the following regular expression pattern: ^[A-Z]{3}$

This field is optional.

": "{String}",
5
          "accountNumber
AccountNumber

Account number used to identify the bank account

Input must match the following regular expression pattern: [\d]+\-?[\d]+$

This field is optional.

": "{String}",
6
          "type
Type

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

Applicable domain values can be found here

This field is optional.

": "{String}",
7
          "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.

This field is optional.

": "{String}",
8
          "externalClearingSystemIdentificationCode
ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

This field is optional.

": {
9
               "code
Code

Clearing code of the bank account

Applicable domain values can be found here

This field is optional.

": "{String}",
10
               "bankIdentifier
BankIdentifier

Clearing bank identifier of the bank account

This field is optional.

": "{String}"
11
          },
12
          "bank
Bank

This field is optional.

": {
13
               "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.

Input must match the following regular expression pattern: ^[A-Z]{4}[A-Z]{2}[0-9A-Z]{2}([0-9A-Z]{3})?$

This field is optional.

": "{String}",
14
               "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.

This field is optional.

": "{String}",
15
               "address
Address

Address of the bank associated with the bank account

This field is optional.

": {
16
                    "countryCode
CountryCode

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

Input must match the following regular expression pattern: ^[A-Z]{2}$

This field is optional.

": "{String}"
17
               }
18
          }
19
     }
20
}

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.

$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
$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.
$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:
1
1

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 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found
Error 102689 HTTP 400 Illegal Swift Code : Swift Code should be 8 or 11 characters
Error 100501 HTTP 400 Country code is required
Error 100141 HTTP 404 Country not found