Factset Account Composite API

openapi: 3.2.0
info:
  title: Factset Portfolio Metadata Account Composite API
  version: 1.0.0
  description: Basic operations for portfolio metadata
  termsOfService: TOS
  contact:
    name: FactSet Research Systems
    url: https://developer.factset.com/contact
    email: api@factset.com
  license:
    name: Apache License, Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- description: production
  url: https://api.factset.com/analytics/portfolio-metadata/v1
security:
- FactSetApiKey: []
- FactSetOAuth2: []
tags:
- name: Account Composite
  description: CRUD operations on Account Composite
paths:
  /account-composite:
    post:
      operationId: createAccountComposite
      description: Create a new account composite
      tags:
      - Account Composite
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/createAccountCompositeRequest'
      responses:
        '201':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/createAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '409':
          $ref: '#/components/responses/ConflictErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
    get:
      operationId: listAccountComposite
      description: List account composite
      tags:
      - Account Composite
      parameters:
      - name: path
        in: query
        required: false
        schema:
          type: string
          default: 'Client:'
          example: string
        description: Directory to list
      - name: name
        in: query
        required: false
        schema:
          type: string
          example: string
        description: Return only files whose name includes this query
      - name: description
        in: query
        required: false
        schema:
          type: string
          example: string
        description: Return only files whose name includes this query
      - name: _paginationLimit
        in: query
        required: false
        schema:
          type: number
          default: 100
          example: 0
        description: Number of directory items to return
      - name: _paginationCursor
        in: query
        required: false
        schema:
          type: string
          example: string
        description: Cursor used for paging.  Fetch items after the specified cursor
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/listAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
  /account-composite/{id}:
    delete:
      operationId: deleteAccountComposite
      description: Remove a account composite
      tags:
      - Account Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier for the account composite to be deleted
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      - name: reason
        in: query
        required: false
        schema:
          type: string
          example: string
        description: User auditable reason that the account composite is being removed
      responses:
        '204':
          description: Success
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '409':
          $ref: '#/components/responses/ConflictErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
    get:
      operationId: readAccountComposite
      description: Read a account composite
      tags:
      - Account Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier of the account composite to be read
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/readAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
    put:
      operationId: updateAccountComposite
      description: Modify a account composite
      tags:
      - Account Composite
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          example: 270c2fa8-9110-444b-9101-17e10132fe0a
        description: Unique identifier for the account composite to be updated
        example: 270c2fa8-9110-444b-9101-17e10132fe0a
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateAccountCompositeRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateAccountCompositeResponse'
        '400':
          $ref: '#/components/responses/BadRequestErrorResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedErrorResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/NotFoundErrorResponse'
        '406':
          $ref: '#/components/responses/NotAcceptableErrorResponse'
        '415':
          $ref: '#/components/responses/UnsupportedMediaTypeErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
        '501':
          $ref: '#/components/responses/NotImplementedErrorResponse'
