Tinvio Organization Currencies API

openapi: 3.2.0
info:
  title: Tinvio Com Organization Currencies API
  version: '1.0'
  contact:
    email: build.with@jaz.ai
    name: API Support
    url: https://jaz.ai
  description: 'Operations tagged Organization Currencies across 2 of this provider''s published API definitions: tinvio-com-openapi-original.yaml, tinvio-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.getjaz.com
tags:
- description: Manage the organization's currencies and exchange rates.
  name: Organization Currencies
paths:
  /api/v1/organization/currencies:
    get:
      description: List the organization's currencies, paginated.
      operationId: list-organization-currencies
      parameters:
      - description: Maximum number of results per page (max 1000).
        in: query
        name: limit
        schema:
          type: integer
          default: 100
      - description: Zero-indexed row offset into the result set.
        in: query
        name: offset
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: List Currencies
      tags:
      - Organization Currencies
    post:
      description: Add currencies to the organization.
      operationId: create-organization-currency
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Add Currency
      tags:
      - Organization Currencies
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddOrganizationCurrenciesRequest'
        description: The add organization currencies request.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization/currencies/rates/bulk-upsert:
    post:
      description: Create or update exchange rates in bulk.
      operationId: create-organization-currency-rate-bulk-upsert
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Bulk Create or Update Exchange Rates
      tags:
      - Organization Currencies
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpsertExchangeRatesRequest'
        description: The exchange rates to create or update.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization/currencies/{currencyCode}:
    get:
      description: Get a single organization currency by its code.
      operationId: get-organization-currency
      parameters:
      - description: Currency code (ISO 4217).
        in: path
        name: currencyCode
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get Currency
      tags:
      - Organization Currencies
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization/currencies/{currencyCode}/effective-rate:
    get:
      description: 'Resolve the organization''s effective functional-to-source FX rate for a currency at a date: the organization''s custom rate when one is configured, otherwise the platform daily rate (the same rate the platform applies for revaluation). Returns rateFunctionalToSource (1 base currency = X source currency).'
      operationId: list-organization-currency-effective-rate
      parameters:
      - description: Source currency code (ISO 4217).
        in: path
        name: currencyCode
        required: true
        schema:
          type: string
      - description: Rate date, in YYYY-MM-DD format. Defaults to today (UTC).
        in: query
        name: date
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get Effective Currency Rate
      tags:
      - Organization Currencies
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization/currencies/{currencyCode}/rates:
    get:
      description: List the currency's custom exchange rates.
      operationId: list-organization-currency-rates
      parameters:
      - description: Currency code (ISO 4217).
        in: path
        name: currencyCode
        required: true
        schema:
          type: string
      - description: Maximum number of results per page (max 1000).
        in: query
        name: limit
        schema:
          type: integer
          default: 100
      - description: Zero-indexed row offset into the result set.
        in: query
        name: offset
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: List Currency Rates
      tags:
      - Organization Currencies
    post:
      description: Add a custom exchange rate for the currency.
      operationId: create-organization-currency-rate
      parameters:
      - description: Currency code (ISO 4217).
        in: path
        name: currencyCode
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Add Currency Rate
      tags:
      - Organization Currencies
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddOrganizationCurrencyCustomRateClientRequest'
        description: The add custom rate request.
        required: true
    servers:
    - url: https://api.getjaz.com
  /api/v1/organization/currencies/{currencyCode}/rates/{resourceId}:
    delete:
      description: Delete the custom exchange rate.
      operationId: delete-organization-currency-rate
      parameters:
      - description: Currency code (ISO 4217).
        in: path
        name: currencyCode
        required: true
        schema:
          type: string
      - description: Resource ID of the custom rate.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Delete Currency Rate
      tags:
      - Organization Currencies
    get:
      description: Get a single custom exchange rate by its resource ID.
      operationId: get-organization-currency-rate
      parameters:
      - description: Currency code (ISO 4217).
        in: path
        name: currencyCode
        required: true
        schema:
          type: string
      - description: Resource ID of the custom rate.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Get Currency Rate
      tags:
      - Organization Currencies
    put:
      description: Update an existing custom exchange rate.
      operationId: update-organization-currency-rate
      parameters:
      - description: Currency code (ISO 4217).
        in: path
        name: currencyCode
        required: true
        schema:
          type: string
      - description: Resource ID of the custom rate.
        in: path
        name: resourceId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '402':
          description: Payment Required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
      - ApiKeyAuth: []
      summary: Update Currency Rate
      tags:
      - Organization Currencies
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditOrganizationCurrencyCustomRateClientRequest'
        description: The edit custom rate request.
        required: true
    servers:
    - url: https://api.getjaz.com
