Top

Recurring Expenses

List recurring expenses
GET /recurringexpenses
List recurring expenses with pagination.
Get a recurring expense
GET /recurringexpenses/:recurring_expense_id
Get the details of a recurring expense.
Create a recurring expense
POST /recurringexpenses
Create a recurring expense.
Update a recurring expense
PUT /recurringexpenses/:recurring_expense_id
Update an existing recurring expense.
Delete a recurring expense
DELETE /recurringexpenses/:recurring_expense_id
Delete an existing recurring expense.
Stop a recurring expense
POST /recurringexpenses/:recurring_expense_id/status/stop
Stop an active recurring expense.
Resume a recurring expense
POST /recurringexpenses/:recurring_expense_id/status/resume
Resume a stopped recurring expense.
List child expenses created
GET /recurringexpenses/:recurring_expense_id/expenses
List child expenses created from recurring expense.
List recurring expense comments & history
GET /recurringexpenses/:recurring_expense_id/comments
Get history and comments of a recurring expense.

List recurring expenses

GET  /recurringexpenses

List recurring expenses with pagination.

Parameters

recurrence_name string
[100]
Search recurring expenses by recurring expense name.
Variants: recurrence_name_startswith and recurrence_name_contains
last_created_date string
[yyyy-MM-dd]
Search recurring expenses by date on when last expense was generated.
Variants: last_created_date_start, last_created_date_end, last_created_date_before and last_created_date_after
next_expense_date string
[yyyy-MM-dd]
Search recurring expenses by date on which next expense will be generated.
Variants: next_expense_date_start, next_expense_date_end, next_expense_date_before and next_expense_date_after
amount double Search recurring expenses by amount.
Variants: amount_less_than, amount_less_equals, amount_greater_than and amount_greater_equals
account_name string
[100]
Search recurring expenses by expense account.
Variants: account_name_startswith and account_name_contains
status string Search recurring expenses by recurring expense status.
Allowed Values: active, stopped and expired
customer_name string
[100]
Search recurring expenses by customer name.
Variants: customer_name_startswith and customer_name_contains
vendor_name string
[100]
Search recurring expenses by vendor name.
Variants: vendor_name_startswith and vendor_name_contains
customer_id string Search recurring expenses by customer id.
vendor_id string Search recurring expenses by vendor id.
paid_through_account_id string Search expenses by paid through account id.
description string
[100]
Search recurring expenses by description.
Variants: description_startswith and description_contains
filter_by string Filter recurring expenses by status.
Allowed Values: RecExpenseStatus.All, RecExpenseStatus.Active, RecExpenseStatus.Stopped and RecExpenseStatus.Expired
search_text string
[100]
Search recurring expenses by recurrence name or customer name.
sort_column string Sort recurring expenses.
Allowed Values: recurrence_name, last_created_date, next_expense_date, account_name, paid_through_account_name, total, customer_name, vendor_name and created_time

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "recurring_expenses": [
    {
      "recurring_expense_id": "460000000043007",
      "recurrence_name": "Monthly Rental ",
      "recurrence_frequency": "months",
      "repeat_every": 1,
      "last_created_date": "2013-09-17",
      "next_expense_date": "2013-10-17",
      "account_name": "Rent Expense",
      "paid_through_account_name": "Undeposited Funds",
      "description": "Monthly rental for Will Cooper.",
      "currency_id": "460000000000097",
      "currency_code": "USD",
      "total": 250.00,
      "is_billable": true,
      "customer_name": "Will Cooper",
      "vendor_name": "",
      "status": "active",
      "created_time": "2013-09-17T22:10:26+0530"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "report_name": "Recurring Expenses",
    "applied_filter": "RecExpenseStatus.All",
    "sort_column": "created_time",
    "sort_order": "D"
  }
}

Get a recurring expense

GET  /recurringexpenses/:recurring_expense_id

Get the details of a recurring expense.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "recurring_expense": {
    "recurring_expense_id": "460000000043007",
    "recurrence_name": "Monthly Rental ",
    "start_date": "2013-09-17",
    "end_date": "",
    "recurrence_frequency": "months",
    "repeat_every": 1,
    "last_created_date": "2013-09-17",
    "next_expense_date": "2013-10-17",
    "account_id": "460000000000430",
    "account_name": "Rent Expense",
    "paid_through_account_id": "460000000000358",
    "paid_through_account_name": "Undeposited Funds",
    "vendor_id": "",
    "vendor_name": "",
    "currency_id": "460000000000097",
    "currency_code": "USD",
    "exchange_rate": 1.00,
    "tax_id": "",
    "tax_name": "",
    "tax_percentage": 0,
    "tax_amount": 0.00,
    "sub_total": 250.00,
    "total": 250.00,
    "bcy_total": 250.00,
    "amount": 250.00,
    "description": "Monthly rental for Will Cooper.",
    "is_inclusive_tax": false,
    "is_billable": true,
    "customer_id": "460000000038029",
    "customer_name": "Will Cooper",
    "status": "active",
    "created_time": "2013-09-17T22:10:26+0530",
    "last_modified_time": "2013-09-17T22:10:26+0530",
    "project_id": "",
    "project_name": ""
  }
}

