API

Finance APIs

PUT finance/bank-accounts/{bankAccountId}

Saves information about the bank account

HTTP method PUT
URI https://api.rambase.net/finance/bank-accounts/{bankAccountId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {bankAccountId} Bank account identifier
Integer, minimum 100
Successful HTTP status code 200
API resource identifier 5764, 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
<BankAccount
BankAccount

This field is optional.

>
2
     <Name
Name

Name of bank account

This field is optional.

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

Account number used to identify the bank account

This field is optional.

>{String}</AccountNumber>
4
     <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>
5
     <Currency
Currency

Currency used for the bank account

Applicable domain values can be found here

This field is optional.

>{String}</Currency>
6
     <IBAN
IBAN

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.

Input must match the following regular expression pattern: ^[A-Za-z]{2}[0-9]{2}[A-Za-z0-9]{1,32}$

This field is optional.

>{String}</IBAN>
7
     <Category
Category

Category of the bank

Applicable domain values can be found here

This field is optional.

>{String}</Category>
8
     <RequireStructuredPaymentReference
RequireStructuredPaymentReference

Structured reference to the payment

This field is optional.

>{Boolean}</RequireStructuredPaymentReference>
9
     <IsDefaultForRemittance
IsDefaultForRemittance

Determines if this is default bank for outgoing payments

This field is optional.

>{Boolean}</IsDefaultForRemittance>
10
     <RemittanceHandling
RemittanceHandling

Methods of transfer payment

Applicable domain values can be found here

This field is optional.

>{String}</RemittanceHandling>
11
     <RegionalId
RegionalId

Regional bank identifier of the bank account

This field is optional.

>{String}</RegionalId>
12
     <ExternalClearingSystemIdentificationCode
ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

This field is optional.

>
13
          <Code
Code

Clearing code of the bank account

Applicable domain values can be found here

This field is optional.

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

Clearing bank identifier of the bank account

This field is optional.

>{String}</BankIdentifier>
15
     </ExternalClearingSystemIdentificationCode>
16
     <Bank
Bank

This field is optional.

>
17
          <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>
18
          <Phone
Phone

Bank phone number

Input must match the following regular expression pattern: ^(\+\d{1,3}\s?)?(\()?(\d{1,4}(\s|\))?[\s.-]?)?(\d{1,5}[\s.-]?)?\d{1,5}[\s.-]?\d{1,9}$|^$

This field is optional.

>{String}</Phone>
19
          <Fax
Fax

Fax number for bank account

Input must match the following regular expression pattern: ^(\+\d{1,3}\s?)?(\()?(\d{1,4}(\s|\))?[\s.-]?)?(\d{1,5}[\s.-]?)?\d{1,5}[\s.-]?\d{1,9}$|^$

This field is optional.

>{String}</Fax>
20
          <Address
Address

Address of the bank associated with the bank account

This field is optional.

>
21
               <AddressLine1
AddressLine1

First address line

This field is optional.

>{String}</AddressLine1>
22
               <AddressLine2
AddressLine2

Second address line

This field is optional.

>{String}</AddressLine2>
23
               <PostalCode
PostalCode

Postalcode/Postcode/ZIP

This field is optional.

>{String}</PostalCode>
24
               <City
City

City/town/village

This field is optional.

>{String}</City>
25
               <CountryCode
CountryCode

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

This field is optional.

>{String}</CountryCode>
26
          </Address>
27
     </Bank>
28
     <GeneralLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

This field is optional.

>
29
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

>{Integer}</GeneralLedgerAccountId>
30
     </GeneralLedgerAccount>
31
     <IsUsedFor
IsUsedFor

This field is optional.

>
32
          <Clearing
Clearing

Indicates if the bank account is used for clearing

This field is optional.

>{Boolean}</Clearing>
33
          <VATSettlement
VATSettlement

Indicates if the bank account is used for VAT settlement

This field is optional.

>{Boolean}</VATSettlement>
34
          <CreditCardTransaction
CreditCardTransaction

