Top

Bank Accounts

List view of accounts
GET /bankaccounts
List all bank and credit card accounts for your organization.
Get account details
GET /bankaccounts/:account_id
Get a detailed look of the account specified.
Create a bank account
POST /bankaccounts
Create a bank account or a credit card account for your organization.
Update bank account
PUT /bankaccounts/:account_id
Modify the account that was created.
Delete an account
DELETE /bankaccounts/:account_id
Delete a bank account from your organization.
Deactivate account.
POST /bankaccounts/:account_id/inactive
Make an account inactive.
Activate account
POST /bankaccounts/:account_id/active
Make an account active.

List view of accounts

GET  /bankaccounts

List all bank and credit card accounts for your organization.

Parameters

filter_by string Filter the account by their status.
Allowed Values: Status.All, Status.Active and Status.Inactive
sort_column string Sort the values based on the allowed values.
Allowed Values: account_name and account_type

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "bankaccounts": [
    {
      "account_id": "460000000049001",
      "account_name": "Corp Card Account",
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "account_type": "credit_card",
      "uncategorized_transactions": 2,
      "is_active": true,
      "balance": 2500.00,
      "bank_name": "Xavier Bank"
    },
    {
      "account_id": "460000000050127",
      "account_name": "Corporate Account",
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "account_type": "bank",
      "uncategorized_transactions": 0,
      "is_active": true,
      "balance": 0.00,
      "bank_name": "Xavier Bank",
      "routing_number": "123456789",
      "is_primary_account": false,
      "is_paypal_account": true,
      "paypal_email_address": "johnsmith@zilliuminc.com"
    },
    {
      "account_id": "460000000048001",
      "account_name": "Personal Account",
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "account_type": "bank",
      "account_number": "80000009823",
      "uncategorized_transactions": 1,
      "is_active": true,
      "balance": 145605.00,
      "bank_name": "Xavier Bank",
      "routing_number": "",
      "is_primary_account": false,
      "is_paypal_account": false
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "report_name": "Bank Accounts",
    "applied_filter": "Status.All",
    "sort_column": "account_name",
    "sort_order": "A"
  }
}

Get account details

GET  /bankaccounts/:account_id

Get a detailed look of the account specified.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "bankaccount": {
    "account_id": "460000000048001",
    "account_name": "Corporate Account",
    "currency_id": "460000000000097",
    "currency_code": "USD",
    "account_type": "bank",
    "account_number": "80000009823",
    "uncategorized_transactions": 0,
    "is_active": true,
    "balance": 0.00,
    "bank_name": "Xavier Bank",
    "routing_number": "123456789",
    "is_primary_account": false,
    "is_paypal_account": true,
    "paypal_email_address": "johnsmith@zilliuminc.com",
    "description": "Salary details."
  }
}

Create a bank account

POST  /bankaccounts

Create a bank account or a credit card account for your organization.

Request attributes

account_name* string
[100]
Unique name to identify the account.
account_type* string Type of account to be created.
Allowed Values: bank and credit_card
account_number string
[100]
Bank/Credit Card account number
currency_id string Currency in which this account is created.
description string
[500]
Optional description for the account.
bank_name string
[100]
Bank Name in which the account originally exist.
routing_number string
[100]
Unique routing number of the bank.
is_primary_account boolean A boolean value to make the account primary.
is_paypal_account boolean A boolean value to specify if it is a paypal account.
paypal_type string The type of payment for the PayPal account.
Allowed Values: standard and adaptive
paypal_email_address string
[100]
Email address of the PayPal account (mandatory)

Sample Request

{
      "account_name":"Corporate Account",
      "account_type":"bank",
      "account_number":"80000009823",
      "currency_id":460000000000097,
      "description":"Salary details.",
      "bank_name":"Xavier Bank",
      "routing_number":"123456789",
      "is_primary_account":false,
      "is_paypal_account":true,
      "paypal_email_address":"johnsmith@zilliuminc.com"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
       "code": 0,
       "message": "The account has been created.",
       "bankaccount": {
           "account_id": "460000000050127",
           "account_name": "Corporate Account",
           "currency_id": "460000000000097",
           "currency_code": "USD",
           "account_type": "bank",
           "uncategorized_transactions": 0,
           "is_active": true,
           "balance": 0.00,
           "bank_name": "Xavier Bank",
           "routing_number": "123456789",
           "is_primary_account": false,
           "is_paypal_account": true,
           "paypal_email_address": "johnsmith@zilliuminc.com",
           "description": "Salary details."
       }
    }

Update bank account

PUT  /bankaccounts/:account_id

Modify the account that was created.

Request attributes

account_name* string
[100]
Unique name to identify the account.
account_type* string Type of account to be created.
Allowed Values: bank and credit_card
account_number string
[100]
Bank/Credit Card account number
currency_id string Currency in which this account is created.
description string
[500]
Optional description for the account.
bank_name string
[100]
Bank Name in which the account originally exist.
routing_number string
[100]
Unique routing number of the bank.
is_primary_account boolean A boolean value to make the account primary.
is_paypal_account boolean A boolean value to specify if it is a paypal account.
paypal_type string The type of payment for the PayPal account.
Allowed Values: standard and adaptive
paypal_email_address string
[100]
Email address of the PayPal account (mandatory)

Sample Request

{
      "account_name": "Corporate Account",
      "account_type": "bank",
      "account_number": "80000009823",
      "currency_id": 460000000000097,
      "description": "Salary details.",
      "bank_name": "Xavier Bank",
      "routing_number": "123456789",
      "is_primary_account": true,
      "is_paypal_account": false,
    }

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The details of the account has been updated.",
      "bankaccount": {
        "account_id": "460000000048001",
        "account_name": "Corporate Account",
        "account_number": "80000009823",
        "currency_id": "460000000000097",
        "currency_code": "USD",
        "account_type": "bank",
        "uncategorized_transactions": 0,
        "is_active": true,
        "balance": 0.00,
        "bank_name": "Xavier Bank",
        "routing_number": "123456789",
        "is_primary_account": true,
      "is_paypal_account": false,
        "description": "Salary details."
      }
    }

Delete an account

DELETE  /bankaccounts/:account_id

Delete a bank account from your organization.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The account has been deleted."
}

Deactivate account.

POST  /bankaccounts/:account_id/inactive

Make an account inactive.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The account has been marked as inactive."
}

Activate account

POST  /bankaccounts/:account_id/active

Make an account active.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The account has been marked as active."
    }