Corgi BankDocumentation
OpenAPI

Read a posted currency conversion from or to this account

GET/accounts/{id}/fx-conversions/{conversion}

Read permission on this account, which must be the conversion's source or target. A conversion instruction whose ledger posting was not recorded answers 409: retry it under its key.

Path parameters

idstringRequired
conversionstringRequired

Returns

200 OK

actorstringRequired
conversionobjectRequired

Conversion is a posted customer conversion.

11 child attributes
business_datestring · dateRequired

A business date, YYYY-MM-DD

callerstringRequired
created_atstring · date-timeRequired
idstringRequired
journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

ownerstringRequired
priceobjectRequired

ConversionPrice is the exact result of pricing a conversion on a customer sheet.

10 child attributes
customer_ratestringRequired

Target major units per source major unit, ten decimals, for display only

source_amountintegerOptional
source_currency_codestringRequired
source_usd_equivalentintegerRequired
source_usd_per_majorstringRequired
spread_usd_minorintegerRequired
target_amountintegerOptional
target_currency_codestringRequired
target_usd_equivalentintegerRequired
target_usd_per_majorstringRequired
quote_idstringRequired
rate_sheet_idstringRequired
source_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

target_ledger_account_idstringRequired

Example lacc_2tVh8nqLxq4GbDe0K1F6S9zRcWm

created_atstring · date-timeRequired
customer_idstringRequired

Example cust_2tVh8nqLxq4GbDe0K1F6S9zRcWm

idstringRequired
kindstringRequired

Quote or conversion

quote_idstringRequired
source_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

target_account_idstringRequired

Example acct_2tVh8nqLxq4GbDe0K1F6S9zRcWm

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close