Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Accounting · Reporting and close

Foreign Currency

Maintain exchange rates, revalue foreign-currency balances and translate entities for consolidation. Every operation below is generated from the published OpenAPI contract. Paths are company-scoped; read the Accounting API guide for scopes, step-up and permissions, and the Foreign Currency guide for the workflow.

15 operationsCompany moduleAll Accounting apps →
  1. GET /rest/v1.0/companies/{company_id}/accounting/fx/entitiesList entity functional currencies
  2. PATCH /rest/v1.0/companies/{company_id}/accounting/fx/entities/{id}Set an entity's functional currency
  3. GET /rest/v1.0/companies/{company_id}/accounting/fx/ratesList exchange rates
  4. POST /rest/v1.0/companies/{company_id}/accounting/fx/ratesAdd an exchange rate
  5. GET /rest/v1.0/companies/{company_id}/accounting/fx/rates/{id}Show an exchange rate
  6. PATCH /rest/v1.0/companies/{company_id}/accounting/fx/rates/{id}Change an unused exchange rate
  7. DELETE /rest/v1.0/companies/{company_id}/accounting/fx/rates/{id}Delete an unused exchange rate
  8. POST /rest/v1.0/companies/{company_id}/accounting/fx/rates/importImport exchange rates from CSV
  9. GET /rest/v1.0/companies/{company_id}/accounting/fx/revaluationsList revaluation runs
  10. POST /rest/v1.0/companies/{company_id}/accounting/fx/revaluationsPrepare a revaluation
  11. GET /rest/v1.0/companies/{company_id}/accounting/fx/revaluations/{id}Show a revaluation run
  12. POST /rest/v1.0/companies/{company_id}/accounting/fx/revaluations/{id}/decisionApprove or cancel a revaluation
  13. GET /rest/v1.0/companies/{company_id}/accounting/fx/revaluations/previewPreview a revaluation
  14. POST /rest/v1.0/companies/{company_id}/accounting/fx/setupCreate the FX accounts
  15. GET /rest/v1.0/companies/{company_id}/accounting/fx/translationTranslated trial balance

Accounting / Foreign Currency

GET /rest/v1.0/companies/{company_id}/accounting/fx/entities

List entity functional currencies

Each entity in the grant's scope with its functional currency (the base currency when unset). Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company

Response · 200 · object

  • base_currency
    stringrequired
  • entities
    object[]required
  • entities[].id
    integerrequired
  • entities[].code
    stringrequired
  • entities[].name
    stringrequired
  • entities[].functional_currency
    stringrequired
  • entities[].functional_is_base
    booleanrequired
  • entities[].is_active
    boolean
  • entities[].is_elimination
    boolean

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/entities" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

PATCH /rest/v1.0/companies/{company_id}/accounting/fx/entities/{id}

Set an entity's functional currency

ASC 830-10-45-2. Allowed only before the entity has posted or unposted entries (a later change is prospective remeasurement, which is not automated); the elimination entity stays in the base currency. Needs manage_coa over every entity. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Request body

  • entity
    objectrequired
  • entity.functional_currency
    string | nullrequired

Response · 200 · object

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • functional_currency
    stringrequired
  • functional_is_base
    booleanrequired
  • is_active
    boolean
  • is_elimination
    boolean

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/entities/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "entity": {
    "functional_currency": "string"
  }
}'

Accounting / Foreign Currency

GET /rest/v1.0/companies/{company_id}/accounting/fx/rates

List exchange rates

Effective-dated rates (spot, average, historical), newest first, with Total/Per-Page/Link headers. Any accounting grant. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • from_currency
    stringquery
    Filter: from currency
  • to_currency
    stringquery
    Filter: to currency
  • rate_type
    stringquery
    Filter: rate type One of: spot, average, historical.
  • since
    string (date)query
    Effective on or after
  • until
    string (date)query
    Effective on or before
  • page
    integerquery
    Page number
  • per_page
    integerquery
    Page size (default 100)

Response · 200 · object[]

  • id
    integerrequired
  • rate_type
    stringrequired
    One of: spot, average, historical.
  • from_currency
    stringrequired
  • to_currency
    stringrequired
  • rate
    stringrequired
  • effective_date
    string (date)required
  • source
    stringrequired
    One of: manual, csv, provider.
  • import_ref
    string | null
  • created_by_id
    integer | null
  • used_at
    string | null (date-time)required
  • immutable
    booleanrequired
  • created_at
    string (date-time)
  • updated_at
    string (date-time)

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/rates" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

