Top

Base Currency Adjustment

List base currency adjustment
GET /basecurrencyadjustment
Lists base currency adjustment
Get a base currency adjustment
GET /basecurrencyadjustment/:base_currency_adjustment_id
Get the base currency adjustment details
List account details for base currency adjustment
GET /basecurrencyadjustment/accounts
List of accounts having transaction with effect to the given exchange rate.
Create a base currency adjustment
POST /basecurrencyadjustment
Creates a base currency adjustment for the given information
Delete a base currency adjustment
DELETE /basecurrencyadjustment/:base_currency_adjustment_id
Deletes the base currency adjustment

List base currency adjustment

GET  /basecurrencyadjustment

Lists base currency adjustment

Parameters

filter_by string Filter base currency adjustment list.
Allowed Values: Date.All, Date.Today, Date.ThisWeek, Date.ThisMonth, Date.ThisQuarter and Date.ThisYear
sort_column string Sort base currency adjustment list.
Allowed Values: adjustment_date, exchange_rate, currency_code, debit_or_credit and gain_or_loss

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "base_currency_adjustments": [
    {
      "base_currency_adjustment_id": "460000000039001",
      "adjustment_date": "2013-09-04",
      "exchange_rate": 1.50,
      "currency_id": "460000000000109",
      "currency_code": "EUR",
      "notes": "Base Currency Adjustment against Hike in EUR",
      "gain_or_loss": 37.650
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 200,
    "has_more_page": false,
    "report_name": "Base Currency Adjustment",
    "applied_filter": "Date.ThisYear",
    "sort_column": "adjustment_date",
    "sort_order": "D"
  }
}

Get a base currency adjustment

GET  /basecurrencyadjustment/:base_currency_adjustment_id

Get the base currency adjustment details

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "base_currency_adjustment_id": "460000000039001",
    "currency_id": "460000000000109",
    "currency_code": "EUR",
    "adjustment_date": "2013-09-04",
    "adjustment_date_formatted": "04 Sep 2013",
    "exchange_rate": 1.50,
    "notes": "Base Currency Adjustment against Hike in EUR",
    "accounts": [
      {
        "account_id": "460000000000364",
        "account_name": "Accounts Receivable",
        "bcy_balance": 171.470,
        "bcy_balance_formatted": "$171.47",
        "fcy_balance": 139.410,
        "fcy_balance_formatted": "€139,41",
        "adjusted_balance": 209.120,
        "adjusted_balance_formatted": "$209.12",
        "gain_or_loss": 37.650,
        "gain_or_loss_formatted": "$37.65",
        "gl_specific_type": 5
      }
    ]
  }
}

List account details for base currency adjustment

GET  /basecurrencyadjustment/accounts

List of accounts having transaction with effect to the given exchange rate.

Parameters

currency_id* string ID of currency for which we need to post adjustment.
adjustment_date* string
[yyyy-MM-dd]
Date of adjustment.
exchange_rate* double Exchange rate of the currency.
notes* string
[2000]
Notes for the base currency adjustment.

Sample Response

Status: 200 OK
Content Type: application/json;charset=UTF-8
{
  "code": 0,
  "message": "success",
  "data": {
    "adjustment_date": "2013-09-05",
    "exchange_rate": 2.00,
    "currency_id": "460000000000109",
    "accounts": [
      {
        "account_id": "460000000000364",
        "account_name": "Accounts Receivable",
        "gl_specific_type": 5,
        "fcy_balance": 139.41,
        "fcy_balance_formatted": "€139,41",
        "bcy_balance": 171.47,
        "bcy_balance_formatted": "$171.47",
        "adjusted_balance": 209.12,
        "adjusted_balance_formatted": "$209.12",
        "gain_or_loss": 37.65,
        "gain_or_loss_formatted": "$37.65"
      }
    ],
    "notes": "Base Currency Adjustment against EUR",
    "adjustment_date_formatted": "05 Sep 2013",
    "currency_code": "EUR"
  }
}

Create a base currency adjustment

POST  /basecurrencyadjustment

Creates a base currency adjustment for the given information

Parameters

account_ids* string
[100]
ID of the accounts for which base currency adjustments need to be posted.

Request attributes

currency_id* string ID of currency for which we need to post adjustment.
adjustment_date* string
[yyyy-MM-dd]
Date of adjustment.
exchange_rate* double Exchange rate of the currency.
notes* string
[500]
Notes for base currency adjustment.

Sample Request

{
      "currency_id": "460000000000109",
      "adjustment_date": "2013-09-04",
      "exchange_rate": "1.5",
      "notes": "Base Currency Adjustment against Hike in EUR"
    }

Sample Response

Status: 201 Created
Content Type: application/json;charset=UTF-8
{
      "code": 0,
      "message": "The adjustment has been made. The account balances will now reflect the adjustment.",
      "data": {
        "base_currency_adjustment_id": "460000000039001",
        "currency_id": "460000000000109",
        "currency_code": "EUR",
        "adjustment_date": "2013-09-04",
        "adjustment_date_formatted": "04 Sep 2013",
        "exchange_rate": 1.5,
        "notes": "Base Currency Adjustment against Hike in EUR",
        "accounts": [
          {
            "account_id": "460000000000364",
            "account_name": "Accounts Receivable",
            "bcy_balance": 171.47,
            "bcy_balance_formatted": "$171.47",
            "fcy_balance": 139.41,
            "fcy_balance_formatted": "€139,41",
            "adjusted_balance": 209.12,
            "adjusted_balance_formatted": "$209.12",
            "gain_or_loss": 37.65,
            "gain_or_loss_formatted": "$37.65",
            "gl_specific_type": 5
          }
        ]
      }
    }

Delete a base currency adjustment

DELETE  /basecurrencyadjustment/:base_currency_adjustment_id

Deletes the base currency adjustment

Sample Response

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