Get Invoice Exchange Rate
GET/api/purchase-orders/:purchaseOrder/invoice-currency-rate
Get the exchange rate a new bill on this purchase order would take for a given invoice date — base-currency units per one unit of the order's currency.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Response fields:
rate— the rate for the datesource— where it came from:feed(the daily rate feed on or before the date),history(a dated manual rate),default(the order is in the base currency) orpurchase_order(no dated rate exists, so the order's own rate is kept)purchase_order_rate— the rate stored on the purchase order, for comparison
Create Purchase Invoice applies this same rate when currency_rate is left out.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.