POST /rest/v1.0/companies/{company_id}/accounting/fx/rates

Add an exchange rate

Adds one rate: rate units of to_currency per unit of from_currency, effective on effective_date. Needs manage_coa over every entity. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • Idempotency-Key
    stringheader
    Client retry key (a UUID is recommended); see the idempotency guide. The first successful response is stored and replayed (same status and body, header Idempotent-Replayed: true) for a repeat with the same key, body and caller; the same key with a different body or caller, or while the first request is still running, is 409. The key is marked committed in the same database transaction as the change, so a retry after a crash or timeout between commit and response replays instead of answering 409. A failed request frees the key. Keys are kept 30 days. On routes that take a body request_key (AR invoices, receipts, cash applications, reversals and deposits; payroll remittances) the header stands in for a missing request_key (a non-UUID key is mapped to a stable UUID) and a request_key that differs from it is 422. Strongly recommended: without it a retried POST can create a second document.

Request body

  • exchange_rate
    objectrequired
  • exchange_rate.rate_type
    string
    One of: spot, average, historical.
  • exchange_rate.from_currency
    stringrequired
  • exchange_rate.to_currency
    stringrequired
  • exchange_rate.effective_date
    string (date)required
  • exchange_rate.rate
    stringrequired

Response · 201 · object

  • id
    integerrequired
  • rate_type
    stringrequired
    One of: spot, average, historical.
  • from_currency
    stringrequired
  • to_currency
    stringrequired
  • rate
    stringrequired
  • effective_date
    string (date)required
  • source
    stringrequired
    One of: manual, csv, provider.
  • import_ref
    string | null
  • created_by_id
    integer | null
  • used_at
    string | null (date-time)required
  • immutable
    booleanrequired
  • created_at
    string (date-time)
  • updated_at
    string (date-time)

Errors

  • 400Malformed JSON body or Idempotency-Key header
  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 409Conflict: the rate is used by the ledger, a duplicate rate, or evidence changed since preparation
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/rates" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d '{
  "exchange_rate": {
    "from_currency": "0.00",
    "to_currency": "0.00",
    "effective_date": "2026-11-01",
    "rate": "0.00"
  }
}'

Accounting / Foreign Currency

GET /rest/v1.0/companies/{company_id}/accounting/fx/rates/{id}

Show an exchange rate

One rate, with whether it is used (immutable). Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Response · 200 · object

  • id
    integerrequired
  • rate_type
    stringrequired
    One of: spot, average, historical.
  • from_currency
    stringrequired
  • to_currency
    stringrequired
  • rate
    stringrequired
  • effective_date
    string (date)required
  • source
    stringrequired
    One of: manual, csv, provider.
  • import_ref
    string | null
  • created_by_id
    integer | null
  • used_at
    string | null (date-time)required
  • immutable
    booleanrequired
  • created_at
    string (date-time)
  • updated_at
    string (date-time)

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/rates/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

PATCH /rest/v1.0/companies/{company_id}/accounting/fx/rates/{id}

Change an unused exchange rate

Changes the rate or effective date of a rate no posting, document or revaluation has used (409 once used; a database trigger also refuses). Needs manage_coa over every entity. Audited with before and after values. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Request body

  • exchange_rate
    objectrequired
  • exchange_rate.rate
    stringrequired
  • exchange_rate.effective_date
    string (date)

Response · 200 · object

  • id
    integerrequired
  • rate_type
    stringrequired
    One of: spot, average, historical.
  • from_currency
    stringrequired
  • to_currency
    stringrequired
  • rate
    stringrequired
  • effective_date
    string (date)required
  • source
    stringrequired
    One of: manual, csv, provider.
  • import_ref
    string | null
  • created_by_id
    integer | null
  • used_at
    string | null (date-time)required
  • immutable
    booleanrequired
  • created_at
    string (date-time)
  • updated_at
    string (date-time)

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company
  • 409Conflict: the rate is used by the ledger, a duplicate rate, or evidence changed since preparation
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X PATCH "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/rates/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "exchange_rate": {
    "rate": "0.00"
  }
}'

Accounting / Foreign Currency

DELETE /rest/v1.0/companies/{company_id}/accounting/fx/rates/{id}

Delete an unused exchange rate

Deletes a rate nothing has used (409 once used). Needs manage_coa over every entity. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Response · 204

