Version : 1
POST /bank-accounts
Type | Name | Schema |
---|---|---|
Body | body optional |
BankAccountDto |
HTTP Code | Description | Schema |
---|---|---|
200 | successful operation | BankAccountDto |
201 | Bank account is created | No Content |
Type | Name | Scopes |
---|---|---|
Unknown | oauth2-authorisation-code | create:all |
/bank-accounts
{
"accountNumber" : "string",
"archived" : true,
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"canBeArchived" : true,
"default" : true,
"deletable" : true,
"displayName" : "string",
"doesLastReconciledStatementEntryFallIntoClosedFinancialYear" : true,
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
}
{
"accountNumber" : "string",
"archived" : true,
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"canBeArchived" : true,
"default" : true,
"deletable" : true,
"displayName" : "string",
"doesLastReconciledStatementEntryFallIntoClosedFinancialYear" : true,
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
}
GET /bank-accounts
HTTP Code | Description | Schema |
---|---|---|
200 | All bank accounts for the current user returned | < BankAccountDto > array |
Type | Name | Scopes |
---|---|---|
Unknown | oauth2-authorisation-code | read:all |
/bank-accounts
[ {
"accountNumber" : "string",
"archived" : true,
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"canBeArchived" : true,
"default" : true,
"deletable" : true,
"displayName" : "string",
"doesLastReconciledStatementEntryFallIntoClosedFinancialYear" : true,
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
} ]
GET /bank-accounts/{bankAccountId}
Type | Name | Schema |
---|---|---|
Path | bankAccountId required |
integer (int64) |
HTTP Code | Description | Schema |
---|---|---|
200 | Bank account is returned | BankAccountDto |
Type | Name | Scopes |
---|---|---|
Unknown | oauth2-authorisation-code | read:all |
/bank-accounts/0
{
"accountNumber" : "string",
"archived" : true,
"balanceDto" : {
"balance" : 0.0,
"date" : "string"
},
"bankFeed" : {
"bankName" : "string",
"remainingDays" : 0,
"state" : "string"
},
"bankName" : "string",
"bic" : "string",
"canBeArchived" : true,
"default" : true,
"deletable" : true,
"displayName" : "string",
"doesLastReconciledStatementEntryFallIntoClosedFinancialYear" : true,
"iban" : "string",
"id" : 0,
"personal" : true,
"sortCode" : "string",
"sortCodeAndAccountNumberEditable" : true,
"unmatchedEntriesAmount" : 0,
"unreconciledCrunchPaymentsAmount" : 0
}
DELETE /bank-accounts/{bankAccountId}
Type | Name | Schema |
---|---|---|
Path | bankAccountId required |
integer (int64) |
HTTP Code | Description | Schema |
---|---|---|
200 | Bank account is deleted | No Content |
404 | Bank account not found and cannot be deleted | No Content |
Type | Name | Scopes |
---|---|---|
Unknown | oauth2-authorisation-code | delete:all |
/bank-accounts/0
GET /bank-accounts/{id}/payments
The default sorting criteria is date,asc
.
Type | Name | Description | Schema | Default |
---|---|---|---|---|
Path | bankAccountId required |
integer (int64) | ||
Query | page optional |
The index of the page to retrieve, based at 0. | integer (int32) | |
Query | reconciled required |
boolean | ||
Query | size optional |
Number of records returned per page. Maximum value allowed is 20. | integer (int32) | 20 |
Query | sort optional |
Sorting criteria by a given field . |
< string (<field>[,asc|desc]) > array(multi) |
HTTP Code | Description | Schema |
---|---|---|
200 | success | PagePaymentDto |
application/json
Type | Name | Scopes |
---|---|---|
Unknown | oauth2-authorisation-code | read:all |
/bank-accounts/{id}/payments?reconciled=true
{
"content" : [ {
"amount" : 0.0,
"amountType" : "string",
"date" : "string",
"description" : "string",
"id" : 0,
"paymentName" : "string",
"paymentType" : "string",
"reference" : "string",
"statementEntryId" : 0,
"unmatchable" : true
} ],
"empty" : true,
"first" : true,
"last" : true,
"number" : 0,
"numberOfElements" : 0,
"pageable" : {
"offset" : 0,
"pageNumber" : 0,
"pageSize" : 0,
"paged" : true,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"unpaged" : true
},
"size" : 0,
"sort" : {
"empty" : true,
"sorted" : true,
"unsorted" : true
},
"totalElements" : 0,
"totalPages" : 0
}
Name | Description | Schema |
---|---|---|
balance optional |
Example : 0.0 |
number |
date optional |
Example : "string" |
string (date) |
Name | Description | Schema |
---|---|---|
accountNumber optional |
Length : 0 - 10 Example : "string" |
string |
archived optional |
Example : true |
boolean |
balanceDto optional |
Example : "[balancedto](#balancedto)" |
BalanceDto |
bankFeed optional |
Example : "[bankfeeddto](#bankfeeddto)" |
BankFeedDto |
bankName optional |
Length : 0 - 50 Example : "string" |
string |
bic optional |
Length : 0 - 11 Example : "string" |
string |
canBeArchived optional |
Example : true |
boolean |
default optional |
Example : true |
boolean |
deletable optional |
Example : true |
boolean |
displayName optional |
Example : "string" |
string |
doesLastReconciledStatementEntryFallIntoClosedFinancialYear optional |
Example : true |
boolean |
iban optional |
Length : 0 - 34 Example : "string" |
string |
id optional |
Example : 0 |
integer (int64) |
personal optional |
Example : true |
boolean |
sortCode optional |
Length : 0 - 6 Example : "string" |
string |
sortCodeAndAccountNumberEditable optional |
Example : true |
boolean |
unmatchedEntriesAmount optional |
Example : 0 |
integer (int32) |
unreconciledCrunchPaymentsAmount optional |
Example : 0 |
integer (int32) |
Name | Description | Schema |
---|---|---|
bankName optional |
Example : "string" |
string |
remainingDays optional |
Example : 0 |
integer (int64) |
state optional |
Example : "string" |
enum (available, pending, active, inactive, unavailable) |
Name | Description | Schema |
---|---|---|
content optional |
Example : [ "[paymentdto](#paymentdto)" ] |
< PaymentDto > array |
empty optional |
Example : true |
boolean |
first optional |
Example : true |
boolean |
last optional |
Example : true |
boolean |
number optional |
Example : 0 |
integer (int32) |
numberOfElements optional |
Example : 0 |
integer (int32) |
pageable optional |
Example : "[pageable](#pageable)" |
Pageable |
size optional |
Example : 0 |
integer (int32) |
sort optional |
Example : "[sort](#sort)" |
Sort |
totalElements optional |
Example : 0 |
integer (int64) |
totalPages optional |
Example : 0 |
integer (int32) |
Name | Description | Schema |
---|---|---|
offset optional |
Example : 0 |
integer (int64) |
pageNumber optional |
Example : 0 |
integer (int32) |
pageSize optional |
Example : 0 |
integer (int32) |
paged optional |
Example : true |
boolean |
sort optional |
Example : "[sort](#sort)" |
Sort |
unpaged optional |
Example : true |
boolean |
Name | Description | Schema |
---|---|---|
amount optional |
Example : 0.0 |
number |
amountType optional |
Example : "string" |
enum (DEBIT, CREDIT) |
date optional |
Example : "string" |
string (date) |
description optional |
Example : "string" |
string |
id optional |
Example : 0 |
integer (int64) |
paymentName optional |
Example : "string" |
string |
paymentType optional |
Example : "string" |
enum (SUPPLIER_PAYMENT, BANK_DEPOSIT, MONEY_TRANSFER, COMPANY_LOAN, BOUNCED_CUSTOMER_PAYMENT, COMPANY_LOAN_REPAYMENT, CUSTOMER_PAYMENT, DIRECTOR_WITHDRAWAL, EMPLOYEE_SALARY_PAYMENT, CORPORATION_TAX_PAYMENT, INTEREST_RECEIVED, VAT_PAYMENT, PAYE_NIC_PAYMENT, SHAREHOLDER_DIVIDEND_PAYMENT, PENSION_PAYMENT, OTHER_INCOME, TAX_INCENTIVE) |
reference optional |
Example : "string" |
string |
statementEntryId optional |
Example : 0 |
integer (int64) |
unmatchable optional |
Example : true |
boolean |
Name | Description | Schema |
---|---|---|
empty optional |
Example : true |
boolean |
sorted optional |
Example : true |
boolean |
unsorted optional |
Example : true |
boolean |