Blackbaud Currencies API

openapi: 3.2.0
info:
  title: Blackbaud Currencies API
  version: '1.0'
  x-refined-note:
  - x-apievangelist-provenance differs across the merged source definitions and was not carried
  description: 'Operations tagged Currencies across 2 of this provider''s published API definitions: blackbaud-altru-administration-api-openapi.yml, blackbaud-crm-administration-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.sky.blackbaud.com/alt-adnmg
- url: https://api.sky.blackbaud.com/crm-adnmg
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Currencies
paths:
  /currencies/list:
    get:
      operationId: ListCurrencies
      summary: List currencies
      description: Lists all currencies in the system.
      parameters:
      - name: includeinactive
        in: query
        required: false
        schema:
          type: boolean
        description: Indicates whether to include inactive records.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Limits the number of records to return.
      - name: session_key
        in: query
        required: false
        schema:
          type: string
        description: A unique key provided by user for paging results. The same key will be returned in a successful response.
      - name: infinity_session
        in: query
        required: false
        schema:
          type: string
        description: Values for cookies related to the Infinity load balancer session.
      - name: more_rows_range_key
        in: query
        required: false
        schema:
          type: string
        description: Key for accessing cached results on subsequent calls to this data list.
      - name: start_row_index
        in: query
        required: false
        schema:
          type: integer
        description: Number of rows to skip,get result after these rows.
      responses:
        '200':
          description: Returned when the operation succeeds. The response body contains a collection of result entities.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrencyListCollection'
        '400':
          description: Returned when the request body is not in the appropriate format.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Returned when the user does not have permission to view the resource.
        '404':
          description: Returned when the specified resource is not found.
      tags:
      - Currencies
    servers:
    - url: https://api.sky.blackbaud.com/alt-adnmg
  /currencies/{currency_id}/currencyconfiguration:
    get:
      operationId: ViewCurrencyConfiguration
      summary: View a currency configuration
      description: This view operation loads information necessary for formatting a value as currency.
      parameters:
      - name: currency_id
        in: path
        required: true
        schema:
          type: string
        description: The currency ID.
      responses:
        '200':
          description: Returned when the operation succeeds. The response body contains the specified resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CurrencyConfigurationView'
      tags:
      - Currencies
    servers:
    - url: https://api.sky.blackbaud.com/alt-adnmg
components:
  schemas:
    CurrencyConfigurationView:
      type: object
      properties:
        name:
          maxLength: 100
          minLength: 0
          type: string
          description: The name.
        iso_4217:
          maxLength: 3
          minLength: 0
          type: string
          description: The iso code.
        decimal_digits:
          type: integer
          description: The decimal digits.
          format: int32
        currency_symbol:
          maxLength: 5
          minLength: 0
          type: string
          description: The currency symbol.
        rounding_type:
          type: string
          description: The rounding type. Available values are <i>half rounds away from zero</i>, <i>half rounds to nearest even number</i>, <i>round 1 digit to nearest multiple of 5</i>, <i>round 2 digits to the nearest multiple of 50</i>
        symbol_display_setting:
          type: string
          description: The display setting. Available values are <i>always display iso code</i>, <i>always display symbol</i>, <i>display symbol to users in regions where this currency is the default; display iso code otherwise</i>
      additionalProperties: false
      description: ViewCurrencyConfiguration
      x-display-name: Currency Properties View Form
      x-display-id: Currency Properties View Form
    CurrencyListCollection:
      type: object
      properties:
        count:
          type: integer
          description: The number of items available for retrieval into the collection after applying any request parameters.
          format: int32
        value:
          type: array
          items:
            $ref: '#/components/schemas/CurrencyListSummary'
          description: The set of items included in the response. This may be a subset of the items in the collection.
        infinity_session:
          type: string
          description: Values for cookies related to the Infinity load balancer session.
          format: string
        session_key:
          type: string
          description: Session key for paging provided by user in request query parameter.
          format: string
        total_available_rows:
          type: integer
          description: The number of total rows available.
          format: int32
        more_rows_range_key:
          type: string
          description: Key for accessing cached results on subsequent calls to this data list.
          format: string
        data_no_longer_available:
          type: boolean
          description: Indicates data is no longer available in the context of this session.
          format: boolean
      additionalProperties: false
      description: A collection of items. Data lists can contain paginated results.
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          description: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
        status:
          type: integer
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
        trace_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
        span_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
      additionalProperties: false
      description: A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
      x-display-name: Problem details
      x-display-id: ProblemDetails
    CurrencyListSummary:
      type: object
      properties:
        id:
          type: string
          description: The ID.
        name:
          type: string
          description: The currency.
        iso_4217:
          type: string
          description: The iso code.
        locale:
          type: string
          description: The locale.
        decimal_digits:
          type: integer
          description: The decimal digits.
          format: int32
        currency_symbol:
          type: string
          description: The currency symbol.
        rounding_type:
          type: string
          description: The rounding.
        active:
          type: boolean
          description: Indicates whether active.
        organization_currency:
          type: boolean
          description: Indicates whether organization currency.
      additionalProperties: false
      description: ListCurrencies
      x-display-name: Currencies List
      x-display-id: Currencies List
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}
x-refined-from:
- blackbaud-altru-administration-api-openapi.yml
- blackbaud-crm-administration-api-openapi.yml