API

Procurement APIs

POST procurement/suppliers/{supplierId}/bank-accounts

Add a new supplier bank account to provided supplier

HTTP method POST
URI https://api.rambase.net/procurement/suppliers/{supplierId}/bank-accounts
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierId} RamBase supplier identifier
Integer, minimum 100
Custom fields Custom fields supported
Successful HTTP status code 201
API resource identifier 2242, version 14

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>
2
     <Name
Name

Name of bank account

This field is optional.

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

Required/mandatory field

Currency used for the bank account

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

>{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
     <Bank>
8
          <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>
9
          <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>
10
          <Address
Address

Required/mandatory field

Address of the bank associated with the bank account

>
11
               <CountryCode
CountryCode

Required/mandatory field

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

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

>{String}</CountryCode>
12
          </Address>
13
     </Bank>
14
</SupplierBankAccount>
1
{
2
     "supplierBankAccount": {
3
          "name
Name

Name of bank account

This field is optional.

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

Required/mandatory field

Currency used for the bank account

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

": "{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
          "bank": {
9
               "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}",
10
               "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}",
11
               "address
Address

Required/mandatory field

Address of the bank associated with the bank account

": {
12
                    "countryCode
CountryCode

Required/mandatory field

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

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

": "{String}"
13
               }
14
          }
15
     }
16
}

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.
$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]
$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.

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

Format:
1
<SupplierBankAccount>
2
     <SupplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

>{Integer}</SupplierBankAccountId>
3
     <Status
Status

Status of the supplier bank account

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Name of bank account

>{String}</Name>
5
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
6
     <Currency
Currency

Currency used for the bank account

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

Account number used to identify the bank account

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

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

Possible domain values can be found here

>{String}</Type>
9
     <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>
10
     <ExternalClearingSystemIdentificationCode
ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

>
11
          <Code
Code

Clearing code of the bank account

Possible domain values can be found here

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

Clearing bank identifier of the bank account

>{String}</BankIdentifier>
13
     </ExternalClearingSystemIdentificationCode>
14
     <Bank>
15
          <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>
16
          <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>
17
          <Address
Address

Address of the bank associated with the bank account

>
18
               <CountryCode
CountryCode

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

>{String}</CountryCode>
19
          </Address>
20
     </Bank>
21
</SupplierBankAccount>
1
{
2
     "supplierBankAccount": {
3
          "supplierBankAccountId
SupplierBankAccountId

Supplier bank account identifier

": "{Integer}",
4
          "status
Status

Status of the supplier bank account

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of bank account

": "{String}",
6
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
7
          "currency
Currency

Currency used for the bank account

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

Account number used to identify the bank account

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

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

Possible domain values can be found here

": "{String}",
10
          "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}",
11
          "externalClearingSystemIdentificationCode
ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

": {
12
               "code
Code

Clearing code of the bank account

Possible domain values can be found here

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

Clearing bank identifier of the bank account

": "{String}"
14
          },
15
          "bank": {
16
               "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}",
17
               "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}",
18
               "address
Address

Address of the bank associated with the bank account

": {
19
                    "countryCode
CountryCode

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

": "{String}"
20
               }
21
          }
22
     }
23
}

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