API

Finance APIs

POST finance/bank-accounts

Resource for creating new bank account

HTTP method POST
URI https://api.rambase.net/finance/bank-accounts
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 5754, version 4

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

Required/mandatory field

Bank account identifier

Minimum value: 100

>{Integer}</BankAccountId>
3
     <Name
Name

Required/mandatory field

Name of bank account

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

Required/mandatory field

Account number used to identify the bank account

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

Required/mandatory field

Currency used for the bank account

Applicable domain values can be found here

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

Required/mandatory field

Category of the bank

Applicable domain values can be found here

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

Required/mandatory field

Finance account associated with the bank account

>
8
          <GeneralLedgerAccountId
GeneralLedgerAccountId

Required/mandatory field

General ledger account identifier

Minimum value: 1000

>{Integer}</GeneralLedgerAccountId>
9
     </GeneralLedgerAccount>
10
</BankAccount>
1
{
2
     "bankAccount": {
3
          "bankAccountId
BankAccountId

Required/mandatory field

Bank account identifier

Minimum value: 100

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

Required/mandatory field

Name of bank account

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

Required/mandatory field

Account number used to identify the bank account

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

Required/mandatory field

Currency used for the bank account

Applicable domain values can be found here

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

Required/mandatory field

Category of the bank

Applicable domain values can be found here

": "{String}",
8
          "generalLedgerAccount
GeneralLedgerAccount

Required/mandatory field

Finance account associated with the bank account

": {
9
               "generalLedgerAccountId
GeneralLedgerAccountId

Required/mandatory field

General ledger account identifier

Minimum value: 1000

": "{Integer}"
10
          }
11
     }
12
}

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]

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
<BankAccount>
2
     <BankAccountId
BankAccountId

Bank account identifier

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

Status of bank account

Possible domain values can be found here

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

Date and time of creation

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

Name of bank account

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

Account number used to identify the bank account

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

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

Possible domain values can be found here

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

Currency used for the bank account

Possible domain values can be found here

>{String}</Currency>
9
     <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.

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

Category of the bank

Possible domain values can be found here

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

Structured reference to the payment

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

Determines if this is default bank for outgoing payments

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

Methods of transfer payment

Possible domain values can be found here

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

Regional bank identifier of the bank account

>{String}</RegionalId>
15
     <MinimumPaymentAmountForReporting
MinimumPaymentAmountForReporting

In some cases the payment needs a reporting code and the reporting limit will be used for the minimum payment amount

>{Integer}</MinimumPaymentAmountForReporting>
16
     <ExternalClearingSystemIdentificationCode
ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

>
17
          <Code
Code

Clearing code of the bank account

Possible domain values can be found here

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

Clearing bank identifier of the bank account

>{String}</BankIdentifier>
19
     </ExternalClearingSystemIdentificationCode>
20
     <Bank>
21
          <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>
22
          <Phone
Phone

Bank phone number

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

Fax number for bank account

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

Address of the bank associated with the bank account

>
25
               <AddressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

>{String}</City>
29
               <Country
Country

English name of country.

>{String}</Country>
30
               <CountryCode
CountryCode

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

>{String}</CountryCode>
31
          </Address>
32
     </Bank>
33
     <GeneralLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

>
34
          <GeneralLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

>{Integer}</GeneralLedgerAccountId>
35
          <AccountNumber
AccountNumber

The account number of the general ledger account

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

Name of general ledger account

>{String}</Name>
37
          <GeneralLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

>{String}</GeneralLedgerAccountLink>
38
     </GeneralLedgerAccount>
39
     <LatestReceivedBankStatement>
40
          <BankStatementId
BankStatementId

Bank statement identifier

>{Integer}</BankStatementId>
41
          <BankStatementLink
BankStatementLink

Bank statement reference

>{String}</BankStatementLink>
42
          <BookingDate
BookingDate

Booking date of the bank statement

>{Date}</BookingDate>
43
          <Totals>
44
               <OpeningBalance
OpeningBalance

Opening balance of bank statement

>{Decimal}</OpeningBalance>
45
               <ClosingBalance
ClosingBalance

Closing balance of bank statement

>{Decimal}</ClosingBalance>
46
          </Totals>
47
     </LatestReceivedBankStatement>
48
     <IsUsedFor>
49
          <Clearing
Clearing

Indicates if the bank account is used for clearing

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

Indicates if the bank account is used for VAT settlement

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

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

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

Indicates if the bank account is used for factoring

>{Boolean}</Factoring>
53
     </IsUsedFor>
54
     <IsUsedOnOutput>
55
          <SalesInvoice
SalesInvoice

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

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

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

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

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

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

Indicates if the bank account is used on print for dunnings

>{Boolean}</Dunning>
59
     </IsUsedOnOutput>
60
     <RamBaseBankIntegration>
61
          <ProductTerms>
62
               <AcceptedAt
AcceptedAt

The date of acceptance the use of BankConnector

>{Date}</AcceptedAt>
63
               <AcceptedBy>
64
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
65
                    <LastName
LastName

Last name of employee

>{String}</LastName>
66
                    <FirstName
FirstName

First name of employee

>{String}</FirstName>
67
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
68
               </AcceptedBy>
69
          </ProductTerms>
70
          <ImportBankStatements
ImportBankStatements

Indicates if the bank statements will be handled via the BankConnector

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

Indicates if the remittances will be handled via the BankConnector

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

Indicates if the incoming payments will be handled via the BankConnector

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

User name used to connect to BankConnector

>{String}</UserName>
74
          <IsPasswordSet
IsPasswordSet

Indicates if the password to the BankConnector was set

>{Boolean}</IsPasswordSet>
75
          <ContractId
ContractId

Contract identifier used in BankConnector

>{String}</ContractId>
76
          <Currency
Currency

