Top

Categorize

Categorize an uncategorized transaction
POST /banktransactions/uncategorized/:transaction_id/categorize
Categorize an uncategorized transaction by creating a new transaction.
Categorize as credit note refunds
POST /banktransactions/uncategorized/:transaction_id/categorize/creditnoterefunds
Categorize an Uncategorized transaction as a refund from a credit note.
Categorize as vendor credit refunds
POST /banktransactions/uncategorized/:transaction_id/categorize/vendorcreditrefunds
Categorize an uncategorized transaction as a refund from a vendor credit.
Categorize as vendor payment
POST /banktransactions/uncategorized/:transaction_id/categorize/vendorpayments
Categorize an uncategorized transaction as Vendor Payment.
Categorize as customer payment
POST /banktransactions/uncategorized/:transaction_id/categorize/customerpayments
Categorize an uncategorized transaction as Customer Payment.
Categorize as expense
POST /banktransactions/uncategorized/:transaction_id/categorize/expense
Categorize an uncategorized transaction as Expense.
Uncategorize a categorized transaction.
POST /banktransactions/:transaction_id/uncategorize
Revert a categorized transaction as uncategorized.

Categorize an uncategorized transaction

POST  /banktransactions/uncategorized/:transaction_id/categorize

Categorize an uncategorized transaction by creating a new transaction.

Request attributes

from_account_id string The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type.
Ex: To a bank account, from-account can be:
bank , card, income, refund.
To a card account, from account can be:
bank, card, refund.
to_account_id string ID of the account to which the money gets transferred(Mandatory for specific transaction types).
Ex: From a bank account, to-account can be:
bank, card, drawings, expense,credit notes.
From a card account, to-account can be:
card, bank, expense.
transaction_type* string
[100]
Allowed transaction types for bank:
Money Inflow:
deposit, transfer_fund, sales_without_invoices, owner_contribution, other_income, interest_income, expense_refund.
Money Outflow:
transfer_fund, owner_drawings, card_payment.
Allowed transaction types for card :
Money Inflow :
refund, expense_refund, card_payment.
Money Outflow:
card_payment
Allowed Values: deposit, refund, transfer_fund, card_payment, sales_without_invoices, expense_refund, owner_contribution, interest_income, other_income and owner_drawings
payment_mode string
[100]
Mode of payment for the transaction.
(not applicable for transfer_fund, card_payment, owner_drawings)

Ex:cash, cheque, etc.,
exchange_rate double The foreign currency exchange rate value.
date string
[yyyy-MM-dd]
Transaction date.
customer_id string ID of the customer or vendor.
reference_number string
[100]
Reference Number of the transaction.
description string
[500]
A brief description about the transaction.
currency_id string The currency ID involved in the transaction.

Sample Request

{
      "from_account_id": "460000000000361",
      "to_account_id": "460000000048001",
      "transaction_type": "deposit",
      "amount": 2000.00,
      "payment_mode": "Bank Transfer",
      "date": "2013-10-01",
      "reference_number": "Ref-121",
      "description": "Deposit to Corporate Account"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The transaction is now categorized."
}

Categorize as credit note refunds

POST  /banktransactions/uncategorized/:transaction_id/categorize/creditnoterefunds

Categorize an Uncategorized transaction as a refund from a credit note.

Request attributes

creditnote_id* string ID of the credit note that has to be refunded.
date* string
[yyyy-MM-dd]
Transaction date.
refund_mode string
[50]
Mode of refund. Ex: Cash, Cheque etc.,
reference_number string
[50]
Reference Number of the transaction.
exchange_rate double The foreign currency exchange rate value.
from_account_id string The account ID from which money will be transferred(Mandatory for specific type of transactions). These accounts differ with respect to transaction_type.
Ex: To a bank account, from-account can be:
bank , card, income, refund.
To a card account, from account can be:
bank, card, refund.
description string
[2000]
A brief description about the transaction.

Sample Request

{
      "creditnote_id": "4000000030049"
      "date": "2013-08-22",
      "refund_mode": "Cash",
      "reference_number": "RE#00123",
      "amount": 57.15,
      "exchange_rate": 1.00,
      "from_account_id": "460000000000361",
      "description": ""
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The transaction is now categorized."
}

Categorize as vendor credit refunds

POST  /banktransactions/uncategorized/:transaction_id/categorize/vendorcreditrefunds

Categorize an uncategorized transaction as a refund from a vendor credit.

Request attributes

vendor_credit_id* string ID of the vendor credit that has to be refunded.
date* string
[yyyy-mm-dd]
Transaction date.
refund_mode string
[50]
Mode of refund. Ex: Cash, Cheque etc.,
reference_number string
[50]
Reference Number of the transaction.
amount double Refund amount.
exchange_rate double The foreign currency exchange rate value.
account_id string The account ID to which money will be deposited(Mandatory for specific type of transactions).
Ex: To a bank account, account can be:
bank, petty cash, undeposited funds.
description string
[2000]
A brief description about the transaction.

Sample Request