No response body.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company
  • 409Conflict: the rate is used by the ledger, a duplicate rate, or evidence changed since preparation

Example request

Generated from the contractcurl
curl -X DELETE "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/rates/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

POST /rest/v1.0/companies/{company_id}/accounting/fx/rates/import

Import exchange rates from CSV

CSV with header rate_type,from_currency,to_currency,effective_date,rate (rate_type optional, default spot). All or nothing: any invalid row, or a row that would change an existing rate, refuses the file (422; with dry_run the errors are returned). Rows equal to existing rates are unchanged, so re-importing a file is a no-op (natural key). One audit event with the file's sha256. Needs manage_coa over every entity. Returns 201 when rates were created, else 200. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company

Request body

  • import
    objectrequired
  • import.csv
    stringrequired
  • import.dry_run
    boolean

Response · 200 · object

  • dry_run
    booleanrequired
  • sha256
    stringrequired
  • created
    integerrequired
  • unchanged
    integerrequired
  • errors
    object[]required
  • errors[].line
    integerrequired
  • errors[].message
    stringrequired
  • rows
    object[]required
  • rows[].line
    integer
  • rows[].rate_type
    string
  • rows[].from_currency
    string
  • rows[].to_currency
    string
  • rows[].effective_date
    string (date)
  • rows[].rate
    string
  • rows[].action
    string
    One of: create, unchanged.

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/rates/import" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "import": {
    "csv": "string"
  }
}'

Accounting / Foreign Currency

GET /rest/v1.0/companies/{company_id}/accounting/fx/revaluations

List revaluation runs

Month-end revaluation runs, newest first (at most 200), in the grant's entities. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • entity_id
    integerquery
    Filter: entity
  • period_id
    integerquery
    Filter: period

Response · 200 · object[]

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded.
  • as_of
    string (date)required
  • reverse_on
    string (date)required
  • evidence_hash
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].currency
    stringrequired
  • lines[].txn_balance
    stringrequired
  • lines[].functional_balance
    stringrequired
  • lines[].rate
    stringrequired
  • lines[].target
    stringrequired
  • lines[].adjustment
    stringrequired
  • rates
    object[]required
  • total_gain
    stringrequired
  • total_loss
    stringrequired
  • net_gain
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • cancel_reason
    string | null
  • unchanged
    boolean

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/revaluations" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

POST /rest/v1.0/companies/{company_id}/accounting/fx/revaluations

Prepare a revaluation

ASC 830-20-35-1: restates the entity's foreign-currency cash, receivable, payable and intercompany balances at the period-end spot rate. Saves a prepared run with its lines, rates and evidence hash; nothing posts until a different user approves. Natural key: at most one prepared run per entity and period; preparing again with unchanged balances and rates returns the current run (200, unchanged: true). Refused (422) in a closed period, when the next period (where it reverses) is missing or closed, when a prior revaluation has not yet auto-reversed, or when no gain/loss account is mapped. Needs post_journal and the entity in the grant. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company

Request body

  • revaluation
    objectrequired
  • revaluation.entity_id
    integerrequired
  • revaluation.period_id
    integerrequired

Response · 200 · object

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded.
  • as_of
    string (date)required
  • reverse_on
    string (date)required
  • evidence_hash
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].currency
    stringrequired
  • lines[].txn_balance
    stringrequired
  • lines[].functional_balance
    stringrequired
  • lines[].rate
    stringrequired
  • lines[].target
    stringrequired
  • lines[].adjustment
    stringrequired
  • rates
    object[]required
  • total_gain
    stringrequired
  • total_loss
    stringrequired
  • net_gain
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • cancel_reason
    string | null
  • unchanged
    boolean

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/revaluations" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "revaluation": {
    "entity_id": 1,
    "period_id": 1
  }
}'

Accounting / Foreign Currency

GET /rest/v1.0/companies/{company_id}/accounting/fx/revaluations/{id}

Show a revaluation run

One run with its lines, rates and posting. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Response · 200 · object

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded.
  • as_of
    string (date)required
  • reverse_on
    string (date)required
  • evidence_hash
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].currency
    stringrequired
  • lines[].txn_balance
    stringrequired
  • lines[].functional_balance
    stringrequired
  • lines[].rate
    stringrequired
  • lines[].target
    stringrequired
  • lines[].adjustment
    stringrequired
  • rates
    object[]required
  • total_gain
    stringrequired
  • total_loss
    stringrequired
  • net_gain
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • cancel_reason
    string | null
  • unchanged
    boolean

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/revaluations/1" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

