Skip to content
Invogi Docs

Set the organization's base currency (OWNER only)

PATCH
/organizations/current/base-currency
curl --request PATCH \
  --url https://api.invogi.com/v1/organizations/current/base-currency \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "base_currency": "GBP" }'

The currency amounts are rolled up into and cross-currency controls convert to. Must be EUR, an ECB reference currency, or a currency with a fixed parity (for example AED, SAR, QAR, BHD); other currencies are rejected because Invogi has no rate to convert them. Invoices keep the base currency their stored amounts were converted into, so changing it never rewrites history.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
base_currency
required

ISO 4217 alphabetic currency code, case-insensitive and stored upper-case. A code that is not a currency suppliers invoice in (including XXX, funds and precious-metal codes) is rejected with INVALID_REQUEST. Invoices whose currency cannot be read from an uploaded document are stored with the ISO placeholder XXX and raise a CURRENCY_UNKNOWN finding.

string
/^[A-Za-z]{3}$/

Example 

GBP

Responses

Section titled “Responses”

200

Section titled “200”

Setting updated and audit event recorded

Media typeapplication/json
object
baseCurrency
required
string
>= 3 characters <= 3 characters

Example generated

{
  "baseCurrency": "example"
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

403

Section titled “403”

API key lacks required scope/role

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}