Create a recurring expense

POST  /recurringexpenses

Create a recurring expense.

Request attributes

account_id* string ID of the expense account.
paid_through_account_id* string ID of the cash/ bank account the expense is paid.
recurrence_name* string
[100]
Name of the recurring expense.
start_date* string
[yyyy-MM-dd]
Start date of the recurring expense. Expenses will not be generated for dates prior to the current date.
end_date string
[yyyy-MM-dd]
Date on which recurring expense has to expire. Can be left as empty to run forever.
recurrence_frequency* string Frequency of the recurring expense. E.g. weekly, monthly, yearly.
Allowed Values: days, weeks, months and years
repeat_every* int Frequency to repeat. E.g. 1, 6, 12.
amount* double Recurring expense amount.
tax_id
(Not applicable for the US Edition)
string ID of the tax or tax group applied to the recurring expense.
is_inclusive_tax
(Not applicable for the US Edition)
boolean Boolean to specify if the tax is inclusive of the expense amount.
vat_treatment
(UK Edition only)
string (Optional) VAT treatment for the expense. VAT treatment denotes the location of the vendor, if the vendor resides in UK then the VAT treatment is uk. If the vendor is in an EU country & if he is VAT registered then his VAT treatment is eu_vat_registered, if he resides in EU & if he is not VAT registered then his VAT treatment is eu_vat_not_registered and if he resides outside the EU then his VAT treatment is non_eu.
product_type
(UK Edition only)
string Type of the expense. This denotes whether the expense is to be treated as a goods or service purchase.
Allowed Values: goods and service.
acquisition_vat_id
(UK Edition only)
string (Optional) This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
reverse_charge_vat_id
(UK Edition only)
string (Optional) This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.
is_billable boolean Boolean to specify if the expense is billable.
customer_id string ID of the customer, if the expense is billable.
vendor_id string ID of the vendor the expense is made.
project_id string ID of the project associated with the customer.
currency_id string ID of the project associated with the expense.
exchange_rate double Exchange rate of the currency specified.

Sample Request

{
  "account_id": "460000000000430",
  "paid_through_account_id": "460000000000358",
  "recurrence_name": "Monthly Rental ",
  "start_date": "2013-09-17",
  "end_date": "",
  "recurrence_frequency": "months",
  "repeat_every": 1,
  "amount": 250.00,
  "tax_id": "",
  "is_inclusive_tax": false,
  "is_billable": true,
  "description": "Monthly rental for Will Cooper.",
  "customer_id": "460000000038029",
  "vendor_id": "",
  "project_id": "",
  "currency_id": "460000000000097",
  "exchange_rate": 1.00
}

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "The recurring expense has been created.",
  "recurring_expense": {
    "recurring_expense_id": "460000000043007",
    "recurrence_name": "Monthly Rental ",
    "start_date": "2013-09-17",
    "end_date": "",
    "recurrence_frequency": "months",
    "repeat_every": 1,
    "last_created_date": "2013-09-17",
    "next_expense_date": "2013-10-17",
    "account_id": "460000000000430",
    "account_name": "Rent Expense",
    "paid_through_account_id": "460000000000358",
    "paid_through_account_name": "Undeposited Funds",
    "vendor_id": "",
    "vendor_name": "",
    "currency_id": "460000000000097",
    "currency_code": "USD",
    "exchange_rate": 1.00,
    "tax_id": "",
    "tax_name": "",
    "tax_percentage": 0,
    "tax_amount": 0.00,
    "sub_total": 250.00,
    "total": 250.00,
    "bcy_total": 250.00,
    "amount": 250.00,
    "description": "Monthly rental for Will Cooper.",
    "is_inclusive_tax": false,
    "is_billable": true,
    "customer_id": "460000000038029",
    "customer_name": "Will Cooper",
    "status": "active",
    "created_time": "2013-09-17T22:10:26+0530",
    "last_modified_time": "2013-09-17T22:10:26+0530",
    "project_id": "",
    "project_name": ""
  }
}

Update a recurring expense

PUT  /recurringexpenses/:recurring_expense_id

Update an existing recurring expense.

Request attributes