Currency used for the bank account

Possible domain values can be found here

>{String}</Currency>
77
          <PendingInternalAction
PendingInternalAction

The sum of the values of pending internal action payments

>{Decimal}</PendingInternalAction>
78
          <PendingConfirmation
PendingConfirmation

The sum of the values of pending confirmation payments

>{Decimal}</PendingConfirmation>
79
          <Confirmed
Confirmed

The sum of the values of confirmed payments

>{Decimal}</Confirmed>
80
          <Reconciled
Reconciled

The sum of the values of reconciled payments

>{Decimal}</Reconciled>
81
          <ConfirmedAndReconciled
ConfirmedAndReconciled

The sum of the values of confirmed and reconciled payments

>{Decimal}</ConfirmedAndReconciled>
82
          <CurrentBalance
CurrentBalance

Opening balance for current year

>{Decimal}</CurrentBalance>
83
     </RamBaseBankIntegration>
84
</BankAccount>
1
{
2
     "bankAccount": {
3
          "bankAccountId
BankAccountId

Bank account identifier

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

Status of bank account

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "name
Name

Name of bank account

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

Account number used to identify the bank account

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

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

Possible domain values can be found here

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

Currency used for the bank account

Possible domain values can be found here

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

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

Category of the bank

Possible domain values can be found here

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

Structured reference to the payment

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

Determines if this is default bank for outgoing payments

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

Methods of transfer payment

Possible domain values can be found here

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

Regional bank identifier of the bank account

": "{String}",
16
          "minimumPaymentAmountForReporting
MinimumPaymentAmountForReporting

In some cases the payment needs a reporting code and the reporting limit will be used for the minimum payment amount

": "{Integer}",
17
          "externalClearingSystemIdentificationCode
ExternalClearingSystemIdentificationCode

Clearing codes are specified by ISO20022

": {
18
               "code
Code

Clearing code of the bank account

Possible domain values can be found here

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

Clearing bank identifier of the bank account

": "{String}"
20
          },
21
          "bank": {
22
               "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}",
23
               "phone
Phone

Bank phone number

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

Fax number for bank account

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

Address of the bank associated with the bank account

": {
26
                    "addressLine1
AddressLine1

First address line

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

Second address line

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

Postalcode/Postcode/ZIP

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

City/town/village

": "{String}",
30
                    "country
Country

English name of country.

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

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

": "{String}"
32
               }
33
          },
34
          "generalLedgerAccount
GeneralLedgerAccount

Finance account associated with the bank account

": {
35
               "generalLedgerAccountId
GeneralLedgerAccountId

General ledger account identifier

": "{Integer}",
36
               "accountNumber
AccountNumber

The account number of the general ledger account

": "{String}",
37
               "name
Name

Name of general ledger account

": "{String}",
38
               "generalLedgerAccountLink
GeneralLedgerAccountLink

General ledger account reference

": "{String}"
39
          },
40
          "latestReceivedBankStatement": {
41
               "bankStatementId
BankStatementId

Bank statement identifier

": "{Integer}",
42
               "bankStatementLink
BankStatementLink

Bank statement reference

": "{String}",
43
               "bookingDate
BookingDate

Booking date of the bank statement

": "{Date}",
44
               "totals": {
45
                    "openingBalance
OpeningBalance

Opening balance of bank statement

": "{Decimal}",
46
                    "closingBalance
ClosingBalance

Closing balance of bank statement

": "{Decimal}"
47
               }
48
          },
49
          "isUsedFor": {
50
               "clearing
Clearing

Indicates if the bank account is used for clearing

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

Indicates if the bank account is used for VAT settlement

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

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

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

Indicates if the bank account is used for factoring

": "{Boolean}"
54
          },
55
          "isUsedOnOutput": {
56
               "salesInvoice
SalesInvoice

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

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

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

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

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

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

Indicates if the bank account is used on print for dunnings

": "{Boolean}"
60
          },
61
          "ramBaseBankIntegration": {
62
               "productTerms": {
63
                    "acceptedAt
AcceptedAt

The date of acceptance the use of BankConnector

": "{Date}",
64
                    "acceptedBy": {
65
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
66
                         "lastName
LastName

Last name of employee

": "{String}",
67
                         "firstName
FirstName

First name of employee

": "{String}",
68
                         "employeeLink
EmployeeLink

Employee reference

": "{String}"
69
                    }
70
               },
71
               "importBankStatements
ImportBankStatements

Indicates if the bank statements will be handled via the BankConnector

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

Indicates if the remittances will be handled via the BankConnector

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

Indicates if the incoming payments will be handled via the BankConnector

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

User name used to connect to BankConnector

": "{String}",
75
               "isPasswordSet
IsPasswordSet

Indicates if the password to the BankConnector was set

": "{Boolean}",
76
               "contractId
ContractId

Contract identifier used in BankConnector

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

Currency used for the bank account

Possible domain values can be found here

": "{String}",
78
               "pendingInternalAction
PendingInternalAction

The sum of the values of pending internal action payments

": "{Decimal}",
79
               "pendingConfirmation
PendingConfirmation

The sum of the values of pending confirmation payments

": "{Decimal}",
80
               "confirmed
Confirmed

The sum of the values of confirmed payments

": "{Decimal}",
81
               "reconciled
Reconciled

The sum of the values of reconciled payments

": "{Decimal}",
82
               "confirmedAndReconciled
ConfirmedAndReconciled

The sum of the values of confirmed and reconciled payments

": "{Decimal}",
83
               "currentBalance
CurrentBalance

Opening balance for current year

": "{Decimal}"
84
          }
85
     }
86
}

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 107901 HTTP 400 GL account number is required
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
Error 103927 HTTP 404 Currency not found
Error 107906 HTTP 400 Bank with no {0} already exists