FX exposure preview

GET/api/v1/fx/exposure

Per-currency open AR/AP exposure and unrealized gain/loss.

Operation ID: fx_exposure_api_v1_fx_exposure_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Schema: FxRevaluationResponse

as_of_datestring · daterequired

base_currencystringrequired

exposuresarray · FxCurrencyExposurerequiredFxCurrencyExposure

8 fields

currencystringrequired
receivable_foreigninteger: Open AR balance in the foreign currency (cents).
payable_foreigninteger: Open AP balance in the foreign currency (cents).
booked_ratestring
current_ratestring
receivable_gain_lossinteger: AR revaluation gain(+)/loss(-) in base cents.
payable_gain_lossinteger: AP revaluation gain(+)/loss(-) in base cents.
net_gain_lossinteger: Net gain(+)/loss(-) in base cents.

total_gain_lossinteger

Net unrealized FX gain(+)/loss(-) in base cents.

journal_entry_idstring

Posted adjusting JE id (null for a preview).

postedboolean

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

GET/api/v1/fx/exposure

bash

curl -X GET 'https://api.ondayzero.com/api/v1/fx/exposure' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'