components:
  schemas:
    EditOrganizationCurrencyCustomRateClientRequest:
      properties:
        currencyCode:
          description: Currency code (ISO 4217), from the URL path.
          type: string
        rate:
          description: Exchange rate.
          type: number
        rateApplicableFrom:
          description: Start date for the rate, in YYYY-MM-DD format (organization timezone).
          type: string
        rateApplicableTo:
          description: End date for the rate, in YYYY-MM-DD format (organization timezone).
          type: string
        rateDirection:
          default: FUNCTIONAL_TO_SOURCE
          description: Direction the rate is quoted in. FUNCTIONAL_TO_SOURCE means 1 unit of the organization's base currency equals this many units of the currency. SOURCE_TO_FUNCTIONAL means the reverse. It is not carried over from the existing rate, so omitting it reads the value as FUNCTIONAL_TO_SOURCE.
          enum:
          - FUNCTIONAL_TO_SOURCE
          - SOURCE_TO_FUNCTIONAL
          type: string
        resourceId:
          description: Resource ID of the custom rate, from the URL path.
          type: string
      required:
      - currencyCode
      - rate
      - resourceId
      type: object
    ErrorResponse:
      properties:
        error:
          allOf:
          - $ref: '#/components/schemas/ErrorResponseData'
          description: Error details.
      type: object
    BaseResponse:
      properties:
        data:
          description: The response object.
      type: object
    BulkUpsertExchangeRateRequestItem:
      properties:
        rate:
          description: Exchange rate value.
          type: number
        rateApplicableFrom:
          description: Start date for the rate, in YYYY-MM-DD format (organization timezone).
          type: string
        rateApplicableTo:
          description: End date for the rate, in YYYY-MM-DD format (organization timezone).
          type: string
        rateDirection:
          description: Direction the rate is quoted in. FUNCTIONAL_TO_SOURCE means 1 unit of the organization's base currency equals this many units of the currency. SOURCE_TO_FUNCTIONAL means the reverse.
          enum:
          - FUNCTIONAL_TO_SOURCE
          - SOURCE_TO_FUNCTIONAL
          type: string
        sourceCurrencyCode:
          description: Source currency code (ISO 4217).
          type: string
      required:
      - rate
      - rateApplicableFrom
      - rateDirection
      - sourceCurrencyCode
      type: object
    AddOrganizationCurrenciesRequest:
      properties:
        currencies:
          description: List of ISO4217 format currencies.
          items:
            type: string
          minItems: 1
          type: array
      required:
      - currencies
      type: object
    BulkUpsertExchangeRatesRequest:
      properties:
        rates:
          description: Exchange rates to create or update.
          items:
            $ref: '#/components/schemas/BulkUpsertExchangeRateRequestItem'
          maxItems: 500
          minItems: 1
          type: array
      required:
      - rates
      type: object
    AddOrganizationCurrencyCustomRateClientRequest:
      properties:
        currencyCode:
          description: Currency code (ISO 4217), from the URL path.
          type: string
        rate:
          description: Exchange rate.
          type: number
        rateApplicableFrom:
          description: Start date for the rate, in YYYY-MM-DD format (organization timezone).
          type: string
        rateApplicableTo:
          description: End date for the rate, in YYYY-MM-DD format (UTC). When omitted, defaults to the same date as rateApplicableFrom (rate valid for that single day).
          type: string
        rateDirection:
          default: FUNCTIONAL_TO_SOURCE
          description: Direction the rate is quoted in. FUNCTIONAL_TO_SOURCE means 1 unit of the organization's base currency equals this many units of the currency. SOURCE_TO_FUNCTIONAL means the reverse. Defaults to FUNCTIONAL_TO_SOURCE when omitted.
          enum:
          - FUNCTIONAL_TO_SOURCE
          - SOURCE_TO_FUNCTIONAL
          type: string
      required:
      - currencyCode
      - rate
      - rateApplicableFrom
      type: object
    ErrorResponseData:
      properties:
        error_type:
          description: Error category, for example validation_error, invalid_request_body, or internal_server_error.
          example: validation_error
          type: string
        errors:
          description: Error messages describing what went wrong.
          items:
            type: string
          type: array
      type: object
  securitySchemes:
    ApiKeyAuth:
      description: Organization API key. Pass it in the x-jk-api-key header on every request.
      in: header
      name: x-jk-api-key
      type: apiKey
x-refined-from:
- tinvio-com-openapi-original.yaml
- tinvio-com-openapi.yml