{
          "vendor_credit_id": "3000000030049"
          "date": "2014-08-06",
          "refund_mode": "Cash",
          "reference_number": "RE#00123",
          "amount": 57.15,
          "exchange_rate": 1.00,
          "account_id": "30000000000361",
          "description": "Vendor credit refund"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{"code":0,"message":"The transaction is now categorized."}

Categorize as vendor payment

POST  /banktransactions/uncategorized/:transaction_id/categorize/vendorpayments

Categorize an uncategorized transaction as Vendor Payment.

Request attributes

vendor_id string ID of the vendor.
bill_payment_id string ID of the bill.
bill_id string ID of the bill to which payment has to be applied.
amount_applied double Amount applied to the bill.
payment_mode string
[100]
Mode of payment for the transaction.
(not applicable for transfer_fund, card_payment, owner_drawings)

Ex:cash, cheque, etc.,
description string
[2000]
A brief description about the transaction.
date string
[yyyy-MM-dd]
Transaction date.
reference_number string
[50]
Reference Number of the transaction.
exchange_rate double The foreign currency exchange rate value.
paid_through_account_id string ID of the credit/ bank account the payment is made.

Sample Request

{
      "vendor_id": "460000000026049",
      "bills": [
        {
          "bill_id": "460000000053199",
          "amount_applied": 150.00
        }
      ],
      "payment_mode": "Stripe",
      "description": "",
      "date": "2013-10-07",
      "reference_number": "REF#912300",
      "exchange_rate": 1.00,
      "amount": 500.00,
      "paid_through_account_id": "460000000000358"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The transaction is now categorized."
    }

Categorize as customer payment

POST  /banktransactions/uncategorized/:transaction_id/categorize/customerpayments

Categorize an uncategorized transaction as Customer Payment.

Parameters

contact_ids string
[100]
Param Description.

Request attributes

customer_id string ID of the customer or vendor.
invoice_id string ID of the invoice to which payment has to be applied.
amount_applied double Amount applied to invoice.
payment_mode string
[50]
Mode of payment for the transaction.
(not applicable for transfer_fund, card_payment, owner_drawings)

Ex:cash, cheque, etc.,
description string
[2000]
A brief description about the transaction.
date* string
[yyyy-MM-dd]
Transaction date.
reference_number string
[50]
Reference Number of the transaction.
exchange_rate double The foreign currency exchange rate value.
bank_charges double Bank charges incurred.
tax_account_id string ID of the tax account, in case of withholding tax.
account_id string ID of account which is involved in the transaction.
contact_persons array Contact person to whom thank you mail is triggered.

Sample Request

{
      "customer_id": "460000000026049",
      "invoices": [
        {
          "invoice_id": "460000000027023",
          "amount_applied": 30.00,
          "tax_amount_withheld": 0.00
        },
        {
          "invoice_id": "460000000030029",
          "amount_applied": 20.00,
          "tax_amount_withheld": 0.00
        }
      ],
      "payment_mode": "Cash",
      "description": "",
      "date": "2013-08-14",
      "reference_number": "RSAFDG132424",
      "exchange_rate": 1.00,
      "amount": 500.00,
      "bank_charges": 0.00,
      "tax_account_id": "",
      "account_id": "460000000000361"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The transaction is now categorized."
    }

Categorize as expense

POST  /banktransactions/uncategorized/:transaction_id/categorize/expense

Categorize an uncategorized transaction as Expense.

multipart/form-data

receipt file Param Description.
Allowed Extensions: gif, png, jpeg, jpg, bmp and pdf

Request attributes

account_id string ID of account which is involved in the transaction.
paid_through_account_id string ID of the credit/ bank account the payment is made.
date string
[yyyy-MM-dd]
Transaction date.
is_inclusive_tax boolean A boolean value to specify if the expense is inclusive of tax.
is_billable boolean A boolean value to specify if the expense is billable.
reference_number string
[50]
Reference Number of the transaction.
description string
[500]
A brief description about the transaction.
customer_id string ID of the customer or vendor.
vendor_id string ID of the vendor.
currency_id string The currency ID involved in the transaction.
exchange_rate double The foreign currency exchange rate value.
project_id string ID of the project associated with the expense.

Sample Request

{
      "account_id": "460000000000418",
      "paid_through_account_id": "460000000000361",
      "date": "2013-09-11",
      "amount": 100.00,
      "tax_id": "460000000027005",
      "is_inclusive_tax": false,
      "is_billable": true,
      "reference_number": "#562SD23R4",
      "description": "Total travel expenses.",
      "customer_id": "460000000026049",
      "vendor_id": "460000000044001",
      "currency_id": "460000000000097",
      "exchange_rate": 1.00,
      "recurring_expense_id": "",
      "project_id": ""
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The transaction is now categorized."
    }

Uncategorize a categorized transaction.

POST  /banktransactions/:transaction_id/uncategorize

Revert a categorized transaction as uncategorized.

Parameters

account_id string ID of the account in which the transaction to be uncategorized exist.

Sample Response

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