Indicates if the bank account can be used for credit card payments

This field is optional.

>{Boolean}</CreditCardTransaction>
35
          <Factoring
Factoring

Indicates if the bank account is used for factoring

This field is optional.

>{Boolean}</Factoring>
36
     </IsUsedFor>
37
     <IsUsedOnOutput
IsUsedOnOutput

This field is optional.

>
38
          <SalesInvoice
SalesInvoice

Indicates if the bank account is used on print for outgoing invoices

This field is optional.

>{Boolean}</SalesInvoice>
39
          <ProformaInvoiceBasedOnSalesOrder
ProformaInvoiceBasedOnSalesOrder

Indicates if the bank account is used on print for proforma invoices, based on sales order

This field is optional.

>{Boolean}</ProformaInvoiceBasedOnSalesOrder>
40
          <ProformaInvoiceBasedOnShippingAdvice
ProformaInvoiceBasedOnShippingAdvice

Indicates if the bank account is used on print for proforma invoices, based on shipping advice

This field is optional.

>{Boolean}</ProformaInvoiceBasedOnShippingAdvice>
41
          <Dunning
Dunning

Indicates if the bank account is used on print for dunnings

This field is optional.

>{Boolean}</Dunning>
42
     </IsUsedOnOutput>
43
     <RamBaseBankIntegration
RamBaseBankIntegration

This field is optional.

>
44
          <ImportBankStatements
ImportBankStatements

Indicates if the bank statements will be handled via the BankConnector

This field is optional.

>{Boolean}</ImportBankStatements>
45
          <SendRemittance
SendRemittance

Indicates if the remittances will be handled via the BankConnector

This field is optional.

>{Boolean}</SendRemittance>
46
          <ImportIncomingPayments
ImportIncomingPayments

Indicates if the incoming payments will be handled via the BankConnector

This field is optional.

>{Boolean}</ImportIncomingPayments>
47
          <UserName
UserName

User name used to connect to BankConnector

This field is optional.

>{String}</UserName>
48
          <Password
Password

Password used to connect to BankConnector

This field is optional.

>{String}</Password>
49
          <ContractId
ContractId

Contract identifier used in BankConnector

This field is optional.

>{String}</ContractId>
50
     </RamBaseBankIntegration>
51
</BankAccount>
1
{
2
     "bankAccount
BankAccount

This field is optional.

": {
3
          "name
Name

Name of bank account

This field is optional.

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

Account number used to identify the bank account

This field is optional.

": "{String}",
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}",
6
          "currency
Currency

Currency used for the bank account

Applicable domain values can be found here

This field is optional.

": "{String}",
7
          "iBAN
IBAN

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.

Input must match the following regular expression pattern: ^[A-Za-z]{2}[0-9]{2}[A-Za-z0-9]{1,32}$

This field is optional.

": "{String}",
8
          "category
Category

Category of the bank

Applicable domain values can be found here

This field is optional.

": "{String}",
9
          "requireStructuredPaymentReference
RequireStructuredPaymentReference

Structured reference to the payment

This field is optional.

": "{Boolean}",
10
          "isDefaultForRemittance
IsDefaultForRemittance

Determines if this is default bank for outgoing payments

This field is optional.

": "{Boolean}",
11
          "remittanceHandling
RemittanceHandling

Methods of transfer payment

Applicable domain values can be found here

This field is optional.

": "{String}",
12
          "regionalId
RegionalId

Regional bank identifier of the bank account

This field is optional.

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

Clearing codes are specified by ISO20022

This field is optional.

": {
14
               "code
Code

Clearing code of the bank account

Applicable domain values can be found here

This field is optional.

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

Clearing bank identifier of the bank account

This field is optional.

": "{String}"
16
          },
17
          "bank
Bank

This field is optional.

": {
18
               "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}",
19
               "phone
Phone

Bank phone number

Input must match the following regular expression pattern: ^(\+\d{1,3}\s?)?(\()?(\d{1,4}(\s|\))?[\s.-]?)?(\d{1,5}[\s.-]?)?\d{1,5}[\s.-]?\d{1,9}$|^$