POST /rest/v1.0/companies/{company_id}/accounting/fx/revaluations/{id}/decision

Approve or cancel a revaluation

approve (approve_journal, never the preparer): recomputes the evidence (409 if balances or rates moved), posts the GJ entry dated the period end, auto-reversing on the next period's first day, and stamps the rates used. cancel (post_journal, with a reason) withdraws a prepared run. A repeat of a finished decision returns the run. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • id
    integerpathrequired

Request body

  • decision
    objectrequired
  • decision.action
    stringrequired
    One of: approve, cancel.
  • decision.reason
    string

Response · 200 · object

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
    One of: prepared, posted, cancelled, superseded.
  • as_of
    string (date)required
  • reverse_on
    string (date)required
  • evidence_hash
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].currency
    stringrequired
  • lines[].txn_balance
    stringrequired
  • lines[].functional_balance
    stringrequired
  • lines[].rate
    stringrequired
  • lines[].target
    stringrequired
  • lines[].adjustment
    stringrequired
  • rates
    object[]required
  • total_gain
    stringrequired
  • total_loss
    stringrequired
  • net_gain
    stringrequired
  • prepared_by_id
    integerrequired
  • prepared_at
    string (date-time)required
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • cancel_reason
    string | null
  • unchanged
    boolean

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company
  • 409Conflict: the rate is used by the ledger, a duplicate rate, or evidence changed since preparation
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/revaluations/1/decision" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "decision": {
    "action": "approve"
  }
}'

Accounting / Foreign Currency

GET /rest/v1.0/companies/{company_id}/accounting/fx/revaluations/preview

Preview a revaluation

What a revaluation of the entity for the period would post now. No write. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • entity_id
    integerqueryrequired
    Entity
  • period_id
    integerqueryrequired
    Period

Response · 200 · object

  • as_of
    string (date)required
  • functional_currency
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].currency
    stringrequired
  • lines[].txn_balance
    stringrequired
  • lines[].functional_balance
    stringrequired
  • lines[].rate
    stringrequired
  • lines[].target
    stringrequired
  • lines[].adjustment
    stringrequired
  • rates
    object[]required
  • net_gain
    stringrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/revaluations/preview" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

POST /rest/v1.0/companies/{company_id}/accounting/fx/setup

Create the FX accounts

Creates and maps any missing FX_GAIN_LOSS (7500), FX_UNREALIZED_GAIN_LOSS (7510) and CTA (3600, accumulated other comprehensive income) accounts. Idempotent: nothing is created when every role is mapped (200). Needs manage_coa over every entity. Audited. Requires the accounting:write scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company

Response · 200 · object

  • created
    object[]required
  • created[].role
    stringrequired
  • created[].account_id
    integerrequired
  • created[].number
    stringrequired

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token

Example request

Generated from the contractcurl
curl -X POST "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/setup" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Accounting / Foreign Currency

GET /rest/v1.0/companies/{company_id}/accounting/fx/translation

Translated trial balance

ASC 830-30 current rate method for one entity as of a date: assets and liabilities at the closing rate (reporting-currency balances at their transaction amount), income and expense at monthly average rates, equity at historical rates, prior years' earnings in retained earnings, and the cumulative translation adjustment. Lists the rates used. Requires the accounting:read scope.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
    Company id; must be the token's company
  • entity_id
    integerqueryrequired
    Entity
  • as_of
    string (date)queryrequired
    As-of date

Response · 200 · object

  • entity_id
    integerrequired
  • as_of
    string (date)required
  • functional_currency
    stringrequired
  • reporting_currency
    stringrequired
  • lines
    object[]required
  • lines[].account_id
    integerrequired
  • lines[].number
    string | null
  • lines[].name
    string | null
  • lines[].type
    string | null
  • lines[].net
    stringrequired
  • cta
    stringrequired
  • net_income
    stringrequired
  • rates
    string[]required

Errors

  • 401Missing or invalid bearer token
  • 403No accounting access, missing permission, wrong company, entity outside the grant, or read-only token
  • 404Not found in this company
  • 422Validation failed, a closed period, a missing rate or account mapping

Example request

Generated from the contractcurl
curl -X GET "https://app.os.construction/rest/v1.0/companies/1/accounting/fx/translation" \
  -H "Authorization: Bearer $OS_ACCESS_TOKEN"

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file