components:
  schemas:
    listAccountCompositeResponse:
      type:
      - object
      - 'null'
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                enum:
                - AccountComposite
                description: Metadata file type formatted for consistency with the REST api
              id:
                type: string
                description: Unique identifier for this metadata file.
                example: 9a030822-d1ee-4fc0-a598-75e65d1512fd
              display:
                type: string
                description: The GUI path of this file, including the name and extension.
                example: Client:EXAMPLE.ACTM
              path:
                type: string
                description: The GUI path to this object.
                example: 'Client:'
              name:
                type: string
                description: Name of this file object including the extension.
                example: EXAMPLE.ACTM
              description:
                type:
                - string
                - 'null'
                description: User provided description of this file.
                example: Domestic equity composite
        meta:
          type: object
          properties:
            pagination:
              type: object
              properties:
                next:
                  type:
                  - string
                  - 'null'
                  example: YwAAAA==
                previous:
                  type:
                  - string
                  - 'null'
                  example: AAAAAA==
    updateAccountCompositeRequest:
      type: object
      properties:
        data:
          type: object
          properties:
            reason:
              type: string
              example: string
              description: User auditable reason for the change being made
            publisher:
              type: object
              description: Field used to update the settings used for this account in Publisher.
              properties:
                benchmarks:
                  type: object
                  description: Field used to update the set of benchmarks used in Publisher.
                  properties:
                    returns:
                      type: array
                      items:
                        type: object
                        properties:
                          portfolio:
                            type: object
                            description: 'A reference to the portfolio or vendor benchmark that contains the data this

                              account should be benchmarked against'
                            properties:
                              type:
                                type: string
                                enum:
                                - Account
                                - AccountComposite
                                - Holdings
                                - HoldingsComposite
                                - Vendor
                              id:
                                type: string
                            required:
                            - type
                            - id
                          modifier:
                            type: string
                            enum:
                            - BUY_AND_HOLD
                            - EXTERNAL
                            - ITERATED_BENCHMARK
                            - LONG_ONLY
                            - NONE
                            - PASSIVE_PORTFOLIO
                            - PASSIVE_WEIGHT
                            - SHORT_ONLY
                            - STYLE_BENCHMARK
                          isComposite:
                            type: boolean
                          comment:
                            type: string
                        required:
                        - portfolio
                    holdings:
                      type: array
                      items:
                        type: object
                        properties:
                          portfolio:
                            type: object
                            description: 'A reference to the portfolio or vendor benchmark that contains the data this

                              account should be benchmarked against'
                            properties:
                              type:
                                type: string
                                enum:
                                - Account
                                - AccountComposite
                                - Holdings
                                - HoldingsComposite
                                - Vendor
                              id:
                                type: string
                            required:
                            - type
                            - id
                          modifier:
                            type: string
                            enum:
                            - BUY_AND_HOLD
                            - EXTERNAL
                            - ITERATED_BENCHMARK
                            - LONG_ONLY
                            - NONE
                            - PASSIVE_PORTFOLIO
                            - PASSIVE_WEIGHT
                            - SHORT_ONLY
                            - STYLE_BENCHMARK
                          isSpar:
                            type: boolean
                            description: 'Used to signal that the returns data from the provided portfolio should be

                              used to benchmark this account.'
                          isComposite:
                            type: boolean
                          comment:
                            type: string
                        required:
                        - portfolio
            description:
              type: string
              description: 'Account composite description.  This should be meaningful to the end user and

                will often be used in reports generated from this account composite.'
            dataCatalog:
              type: object
              description: Field used to make changes to the account's data container references.
              properties:
                returns:
                  type: object
                  description: Set the account composite's returns data containers.
                  properties:
                    realEstateTotal:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    privateEquityNet:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    privateEquityGross:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    primaryType:
                      type: string
                      enum:
                      - CAPITAL
                      - GROSS
                      - NET
                      - NET_AFTER_TAX
                      - NET_INCOME
                      - OTHER_1
                      - OTHER_2
                      - OTHER_3
                      - OTHER_4
                      - PRIVATE_EQUITY_GROSS
                      - PRIVATE_EQUITY_NET
                      - REAL_ESTATE_TOTAL
                      description: 'Select the default returns series type for this account.  Will throw an error

                        if the selected return series type is not specified in the account.'
                    other4:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    other3:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    other2:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    other1:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    netIncome:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    netAfterTax:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    net:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    gross:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                    capital:
                      type: object
                      properties:
                        portfolio:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                              - Account
                              - AccountComposite
                              - Returns
                              - ReturnsComposite
                              - Vendor
                            id:
                              type: string
                          required:
                          - type
                          - id
                        field:
                          type: string
                      required:
                      - portfolio
                holdings:
                  type: object
                  description: Set the account composite's holdings data containers.
                  properties:
                    type:
                      type: string
                      enum:
                      - BLENDED
                      - FIXED_DOLLAR
                      - FLOATING
                      - GIPS
                      - SIMPLE
                    rebalance:
                      type: object
                      properties:
                        useActualFrequencies:
                          type: boolean
                        start:
                          type: string
                          enum:
                          - LATEST_FREQUENCY_END
                          - REPORT_START_DATE
                          - SPECIFIC_POINT
                        quarters:
                          type: string
                          enum:
                          - FEBRUARY_MAY_AUGUST_NOVEMBER
                          - JANUARY_APRIL_JULY_OCTOBER
                          - MARCH_JUNE_SEPTEMBER_DECEMBER
                        periods:
                          type: string
                          enum:
                          - APRIL_OCTOBER
                          - FEBRUARY_AUGUST
                          - JANUARY_JULY
                          - JUNE_DECEMBER
                          - MARCH_SEPTEMBER
                          - MAY_NOVEMBER
                        month:
                          type: string
                          enum:
                          - APRIL
                          - AUGUST
                          - DECEMBER
                          - FEBRUARY
                          - JANUARY
                          - JULY
                          - JUNE
                          - MARCH
                          - MAY
                          - NOVEMBER
                          - OCTOBER
                          - SEPTEMBER
                        frequency:
                          type: string
                          enum:
                          - ANNUALLY
                          - BUY_AND_HOLD
                          - CONSTANTLY
                          - DAILY
                          - MONTHLY
                          - QUARTERLY
                          - SEMI_ANNUALLY
                          - WEEKLY
                        dayOfWeek:
                          type: string
                          enum:
                          - FRIDAY
                          - MONDAY
                          - SATURDAY
                          - SUNDAY
                          - THURSDAY
                          - TUESDAY
                          - WEDNESDAY
                        dayOfMonth:
                          type: string
                        date:
                          type: string
                      required:
                      - frequency
                    methodology:
                      type: string
                      enum:
                      - BUY_AND_HOLD
                      - ORDER_MANAGMENT_SYSTEM
                      - TRANSACTIONS
                    components:
                      type: array
                      items:
                        type: object
                        properties:
                          weight:
                            type: number
                          startDate:
                            type: string
                          portfolio:
                            type: object
                            properties:
                              type:
                                type: string
                                enum:
                                - Account
                                - AccountComposite
                                - HoldingsComposite
                                - Returns
                                - ReturnsComposite
                                - Vendor
                              id:
                                type: string
                            required:
                            - type
                            - id
                          isSpar:
                            type: boolean
                          endDate:
                            type: string
                        required:
                        - weight
                        - startDate
                        - portfolio
                        - endDate
                  required:
                  - components
            benchmarks:
              type: object
              description: Field used to update the set of benchmarks used for this account.
              properties:
                returns:
                  type: object
                  properties:
                    listOfIterated:
                      type: array
                      items:
                        type: object
                        properties:
                          primary:
                            type: object
                            properties:
                              portfolio:
                                type: object
                                properties:
                                  type:
                                    type: string
                                    enum:
                                    - Account
                                    - AccountComposite
                                    - Returns
                                    - ReturnsComposite
                                    - Vendor
                                  id:
                                    type: string
                                required:
                                - type
                                - id
                              modifier:
                                type: string
                                enum:
                                - BUY_AND_HOLD
                                - EXTERNAL
                                - ITERATED_BENCHMARK
                                - LONG_ONLY
                                - NONE
                                - PASSIVE_PORTFOLIO
                                - PASSIVE_WEIGHT
                                - SHORT_ONLY
                                - STYLE_BENCHMARK
                              isComposite:
                                type: boolean
                              comment:
                                type: string
                          iterated:
                            type: array
                            items:
                              type: object
                              properties:
                                startDate:
                                  type: string
                                portfolio:
                                  type: object


# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/factset/refs/heads/main/openapi/factset-account-composite-api-openapi.yml