This field is optional.

": "{String}",
20
               "fax
Fax

Fax number for bank account

Input must match the following regular expression pattern: ^(\+\d{1,3}\s?)?(\()?(\d{1,4}(\s|\))?[\s.-]?)?(\d{1,5}[\s.-]?)?\d{1,5}[\s.-]?\d{1,9}$|^$

This field is optional.

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

Address of the bank associated with the bank account

This field is optional.

": {
22
                    "addressLine1
AddressLine1

First address line

This field is optional.

": "{String}",
23
                    "addressLine2
AddressLine2

Second address line

This field is optional.

": "{String}",
24
                    "postalCode
PostalCode

Postalcode/Postcode/ZIP

This field is optional.

": "{String}",
25
                    "city
City

City/town/village

This field is optional.

": "{String}",
26
                    "countryCode
CountryCode

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

This field is optional.

": "{String}"
27
               }
28
          },
29
          "generalLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

This field is optional.

": {
30
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
31
          },
32
          "isUsedFor
IsUsedFor

This field is optional.

": {
33
               "clearing
Clearing

Indicates if the bank account is used for clearing

This field is optional.

": "{Boolean}",
34
               "vATSettlement
VATSettlement

Indicates if the bank account is used for VAT settlement

This field is optional.

": "{Boolean}",
35
               "creditCardTransaction
CreditCardTransaction

Indicates if the bank account can be used for credit card payments

This field is optional.

": "{Boolean}",
36
               "factoring
Factoring

Indicates if the bank account is used for factoring

This field is optional.

": "{Boolean}"
37
          },
38
          "isUsedOnOutput
IsUsedOnOutput

This field is optional.

": {
39
               "salesInvoice
SalesInvoice

Indicates if the bank account is used on print for outgoing invoices

This field is optional.

": "{Boolean}",
40
               "proformaInvoiceBasedOnSalesOrder
ProformaInvoiceBasedOnSalesOrder

Indicates if the bank account is used on print for proforma invoices, based on sales order

This field is optional.

": "{Boolean}",
41
               "proformaInvoiceBasedOnShippingAdvice
ProformaInvoiceBasedOnShippingAdvice

Indicates if the bank account is used on print for proforma invoices, based on shipping advice

This field is optional.

": "{Boolean}",
42
               "dunning
Dunning

Indicates if the bank account is used on print for dunnings

This field is optional.

": "{Boolean}"
43
          },
44
          "ramBaseBankIntegration
RamBaseBankIntegration

This field is optional.

": {
45
               "importBankStatements
ImportBankStatements

Indicates if the bank statements will be handled via the BankConnector

This field is optional.

": "{Boolean}",
46
               "sendRemittance
SendRemittance

Indicates if the remittances will be handled via the BankConnector

This field is optional.

": "{Boolean}",
47
               "importIncomingPayments
ImportIncomingPayments

Indicates if the incoming payments will be handled via the BankConnector

This field is optional.

": "{Boolean}",
48
               "userName
UserName

User name used to connect to BankConnector

This field is optional.

": "{String}",
49
               "password
Password

Password used to connect to BankConnector

This field is optional.

": "{String}",
50
               "contractId
ContractId

Contract identifier used in BankConnector

This field is optional.

": "{String}"
51
          }
52
     }
53
}

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.

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 101013 HTTP 404 Sub-module not found
Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 107900 HTTP 400 Currency is required
Error 103927 HTTP 404 Currency not found
Error 107902 HTTP 400 Invalid Category. Legal values are B, C or T
Error 107901 HTTP 400 GL account number is required
Error 107905 HTTP 400 Invalid bank account number provided. Only numbers, <Space> and "." is allowed.
Error 105088 HTTP 400 You cannot use this type of account.
Error 105270 HTTP 400 Only accounts with the category BANK are allowed.
Error 108410 HTTP 400 Bank accounts, currency and bank type can't be changed if there are already payments for the bank