account_id string ID of the expense account.
paid_through_account_id string ID of the cash/ bank account the expense is paid.
recurrence_name* string
[100]
Name of the recurring expense.
start_date* string
[yyyy-MM-dd]
Start date of the recurring expense. Expenses will not be generated for dates prior to the current date.
end_date string
[yyyy-MM-dd]
Date on which recurring expense has to expire. Can be left as empty to run forever.
recurrence_frequency* string Frequency of the recurring expense. E.g. weekly, monthly, yearly.
Allowed Values: days, weeks, months and years
repeat_every* int Frequency to repeat. E.g. 1, 6, 12.
amount* double Recurring expense amount.
tax_id
(Not applicable for the US Edition)
string ID of the tax or tax group applied to the recurring expense.
is_inclusive_tax
(Not applicable for the US Edition)
boolean Boolean to specify if the tax is inclusive of the expense amount.
vat_treatment
(UK Edition only)
string (Optional) VAT treatment for the expense. VAT treatment denotes the location of the vendor, if the vendor resides in UK then the VAT treatment is uk. If the vendor is in an EU country & if he is VAT registered then his VAT treatment is eu_vat_registered, if he resides in EU & if he is not VAT registered then his VAT treatment is eu_vat_not_registered and if he resides outside the EU then his VAT treatment is non_eu.
product_type
(UK Edition only)
string Type of the expense. This denotes whether the expense is to be treated as a goods or service purchase.
Allowed Values: goods and service.
acquisition_vat_id
(UK Edition only)
string (Optional) This is the ID of the tax applied in case this is an EU - goods expense and acquisition VAT needs to be reported.
reverse_charge_vat_id
(UK Edition only)
string (Optional) This is the ID of the tax applied in case this is a non UK - service expense and reverse charge VAT needs to be reported.
is_billable boolean Boolean to specify if the expense is billable.
customer_id string ID of the customer, if the expense is billable.
vendor_id string ID of the vendor the expense is made.
currency_id string ID of the project associated with the expense.
exchange_rate double Exchange rate of the currency specified.

Sample Request

{
  "account_id": "460000000000430",
  "paid_through_account_id": "460000000000358",
  "recurrence_name": "Monthly Rental ",
  "start_date": "2013-09-17",
  "end_date": "",
  "recurrence_frequency": "months",
  "repeat_every": 1,
  "amount": 250.00,
  "tax_id": "",
  "is_inclusive_tax": false,
  "is_billable": true,
  "description": "Monthly rental for Will Cooper.",
  "customer_id": "460000000038029",
  "vendor_id": "",
  "currency_id": "460000000000097",
  "exchange_rate": 1.00
}

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "Recurring expense information has been updated.",
  "recurring_expense": {
    "recurring_expense_id": "460000000043007",
    "recurrence_name": "Monthly Rental ",
    "start_date": "2013-09-17",
    "end_date": "",
    "recurrence_frequency": "months",
    "repeat_every": 1,
    "last_created_date": "2013-09-17",
    "next_expense_date": "2013-10-17",
    "account_id": "460000000000430",
    "account_name": "Rent Expense",
    "paid_through_account_id": "460000000000358",
    "paid_through_account_name": "Undeposited Funds",
    "vendor_id": "",
    "vendor_name": "",
    "currency_id": "460000000000097",
    "currency_code": "USD",
    "exchange_rate": 1.00,
    "tax_id": "",
    "tax_name": "",
    "tax_percentage": 0,
    "tax_amount": 0.00,
    "sub_total": 250.00,
    "total": 250.00,
    "bcy_total": 250.00,
    "amount": 250.00,
    "description": "Monthly rental for Will Cooper.",
    "is_inclusive_tax": false,
    "is_billable": true,
    "customer_id": "460000000038029",
    "customer_name": "Will Cooper",
    "status": "active",
    "created_time": "2013-09-17T22:10:26+0530",
    "last_modified_time": "2013-09-17T22:10:26+0530",
    "project_id": "",
    "project_name": ""
  }
}

Delete a recurring expense

DELETE  /recurringexpenses/:recurring_expense_id

Delete an existing recurring expense.

Sample Response

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

Stop a recurring expense

POST  /recurringexpenses/:recurring_expense_id/status/stop

Stop an active recurring expense.

Sample Response

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

Resume a recurring expense

POST  /recurringexpenses/:recurring_expense_id/status/resume

Resume a stopped recurring expense.

Sample Response

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

List child expenses created

GET  /recurringexpenses/:recurring_expense_id/expenses

List child expenses created from recurring expense.

Parameters

sort_column string Sort child expenses created.
Allowed Values: date, account_name, vendor_name, paid_through_account_name, customer_name and total

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "expensehistory": [
    {
      "expense_id": "460000000043017",
      "date": "2013-09-17",
      "account_name": "Rent Expense",
      "vendor_name": "",
      "paid_through_account_name": "Undeposited Funds",
      "customer_name": "Will Cooper",
      "total": 250.00,
      "status": "unbilled"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "report_name": "expense history",
    "sort_column": "expense_account",
    "sort_order": "D"
  }
}

List recurring expense comments & history

GET  /recurringexpenses/:recurring_expense_id/comments

Get history and comments of a recurring expense.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "comments": [
    {
      "comment_id": "460000000043035",
      "recurring_expense_id": "460000000043007",
      "description": "Created from recurring profile - Monthly Rental .",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "date": "2013-09-17",
      "date_description": "28 days ago",
      "time": "10:10 PM",
      "operation_type": "Added",
      "transaction_id": "460000000043017",
      "transaction_type": "expense"
    },
    {
      "comment_id": "460000000043015",
      "recurring_expense_id": "460000000043007",
      "description": "Recurrence expense created.",
      "commented_by_id": "460000000024003",
      "commented_by": "John David",
      "date": "2013-09-17",
      "date_description": "28 days ago",
      "time": "10:10 PM",
      "operation_type": "Added",
      "transaction_id": "",
      "transaction_type": "recurring_expense"
    }
  ]
}