Skip to content

Latest commit

 

History

History
312 lines (240 loc) · 6.37 KB

bank-account.md

File metadata and controls

312 lines (240 loc) · 6.37 KB

Bank accounts

Add bank account

Add new bank account.

Request

URL: /bank_accounts/add
HTTP method: POST

data='{
    "bank_name":"NovaBanka",
    "iban":"SK000011112222333344",
    "swift":"suzuki",
    "default":1,
    "show":1,
    "show_account":1
}';

curl -X POST \
     -d "data=$data" \
     -H "Authorization: SFAPI email=api%40example.com&apikey=c0a4cdcdfe98ca660942d60cf7896de6&company_id=" \
     https://moja.superfaktura.sk/bank_accounts/add

Attributes

Required

none

At least one of: bank_name, iban, swift, bank_account, bank_code is required.

Optional

name type description default value
bank_account string bank account number (CZ)
bank_code string bank code (CZ)
bank_name string bank name
default int is bank account default? Will overwrite previous default account if set to 1. (0=no, 1=yes)) null (will not be set)
iban string IBAN code
show int show bank account on documents null (will not be set)
swift string SWIFT code

Response

Successful creation

{
   "id" : {
      "bank_name" : "NovaBanka",
      "country_id" : "191",
      "created" : "2019-01-23 09:37:20",
      "default" : 1,
      "iban" : "SK000011112222333344",
      "id" : "267",
      "modified" : "2019-01-23 09:37:20",
      "show" : 1,
      "show_account" : 1,
      "swift" : "suzuki",
      "user_id" : "384",
      "user_profile_id" : "393"
   },
   "error" : 0
}

Insufficient privileges

{
   "error" : 1,
   "error_message" : "Nemáte právo pridávať účet",
   "message" : "Nemáte právo pridávať účet"
}

Missing data

{
   "error" : 1,
   "error_message" : "Chýbajúce údaje",
   "message" : "Chýbajúce údaje"
}

Update bank account

Update bank account specified by ID.

Request

URL: /bank_accounts/update/{ID}
HTTP method: POST

data='{
    "bank_name":"StaroNovaBanka",
    "swift":"99999"
}';

curl -X POST \
     -d "data=$data" \
     -H "Authorization: SFAPI email=api%40example.com&apikey=c0a4cdcdfe98ca660942d60cf7896de6&company_id=" \
     https://moja.superfaktura.sk/bank_accounts/update/267

Attributes

Required

URL parameters:

name type description default value
id int bank account ID

Optional

none

Response

Successful update

{
   "error" : "0",
   "message" : "{\"BankAccount\":{\"id\":\"267\",\"user_id\":\"384\",\"user_profile_id\":\"393\",\"default\":\"1\",\"show\":\"1\",\"country_id\":\"191\",\"bank_name\":\"StaroNovaBanka\",\"bank_code\":\"\",\"account\":\"\",\"iban\":\"SK000011112222333344\",\"swift\":\"99999\",\"created\":\"2019-01-23 09:37:20\",\"modified\":\"2019-01-23 09:37:20\"}}"
}

Insufficient privileges

{
   "error" : 1,
   "error_message" : "Nemáte právo meniť účet",
   "message" : "Nemáte právo meniť účet"
}

Missing data

{
   "error" : 1,
   "error_message" : "Chýbajúce údaje",
   "message" : "Chýbajúce údaje"
}

Wrong bank account

{
   "error" : 1,
   "error_message" : "Účet neexistuje",
   "message" : "Účet neexistuje"
}

Delete bank account

Delete bank account specified by ID.

Request

URL: /bank_accounts/delete/{ID}
HTTP method: POST

curl -X POST \
     -H "Authorization: SFAPI email=api%40example.com&apikey=c0a4cdcdfe98ca660942d60cf7896de6&company_id=" \
     https://moja.superfaktura.sk/bank_accounts/delete/267

Attributes

Required

URL parameters:

name type description default value
id int bank account ID

Optional

none

Response

Successful deletion

{
   "error" : "0",
   "message" : "{\"message\":\"Bankov\\u00fd \\u00fa\\u010det zmazan\\u00fd\"}"
}

Insufficient privileges

{
   "error" : 1,
   "error_message" : "Nemáte právo zmazať účet",
   "message" : "Nemáte právo zmazať účet"
}

Wrong bank account

{
   "error" : 1,
   "error_message" : "Účet neexistuje",
   "message" : "Účet neexistuje"
}

Get list of bank accounts

Get list of bank accounts.

Request

URL: /bank_accounts/index
HTTP method: GET

curl -X GET \
     -H "Authorization: SFAPI email=api%40example.com&apikey=c0a4cdcdfe98ca660942d60cf7896de6&company_id=" \
     https://moja.superfaktura.sk/bank_accounts/index

Attributes

Required

none

Optional

none

Response

Success

{
   "error" : 0,
   "BankAccounts" : [
      {
         "BankAccount" : {
            "account" : "",
            "bank_code" : "",
            "bank_name" : "FatraBanka",
            "country_id" : "191",
            "created" : "2019-01-23 08:38:47",
            "default" : "0",
            "iban" : " SK 31 1200 000019 8742637541",
            "id" : "264",
            "modified" : "2019-01-23 09:35:38",
            "show" : "1",
            "swift" : "9876",
            "user_id" : "384",
            "user_profile_id" : "393"
         }
      },
      {
         "BankAccount" : {
            "account" : "8742637541",
            "bank_code" : "1200",
            "bank_name" : "SuperBanka",
            "country_id" : "191",
            "created" : "2019-01-23 08:39:56",
            "default" : null,
            "iban" : "",
            "id" : "265",
            "modified" : "2019-01-23 08:39:56",
            "show" : "1",
            "swift" : "",
            "user_id" : "384",
            "user_profile_id" : "393"
         }
      }
   ]
}

No bank account found

{
   "error" : 1,
   "message" : "No bank account found"
}