# Front Accounting Simple API API Reference

This is a simple REST API as a Front Accounting module https://github.com/cambell-prince/FrontAccountingSimpleAPI.

##### API Endpoint

    http://frontaccounting.demo.saygoweb.com/modules/api

##### Contact: cambell.prince@gmail.com

##### Version: 2.4-1.2

# bank account

bank account

## List Bank Accounts

GET /bankaccounts
200 OK
BankAccount

successful operation

##### Response Content-Types: application/json

##### Response Example (200 OK)

    [
      {
        "id": "1",
        "account_code": "1060",
        "account_type": "0",
        "bank_name": "Some Bank",
        "bank_address": "string",
        "bank_account_name": "Anne X Ample",
        "bank_account_number": "12-3456-7890-1",
        "bank_curr_code": "USD",
        "dflt_curr_act": "0",
        "bank_charge_act": "5690",
        "last_reconciled_date": "2017-12-01",
        "ending_reconcile_balance": "12.34",
        "inactive": "0"
      }
    ]

bank account

## Fetch Bank Account by id

GET /bankaccounts/id
200 OK
BankAccount

successful operation

##### Response Content-Types: application/json

##### Response Example (200 OK)

    {
      "id": "1",
      "account_code": "1060",
      "account_type": "0",
      "bank_name": "Some Bank",
      "bank_address": "string",
      "bank_account_name": "Anne X Ample",
      "bank_account_number": "12-3456-7890-1",
      "bank_curr_code": "USD",
      "dflt_curr_act": "0",
      "bank_charge_act": "5690",
      "last_reconciled_date": "2017-12-01",
      "ending_reconcile_balance": "12.34",
      "inactive": "0"
    }

# sales

sales

## List Sales

GET /sales
200 OK
Sale

successful operation

##### Response Content-Types: application/json

##### Response Example (200 OK)

    {
      "id": "1"
    }

sales

## Update Sale

PUT /sales
200 OK
Sale

successful operation

##### Response Content-Types: application/json

##### Response Example (200 OK)

    {
      "id": "1"
    }

sales

## Add Sale

POST /sales
200 OK
Sale

successful operation

##### Response Content-Types: application/json

##### Response Example (200 OK)

    {
      "id": "1"
    }

sales

## Fetch Sale by id

GET /sales/id
200 OK
Sale

successful operation

##### Response Content-Types: application/json

##### Response Example (200 OK)

    {
      "id": "1"
    }

# Schema Definitions

## BankAccount: object

A Bank Account

id: integer

  Unique id used to reference a Bank Account

account_code: string

  Account GL code

account_type: integer

  Type of the account

bank_name: string

  Name of the bank at which this account is held

bank_address: string

  Address of the Bank

bank_account_name: string

  Name of the account

bank_account_number: string

  Account number used by the Bank

bank_curr_code: string

  Currency of the account

dflt_curr_act: boolean

  True (1) if this account is the default account

bank_charge_act: string

  GL account to which bank charges are assigned

last_reconciled_date: date

  Date up to which this account was reconciled

ending_reconcile_balance: number

  Account balance at last reconcile

inactive: boolean

  True if this account is not active

##### Example

    {
      "id": "1",
      "account_code": "1060",
      "account_type": "0",
      "bank_name": "Some Bank",
      "bank_address": "string",
      "bank_account_name": "Anne X Ample",
      "bank_account_number": "12-3456-7890-1",
      "bank_curr_code": "USD",
      "dflt_curr_act": "0",
      "bank_charge_act": "5690",
      "last_reconciled_date": "2017-12-01",
      "ending_reconcile_balance": "12.34",
      "inactive": "0"
    }

## Sale: object

A Sale

id: integer

  Unique id used to reference a Sale

##### Example

    {
      "id": "1"
    }

Documentation by Spectacle