The Exchange Rate Revaluation object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

status string

Default: draft

posting_date string required
company string required
gain_loss_unbooked number
gain_loss_booked number
total_gain_loss number
rounding_loss_allowance number

Default: 0.05

The Exchange Rate Revaluation object 
{
  "id": "exchange-rate-revaluation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "gain_loss_unbooked": 0,
  "gain_loss_booked": 0,
  "total_gain_loss": 0,
  "rounding_loss_allowance": 0.05
}
GET /api/accounts/exchange-rate-revaluation/{id}

Retrieve a exchange rate revaluation

Retrieves the details of an existing exchange rate revaluation. Supply the unique exchange rate revaluation ID that was returned from a previous request.

Path parameters

id string required

The identifier of the exchange rate revaluation to retrieve.

Returns

Returns the exchange rate revaluation object if a valid identifier was provided.

GET /api/accounts/exchange-rate-revaluation/{id} 
curl https://api.overplane.dev/api/accounts/exchange-rate-revaluation/exchange-rate-revaluation_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "exchange-rate-revaluation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "gain_loss_unbooked": 0,
  "gain_loss_booked": 0,
  "total_gain_loss": 0,
  "rounding_loss_allowance": 0.05
}
GET /api/accounts/exchange-rate-revaluation

List all exchange rate revaluations

Returns a list of exchange rate revaluations. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of exchange rate revaluation objects.

GET /api/accounts/exchange-rate-revaluation 
curl https://api.overplane.dev/api/accounts/exchange-rate-revaluation \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "exchange-rate-revaluation_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "status": "draft",
      "posting_date": "2024-01-15",
      "company": "Example Corp",
      "gain_loss_unbooked": 0,
      "gain_loss_booked": 0,
      "total_gain_loss": 0,
      "rounding_loss_allowance": 0.05
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/accounts/exchange-rate-revaluation

Create a exchange rate revaluation

Creates a new exchange rate revaluation object.

Body parameters

status string

Default: draft

posting_date string required
company string required
gain_loss_unbooked number
gain_loss_booked number
total_gain_loss number
rounding_loss_allowance number

Default: 0.05

Returns

Returns the newly created exchange rate revaluation object if the call succeeded.

POST /api/accounts/exchange-rate-revaluation 
curl https://api.overplane.dev/api/accounts/exchange-rate-revaluation \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"posting_date":"2024-01-15","company":"Example Corp"}'
Response 
{
  "id": "exchange-rate-revaluation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "gain_loss_unbooked": 0,
  "gain_loss_booked": 0,
  "total_gain_loss": 0,
  "rounding_loss_allowance": 0.05
}
PATCH /api/accounts/exchange-rate-revaluation/{id}

Update a exchange rate revaluation

Updates the specified exchange rate revaluation by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the exchange rate revaluation to update.

Body parameters

status string

Default: draft

posting_date string
company string
gain_loss_unbooked number
gain_loss_booked number
total_gain_loss number
rounding_loss_allowance number

Default: 0.05

Returns

Returns the updated exchange rate revaluation object.

PATCH /api/accounts/exchange-rate-revaluation/{id} 
curl https://api.overplane.dev/api/accounts/exchange-rate-revaluation/exchange-rate-revaluation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"status":"draft","posting_date":"2024-01-15"}'
Response 
{
  "id": "exchange-rate-revaluation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "gain_loss_unbooked": 0,
  "gain_loss_booked": 0,
  "total_gain_loss": 0,
  "rounding_loss_allowance": 0.05
}
DELETE /api/accounts/exchange-rate-revaluation/{id}

Delete a exchange rate revaluation

Permanently deletes a exchange rate revaluation. This cannot be undone.

Path parameters

id string required

The identifier of the exchange rate revaluation to delete.

Returns

Returns a confirmation that the exchange rate revaluation has been deleted.

DELETE /api/accounts/exchange-rate-revaluation/{id} 
curl https://api.overplane.dev/api/accounts/exchange-rate-revaluation/exchange-rate-revaluation_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "exchange-rate-revaluation_abc123",
  "deleted": true
}
POST /api/accounts/exchange-rate-revaluation/{id}/submit

Submit a exchange rate revaluation

Submits a draft exchange rate revaluation, transitioning its status from draft to submitted.

Path parameters

id string required

The identifier of the exchange rate revaluation to act on.

Returns

Returns the exchange rate revaluation object with updated status.

POST /api/accounts/exchange-rate-revaluation/{id}/submit 
curl https://api.overplane.dev/api/accounts/exchange-rate-revaluation/exchange-rate-revaluation_abc123/submit \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "exchange-rate-revaluation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "gain_loss_unbooked": 0,
  "gain_loss_booked": 0,
  "total_gain_loss": 0,
  "rounding_loss_allowance": 0.05
}
POST /api/accounts/exchange-rate-revaluation/{id}/cancel

Cancel a exchange rate revaluation

Cancels a submitted exchange rate revaluation, transitioning its status to cancelled.

Path parameters

id string required

The identifier of the exchange rate revaluation to act on.

Returns

Returns the exchange rate revaluation object with updated status.

POST /api/accounts/exchange-rate-revaluation/{id}/cancel 
curl https://api.overplane.dev/api/accounts/exchange-rate-revaluation/exchange-rate-revaluation_abc123/cancel \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "exchange-rate-revaluation_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "status": "draft",
  "posting_date": "2024-01-15",
  "company": "Example Corp",
  "gain_loss_unbooked": 0,
  "gain_loss_booked": 0,
  "total_gain_loss": 0,
  "rounding_loss_allowance": 0.05
}

Line items

Child objects that belong to this exchange rate revaluation. These are accessed via the parent's ID.

Exchange Rate Revaluation Account

Attributes

idx integer
exchange_rate_revaluation_id string required
account string required
party_type string
party string
account_currency string
balance_in_account_currency number
current_exchange_rate number
balance_in_base_currency number
new_exchange_rate number required
new_balance_in_base_currency number
gain_loss number
zero_balance boolean
new_balance_in_account_currency number

Endpoints

GET /api/accounts/exchange-rate-revaluation-account?parent_id={id}
POST /api/accounts/exchange-rate-revaluation-account
PATCH /api/accounts/exchange-rate-revaluation-account/{id}
DELETE /api/accounts/exchange-rate-revaluation-account/{id}
POST /api/accounts/exchange-rate-revaluation-account/reorder
Exchange Rate Revaluation Account object 
{
  "id": "exchange-rate-revaluation-account_abc123",
  "idx": 1,
  "exchange_rate_revaluation_id": "exchange_rate_revaluation_id_example",
  "account": "account_example",
  "party_type": "party_type_example",
  "party": "party_example",
  "account_currency": "USD",
  "balance_in_account_currency": 0,
  "current_exchange_rate": 0,
  "balance_in_base_currency": 0,
  "new_exchange_rate": 0,
  "new_balance_in_base_currency": 0,
  "gain_loss": 0,
  "zero_balance": false,
  "new_balance_in_account_currency": 0
}