Aramark Financial API

openapi: 3.2.0
info:
  title: Aramark Financial API
  version: 1.0.0-oas3
  description: 'Operations tagged Financial across 2 of this provider''s published API definitions: aramark-organization-hierarchy-openapi.json, aramark-organization-profit-center-core-details-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://qa-marko.aramark.net/v1/organization/hierarchy
  description: Testing server
- url: https://dev-marko.aramark.net/v1/organization/hierarchy
  description: Development server
- url: https://qa-marko.aramark.net/v1/organization
  description: Testing server
- url: https://dev-marko.aramark.net/v1/organization
security:
- apiKey: []
tags:
- name: Financial
  description: Get Financial Hierarchy Nodes
paths:
  /financial/{org_value}:
    get:
      operationId: getFinancialHierarchy
      summary: Financial hierarchy nodes
      description: 'Returns financial hierarchy nodes.


        !This endpoint is in prod'
      tags:
      - Financial
      parameters:
      - $ref: '#/components/parameters/orgValueParam'
      - $ref: '#/components/parameters/hierarchyLevelParam'
      - $ref: '#/components/parameters/statusParam'
      - $ref: '#/components/parameters/searchParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam'
      responses:
        '200':
          description: Provides Aramark Financial Hierarchy Nodes
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success', 'Error' or 'Not Found'
                    default: Success
                    example: Success
                  count:
                    type: string
                    description: Number of records returned
                    default: '0'
                    example: '1'
                  nodes:
                    type: array
                    items:
                      $ref: '#/components/schemas/financial_organizations'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
    servers:
    - url: https://qa-marko.aramark.net/v1/organization/hierarchy
      description: Testing server
    - url: https://dev-marko.aramark.net/v1/organization/hierarchy
      description: Development server
  /profit_center/financial/{org_value}:
    get:
      operationId: getProfitCenterDetailsFinancialByOrgValue
      tags:
      - Financial
      summary: Returns a collection of Profit Center Financial Attributes for One Profit Center
      description: '!This endpoint is in production'
      parameters:
      - $ref: '#/components/parameters/orgValueParam_2'
      - $ref: '#/components/parameters/formatParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sizeParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam_2'
      responses:
        '200':
          description: Collection of Profit Center Financial Attributes
          content:
            '*/*':
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success' or 'Error'
                    default: Success
                  count:
                    type: string
                    description: Number of records returned
                  profit_center_financial_details:
                    type: array
                    items:
                      $ref: '#/components/schemas/profit_center_financial_details'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
    servers:
    - url: https://qa-marko.aramark.net/v1/organization
      description: Testing server
    - url: https://dev-marko.aramark.net/v1/organization
  /profit_center/financial:
    get:
      operationId: getProfitCenterDetailsFinancial
      tags:
      - Financial
      summary: Returns a collection of Profit Center Financial Attributes
      description: '!This endpoint is in production'
      parameters:
      - $ref: '#/components/parameters/searchParam_2'
      - $ref: '#/components/parameters/formatParam'
      - $ref: '#/components/parameters/pageParam'
      - $ref: '#/components/parameters/sizeParam'
      - $ref: '#/components/parameters/bypassCacheParam'
      - $ref: '#/components/parameters/smokeParam_2'
      responses:
        '200':
          description: Collection of Profit Center Financial Attributes
          content:
            '*/*':
              schema:
                type: object
                properties:
                  status:
                    type: string
                    description: ENUM 'Success' or 'Error'
                    default: Success
                  count:
                    type: string
                    description: Number of records returned
                  profit_center_financial_details:
                    type: array
                    items:
                      $ref: '#/components/schemas/profit_center_financial_details'
        '404':
          description: Requested resource does not exist.
        '405':
          description: HTTP Verb / Operation not supported
    servers:
    - url: https://qa-marko.aramark.net/v1/organization
      description: Testing server
    - url: https://dev-marko.aramark.net/v1/organization
