Currencies
Search Currencies
Search and list Currency records with filtering, sorting, and pagination.
GET
Search Currencies
A Currency represents an ISO 4217 currency available in the system. Currencies are system-managed and read-only - they cannot be created, updated, or deleted via the API. Each business has a primary currency (CurrencyId on the Business entity) used for all invoices. A secondary currency can also be configured for payment processing in a different currency. Products, charges, and other billing entities reference a currency to determine the pricing denomination. Use the Code property (e.g. USD, EUR, GBP) to identify currencies programmatically, and Format to display monetary values in the correct locale format.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Currency-List role.Query Parameters
Pagination & Sorting
Filters
Range Filters
Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of Currency records matching the query. See the Get one Currency endpoint for the full list of properties returned for each record.
Example Response