components:
  parameters:
    orgValueParam:
      in: path
      name: org_value
      description: 'Aramark Organization code. This must be at the same level of the top_node parameter. Expects nine characters, _include leading zeros_.

        '
      required: true
      schema:
        type: string
    bypassCacheParam:
      in: header
      name: bypass-cache
      description: This HTTP Header variable will bypass cache.
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
        default: 'false'
    hierarchyLevelParam:
      in: query
      name: hierarchy_level
      description: "This will determine the level of the Organization that the output object corresponds to. \nLevel of the Aramark Organization:\n  * `SLOC` - Sub Location\n  * `LOC` - Location\n  * `PC` - Profit Center\n  * `DST` - District\n  * `REG` - Region\n  * `LOB` - Line of Business\n  * `BSU` - Business Unit\n  * `DIV` - Division\n"
      required: true
      schema:
        type: string
        enum:
        - SLOC
        - LOC
        - PC
        - DST
        - REG
        - LOB
        - BSU
        - DIV
    smokeParam:
      in: header
      name: smoke
      description: When set to 'true' this HTTP header variable will route the API call to the Integration testing environment.  Only applicable in QA.
      schema:
        type: string
        enum:
        - 'true'
        - 'false'
    statusParam:
      in: query
      name: status
      description: "Organization status:\n  * `A` - Active\n  * `X` - Inactive\n"
      required: false
      schema:
        type: string
        enum:
        - A
        - X
    searchParam:
      in: query
      name: search
      description: Used to search against the Organization Name.  Must be between 2-10 characters without white spaces
      required: false
      schema:
        type: string
    orgValueParam_2:
      in: path
      name: org_value
      required: true
      description: provide business organization code in URL to filter data set
      schema:
        type: string
    formatParam:
      in: query
      name: format
      required: false
      description: allows to change the output to a desired format. 'JSON' - JSON, 'CSV' - CSV, 'XLS' - Excel
      schema:
        type: string
        enum:
        - JSON
        - CSV
        - XLS
    sizeParam:
      in: query
      name: size
      description: Number of records to be returned in each page of result set
      schema:
        type: string
        default: 50
    smokeParam_2:
      in: header
      name: smoke
      description: When set to 'true' this HTTP header variable will route the API call to the Integration testing environment. Only applicable in QA.
      schema:
        type: string
    pageParam:
      in: query
      name: page
      description: Page number of result set
      schema:
        type: number
        default: 1
    searchParam_2:
      in: query
      name: search
      description: Used to search a specific Profit Center.  Will match against Name and Value.  Maximum length of 20 characters.
      schema:
        type: string
  schemas:
    divisions:
      type: object
      properties:
        division_name:
          type: string
          description: Aramark Division Name
        division:
          type: string
          description: Aramark Division Code
        division_id:
          type: number
          description: Division Node ID
        status:
          type: string
          description: The status of the Division. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the Division Status
    districts:
      type: object
      properties:
        district_name:
          type: string
          description: Aramark District Name
        district:
          type: string
          description: Aramark District Code
        district_id:
          type: number
          description: District Node ID
        status:
          type: string
          description: The status of the District. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the District Status
    locations:
      type: object
      properties:
        location_name:
          type: string
          description: Aramark Location Name
        location:
          type: string
          description: Aramark Location Code
        location_id:
          type: number
          description: Location Node ID
        status:
          type: string
          description: The status of the Location. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the Location Status
    business_units:
      type: object
      properties:
        business_units_name:
          type: string
          description: Aramark Business Unit Name
        business_units:
          type: string
          description: Aramark Business Unit Code
        business_units_id:
          type: number
          description: Business Unit Node ID
        status:
          type: string
          description: The status of the Business Unit. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the Business Unit Status
    regions:
      type: object
      properties:
        region_name:
          type: string
          description: Aramark Region Name
        region:
          type: string
          description: Aramark Region Code
        region_id:
          type: number
          description: Region Node ID
        status:
          type: string
          description: The status of the Region. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the Region Status
    profit_centers:
      type: object
      properties:
        profit_center_name:
          type: string
          description: Aramark Profit Center Name
        profit_center:
          type: string
          description: Aramark Profit Center Code
        profit_center_id:
          type: number
          description: Profit Center Node ID
        status:
          type: string
          description: The status of the Profit Center. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the Profit Center Status
    lines_of_business:
      type: object
      properties:
        line_of_business_name:
          type: string
          description: Aramark Line of Business Name
        line_of_business:
          type: string
          description: Aramark Line of Business Code
        line_of_business_id:
          type: number
          description: Line of Business Node ID
        status:
          type: string
          description: The status of the Line of Business. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the Line of Business Status
    financial_organizations:
      type: object
      properties:
        organization_count:
          type: string
          description: The count of the number of Organizations returned in the response
        sub_locations:
          type: array
          items:
            $ref: '#/components/schemas/sub_locations'
        locations:
          type: array
          items:
            $ref: '#/components/schemas/locations'
        profit_centers:
          type: array
          items:
            $ref: '#/components/schemas/profit_centers'
        districts:
          type: array
          items:
            $ref: '#/components/schemas/districts'
        regions:
          type: array
          items:
            $ref: '#/components/schemas/regions'
        lines_of_business:
          type: array
          items:
            $ref: '#/components/schemas/lines_of_business'
        business_units:
          type: array
          items:
            $ref: '#/components/schemas/business_units'
        divisions:
          type: array
          items:
            $ref: '#/components/schemas/divisions'
    sub_locations:
      type: object
      properties:
        sub_location_name:
          type: string
          description: Aramark Sub Location Name
        sub_location:
          type: string
          description: Aramark Sub Location Code
        sub_location_id:
          type: number
          description: Sub Location Node ID
        status:
          type: string
          description: The status of the Sub Location. A-Active, X-Inactive
        status_description:
          type: string
          description: Description of the Sub Location Status
    profit_center_financial_details:
      type: object
      properties:
        org_value:
          type: string
          description: Aramark Organization code
        org_name:
          type: string
          description: Name of the Aramark Organization
        status:
          type: string
          description: Indicator if the Profit Center is Active or not
        status_description:
          type: string
          description: Description of whether the Profit Center is Active or not
        country:
          type: string
          description: Country where the Profit Center operates
        public_name:
          type: string
          description: Public name of the Profit Center
        legacy_value:
          type: string
          description: Legacy CSP value of the Profit Center
        open_date:
          type: string
          description: Date on which the Profit Center opened
        on_site_date:
          type: string
          description: Date on which Aramark was on site for the Profit Center
        close_date:
          type: string
          description: Date on which the Profit Center closed
        last_day_of_operation_date:
          type: string
          description: Date on which Aramark ceased operations for the Profit Center
        line_of_service_code:
          type: string
          description: Code for the line of service of the Profit Center
        line_of_service:
          type: string
          description: Description of the line of service of the Profit Center
        default_service_type_code:
          type: string
          description: Code for default service type of the Profit Center
        default_service_type:
          type: string
          description: Description of the default service type of the Profit Center
        contract_type_code:
          type: string
          description: Code for the contract type of the Profit Center
        contract_type:
          type: string
          description: Description of the contract type of the Profit Center
        workstation_code:
          type: string
          description: Code for the Workstation assigned to the Profit Center
        workstation:
          type: string
          description: Description for the Workstation assigned to the Profit Center
        legal_entity_code:
          type: string
          description: Code of the Legal Entity assigned to the Profit Center
        legal_entity:
          type: string
          description: Description of the Legal Entity assigned to the Profit Center
        cbs_pc_type_code:
          type: string
          description: Code for the Profit Center Type assigned to the Profit Center
        cbs_pc_type:
          type: string
          description: Desciption for the Profit Center Type assigned to the Profit Center
        cbs_recycle_code:
          type: number
          description: Fiscal Month number for the Recycle Period assigned to the Profit Center
        cbs_recycle:
          type: string
          description: Fiscal Month name for the Recycle Period assigned to the Profit   Center
        segmentation_code:
          type: string
          description: Code for the Segmentation for the Profit Center
        segmentation:
          type: string
          description: Description of the Segmentation for the Profit Center
        sector_code:
          type: string
          description: Code for the Sector for the Profit Center
        sector:
          type: string
          description: Description of the Sector for the Profit Center
        contract_qualifier_code:
          type: string
          description: Code for contract qualifier for the Profit Center
        contract_qualifier:
          type: string
          description: Description of the contract qualifier for the Profit Center
        fc_interest_eligible_code:
          type: string
          description: Code for the Interest Eligible flag
        fc_interest_eligible:
          type: string
          description: Descirption for the Interest Elibile flag.  This marks whther the Profit Center participates in Finance charge billing
        fc_interest_rate:
          type: string
          description: Code for the Interest Rate
        fc_start_days:
          type: string
          description: The number of days added to an Accounts Receivable invoice date to produce the start date for Finance Charge calculations
        fc_collection_method_code:
          type: string
          description: Code for the Finance Charge Collection Method
        fc_collection_method:
          type: string
          description: Description of the method in which the Finance Charge is collected
        labor_type_code:
          type: string
          description: Code for the Labor Type at the Profit Center
        labor_type:
          type: string
          description: Description of the Labor Type used at the Profit Center
        sub_market_code:
          type: string
          description: Code for the sub market for the Profit Center
        sub_market:
          type: string
          description: Description of the sub market for the Profit Center
        sbc_cap_rate_flag:
          type: string
          description: Flag used to determine sbc cap rate status for the Profit Center
        sbc_cap_rate:
          type: string
          description: Description of the sbc cap rate for the Profit Center
        sbc_notify_client_flag:
          type: string
          description: Flag used to determine sbc notify client status for the Profit Center
        risk_cap_rate_flag:
          type: string
          description: Flag used to determine the risk cap rate status for the Profit Center
        risk_cap_rate:
          type: string
          description: Description of the risk cap rate for the Profit Center
        risk_notify_client_flag:
          type: string
          description: Flag used to determine the risk notify client status for the Profit Center
        market_segment:
          type: string
          description: Description of the market segment for the Profit Center
        incentive_part:
          type: string
          description: Description of the incentive part for the Profit Center
        regional_purchase_code:
          type: string
          description: Code for the regional purchase for the Profit Center
        regional_purchase:
          type: string
          description: Description of the regional purchase for the Profit Center
        risk_claims_flag:
          type: string
          description: Flag used to determine the risk claims status for the Profit Center
        chart:
          type: string
          description: Description of the chart for the Profit Center
        phone_business:
          type: string
          description: Business phone number for the Profit Center
        phone_fax:
          type: string
          description: Fax number for the Profit Center
        client_name:
          type: string
          description: Name of the client for the Profit Center
        client_temp:
          type: string
          description: Description of the temp status of the client for the Profit Center
        client_contact_first_name:
          type: string
          description: First name of the client contact for the Profit Center
        client_contact_last_name:
          type: string
          description: Last name of the client contact for the Profit Center
        client_contact_email_address:
          type: string
          description: Email address of the client contact for the Profit Center
        client_contact_phone_business:
          type: string
          description: Business phone number of the client contact for the Profit Center
        client_contact_fax:
          type: string
          description: Fax number of the client contact for the Profit Center
        client_contact_phone_cell:
          type: string
          description: Cell phone number of the client contact for the Profit Center
        industry_sector_code:
          type: string
          description: Code for the industry sector for the Profit Center
        industry_sector:
          type: string
          description: Description of the industry sector for Profit Center
        last_update_date:
          type: string
          description: Date on which the information was last updated
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: This HTTP Header variable will verify security
x-refined-from:
- aramark-organization-hierarchy-openapi.json
- aramark-organization-profit-center-core-details-openapi.json