Emburse expense-controller-v3 API

openapi: 3.2.0
info:
  description: Api Documentation
  version: '1.0'
  title: Documentation Expense Controller V3 API
  termsOfService: urn:tos
  contact: {}
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://service.chromeriver.com
tags:
- name: expense-controller-v3
  description: Retrieve expense reports by filter(s)
paths:
  /v3/expense-reports:
    get:
      tags:
      - expense-controller-v3
      summary: Get list of reports by filter(s)
      description: This web service allows an external application to get a list of expense reports using different criteria
      operationId: getExpenseReportsUsingGET_1
      parameters:
      - name: approverEmailAddress
        in: query
        description: Unique email of the approver making a request
        required: false
        allowEmptyValue: false
        example: emailAddress@gmail.com
        schema:
          type: string
      - name: approverUniqueId
        in: query
        description: Unique ID of the approver making a request
        required: false
        allowEmptyValue: false
        example: personUniqueId
        schema:
          type: string
      - name: approverUserName
        in: query
        description: Unique user-name of the approver making a request
        required: false
        allowEmptyValue: false
        example: userName
        schema:
          type: string
      - name: chain-id
        in: header
        description: Used for tracking the flow of the request
        required: false
        schema:
          type: string
      - name: createDate
        in: query
        description: Filter by reports created this date (yyyy-MM-dd)
        required: false
        allowEmptyValue: false
        example: 2021-03-21
        schema:
          type: string
          format: date-time
      - name: createSource
        in: query
        description: How the report was created
        required: false
        allowEmptyValue: false
        example: AUTOMATIC
        schema:
          type: string
      - name: customer-code
        in: header
        description: Unique customer identifier provided by Chrome River
        required: true
        schema:
          type: string
      - name: exportDate
        in: query
        description: Filter by reports exported this date (yyyy-MM-dd)
        required: false
        allowEmptyValue: false
        example: 2021-03-21
        schema:
          type: string
          format: date-time
      - name: getPDFReport
        in: query
        description: Flag to indicate if PDF report should be included
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: getPDFReportWithNotes
        in: query
        description: Flag to indicate if PDF report with notes should be included
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: imageFirst
        in: query
        description: Flag to indicate if image should be retrieved first
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: includeCollections
        in: query
        description: List of collections to include in the report
        required: false
        allowEmptyValue: false
        explode: true
        schema:
          type: array
          items:
            type: string
          enum:
          - HEADER_COMPLIANCE_ITEMS
          - HEADER_IMAGES
          - LINE_ITEMS
          - HEADER_NOTES
          - HEADER_UDAS
          - LINE_ITEM_MATTERS
          - LINE_ITEM_COMPLIANCE_ITEMS
          - LINE_ITEM_IMAGES
          - LINE_ITEM_CHILDREN
          - LINE_ITEM_NOTES
          - LINE_ITEM_UDAS
          - LINE_ITEM_TRIPS
          - LINE_ITEM_STEPS
          - HEADER_PAYMENT_ACCOUNT
      - name: limit
        in: query
        description: Maximum number of results to return. If no value is passed, it will be taken from the configurable property file, where this value is equal to 10 by default
        required: false
        schema:
          type: ref
      - name: offset
        in: query
        description: The (zero-based) offset of the first item returned in the collection. If no value is passed, it will be taken from the configurable property file, where this value is equal to 10 by default. This value is limited to 100 to ensure reasonable use of system resources.
        required: false
        schema:
          type: ref
      - name: ownerCountryAlpha2
        in: query
        description: Reports owner countryAlpha2
        required: false
        allowEmptyValue: false
        example: US
        schema:
          type: string
      - name: ownerEmailAddress
        in: query
        description: Unique email of the expense owner making a request
        required: false
        allowEmptyValue: false
        example: emailAddress@gmail.com
        schema:
          type: string
      - name: ownerUniqueId
        in: query
        description: Unique ID of the expense owner making a request
        required: false
        allowEmptyValue: false
        example: personUniqueId
        schema:
          type: string
      - name: ownerUserName
        in: query
        description: Unique user-name of the expense owner making a request
        required: false
        allowEmptyValue: false
        example: userName
        schema:
          type: string
      - name: reportStatus
        in: query
        description: Filter by report status
        required: false
        allowEmptyValue: false
        example: Returned
        schema:
          type: string
          enum:
          - Draft
          - Pending Approval
          - Approved
          - Returned
          - Exported
          - Paid
          - Partially Paid
          - Deleted
      - name: submitDate
        in: query
        description: Filter by reports submitted this date (yyyy-MM-dd)
        required: false
        allowEmptyValue: false
        example: 2021-03-21
        schema:
          type: string
          format: date-time
      - name: voucherInvoice
        in: query
        description: Voucher Invoice parameter
        required: false
        allowEmptyValue: false
        schema:
          type: string
      - name: x-api-key
        in: header
        description: API key for Authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExpenseReportV3'
        '400':
          description: Customer Code is invalid.
        '401':
          description: Customer Code is not authorized. Cannot get list of expense reports.
        '403':
          description: Logged in user does not exist.
        '503':
          description: Service unavailable.
      deprecated: false
  /v3/expense-reports/{reportId}:
    get:
      tags:
      - expense-controller-v3
      summary: Get expense report details
      description: This web service allows an external application to get details of expense report by ReportID (including reports with deleted status)
      operationId: getExpenseReportUsingGET_3
      parameters:
      - name: chain-id
        in: header
        description: Used for tracking the flow of the request
        required: false
        schema:
          type: string
      - name: customer-code
        in: header
        description: Unique customer identifier provided by Chrome River
        required: true
        schema:
          type: string
      - name: getPDFReport
        in: query
        description: Flag to indicate if PDF report should be included
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: getPDFReportWithNotes
        in: query
        description: Flag to indicate if PDF report with notes should be included
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: imageFirst
        in: query
        description: Flag to indicate if image should be retrieved first
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: reportId
        in: path
        description: Identifier for the expense report.
        required: true
        schema:
          type: string
      - name: voucherInvoice
        in: query
        description: Voucher Invoice parameter
        required: false
        allowEmptyValue: false
        schema:
          type: string
      - name: x-api-key
        in: header
        description: 'API key for Authentication '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExpenseReportV3'
        '400':
          description: Customer Code is invalid.
        '401':
          description: Customer Code is not authorized. Cannot get details of expense report.
        '403':
          description: Logged in user does not exist.
        '404':
          description: Report with provided reportId does not exist.
        '503':
          description: Service unavailable.
      deprecated: false
  /v3/expense-reports/{reportId}/line-items:
    get:
      tags:
      - expense-controller-v3
      summary: Get expense report line item details
      description: This web service allows an external application to get line item details of expense report by ReportID
      operationId: getLineItemsUsingGET
      parameters:
      - name: chain-id
        in: header
        description: Used for tracking the flow of the request
        required: false
        schema:
          type: string
      - name: createDate
        in: query
        description: Filter by line item created this date (yyyy-MM-dd)
        required: false
        allowEmptyValue: false
        example: 2021-04-21
        schema:
          type: string
          format: date-time
      - name: customer-code
        in: header
        description: Unique customer identifier provided by Chrome River
        required: true
        schema:
          type: string
      - name: downloadImages
        in: query
        description: Flag to indicate if images should be downloaded
        required: false
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
      - name: exportDate
        in: query
        description: Filter by line item exported this date (yyyy-MM-dd)
        required: false
        allowEmptyValue: false
        example: 2021-04-21
        schema:
          type: string
          format: date-time
      - name: getMileageCoverPage
        in: query
        description: Voucher Invoice parameter
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: getPDFReport
        in: query
        description: Flag to indicate if PDF report should be included
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: getPDFReportWithNotes
        in: query
        description: Flag to indicate if PDF report with notes should be included
        required: false
        allowEmptyValue: false
        example: false
        schema:
          type: boolean
          default: false
      - name: imageFirst
        in: query
        description: Flag to indicate if image should be retrieved first
        required: false
        allowEmptyValue: false
        schema:
          type: boolean
          default: true
      - name: limit
        in: query
        description: Maximum number of results to return. If no value is passed, it will be taken from the configurable property file, where this value is equal to 10 by default
        required: false
        schema:
          type: ref
      - name: lineItemStatus
        in: query
        description: Filter by line item status
        required: false
        allowEmptyValue: false
        example: Returned
        schema:
          type: string
          enum:
          - Draft
          - Pending Approval
          - Approved
          - Returned
          - Exported
          - Paid
      - name: offset
        in: query
        description: The (zero-based) offset of the first item returned in the collection. If no value is passed, it will be taken from the configurable property file, where this value is equal to 10 by default. This value is limited to 100 to ensure reasonable use of system resources.
        required: false
        schema:
          type: ref
      - name: reportId
        in: path
        description: reportId
        required: true
        schema:
          type: string
      - name: submitDate
        in: query
        description: Filter by line item submitted this date (yyyy-MM-dd)
        required: false
        allowEmptyValue: false
        example: 2021-04-21
        schema:
          type: string
          format: date-time
      - name: x-api-key
        in: header
        description: 'API key for Authentication '
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExpenseReportLineItemV3'
        '400':
          description: Customer Code is invalid.
        '401':
          description: Customer Code is not authorized. Cannot get details of line items.
        '503':
          description: Service unavailable.
      deprecated: false
components:
  schemas:
    Comment:
      type: object
      properties:
        comment:
          type: string
          example: Submitted via Chrome River Application. Max 2000 characters
        createDate:
          type: string
          format: date-time
          example: 2023-01-09 10:57:53+00:00
          description: Date of comment creation.
        creatorName:
          type: string
          example: Jason Klein
          description: Name of comment author
      title: Comment
    CurrentApprover:
      type: object
      properties:
        assignedDate:
          type: string
          format: date-time
          description: Date line item was assigned to approver
        emailAddress:
          type: string
          example: larry.kemp@crane.com
          description: Email address of current approver. Max 100 characters
        firstName:
          type: string
          example: Larry
          description: First name of current approver. Max 50 characters
        lastName:
          type: string
          example: Kemp
          description: Last name of current approver. Max 50 characters
        personUniqueId:
          type: string
          example: lkemp
          description: Person unique ID of current approver. Max 100 characters
        title:
          type: string
          example: Sr. Manager
          description: Title of current approver. Max 255 characters
      title: CurrentApprover
    MapTripPoint:
      type: object
      properties:
        address:
          type: string
          example: 500 North Wilshire Blvd.
          description: Address. Max 400 characters
        amount:
          type: number
          example: 115.53
          description: Amount spent at trip point
        calculatedMiles:
          type: number
          format: double
          example: 15
          description: Calculated miles distance
        category:
          type: string
          example: Business- Travel
          description: Category of trip. Max 255 characters
        deductionAmount:
          type: number
          example: 15
          description: Deduction amount
        deductionDistance:
          type: number
          format: double
          example: 15
          description: Deduction distance
        distanceUnit:
          type: string
          example: miles
          description: Distance unit of trip calculation
        latitude:
          type: number
          format: double
          example: 30.29048912
          description: Latitude of trip point
        longitude:
          type: number
          format: double
          example: 93.2894802
          description: Longitude of trip point
        miles:
          type: number
          format: double
          example: 15
          description: Miles distance
        personalTrip:
          type: boolean
          example: false
          description: Indicates if this is a personal trip
        roundTrip:
          type: boolean
          example: false
          description: Indicates if this is a round trip
        tripStep:
          type: integer
          format: int32
          example: 1
          description: Which step in trip is this point
          minimum: -128
          maximum: 127
      title: MapTripPoint
    PreviousApprover:
      type: object
      properties:
        assignedDate:
          type: string
          format: date-time
          description: Date line item was assigned to approver
        completedDate:
          type: string
          format: date-time
          description: Date line item was reviewed by approver
        emailAddress:
          type: string
          example: larry.kemp@crane.com
          description: Email address of current approver. Max 100 characters
        firstName:
          type: string
          example: Larry
          description: First name of current approver. Max 50 characters
        lastName:
          type: string
          example: Kemp
          description: Last name of current approver. Max 50 characters
        personUniqueId:
          type: string
          example: lkemp
          description: Person unique ID of current approver. Max 100 characters
        statusApproved:
          type: string
          description: Action of approver at that step
          enum:
          - DRAFT
          - PENDING
          - APPROVED_FOR_PAYMENT
          - RETURNED
          - NO_ACTION
          - NO_ACTION_MOVED
          - NO_ACTION_VACATION
          - REASSIGNED
        stepNumber:
          type: integer
          format: int32
          description: Step number of approver in approval process
        title:
          type: string
          example: Sr. Manager
          description: Title of current approver. Max 255 characters
      title: PreviousApprover
    PaymentAccount:
      type: object
      properties:
        accountNumberLast4:
          type: string
          example: 9829
          description: Last 4 digits of payment account
        nickName:
          type: string
          example: John's AMEX
          description: Nickname for payment account
      title: PaymentAccount
    LineItemAllocation:
      type: object
      properties:
        allocationId:
          type: string
          example: 001109-600001_001109
          description: Allocation identifier. Max 255 characters
        allocationRefereceString:
          type: string
          example: 1000-7302-FirmPaid
          description: Concatenated string of all allocation reference values. Max 1650 characters
        allocationReference:
          $ref: '#/components/schemas/LineItemAllocationReference'
        amount:
          type: number
          example: 25
          description: Amount of total expense due to allocation
        amountSpentApproved:
          type: number
          example: 25
          description: Amount of total approved expense due to allocation
        clientName:
          type: string
          example: FIRM FUNCTIONS (CHICAGO)
          description: Allocation client name. Max 130 characters
        clientNumber:
          type: string
          example: 1000
          description: Allocation number. Max 150 characters
        costCodeOverride:
          type: string
          example: 617500
          description: Cost code override value. Max 50 characters
        description:
          type: string
          example: Athletics
          description: Description of allocation. Max 255 characters
        entityField1:
          type: string
          example: 801
          description: Entity field. Max 50 characters
        entityField2:
          type: string
          example: 700
          description: Entity field. Max 50 characters
        entityField3:
          type: string
          example: 9999
          description: Entity field. Max 50 characters
        glAccount:
          type: string
          example: 617500
          description: GL account. Max 50 characters
        isPersonal:
          type: boolean
          example: false
          description: Indicates whether this is a personal allocation
        matterOnSelect1:
          type: string
          description: Matter on select 1. Max 50 characters
        matterOnSelect2:
          type: string
          description: Matter on select 2. Max 50 characters
        number:
          type: string
          example: 001109-600001
          description: Allocation number. Max 150 characters
        percent:
          type: number
          example: 50
          description: Percent of total expense due to allocation
        type:
          type: string
          example: 1000
          description: Allocation type. Max 10 characters
        udf1:
          type: string
          example: General
          description: User defined field. Max 50 characters
        udf2:
          type: string
          example: PTBSM1
          description: User defined field. Max 50 characters
        udf3:
          type: string
          example: RCM2
          description: User defined field. Max 50 characters
        udf4:
          type: string
          description: User defined field. Max 50 characters
        vatAmount:
          type: number
          example: 4.33
          description: Amount of VAT tax
        vatAmount2:
          type: number
          example: 4.33
          description: Amount of VAT tax
        vatAmount3:
          type: number
          example: 4.33
          description: Amount of VAT tax
        vatTaxCode:
          type: string
          example: HST
          description: VAT tax code. Max 10 characters
        vatTaxCode2:
          type: string
          example: GST
          description: VAT tax code 2. Max 10 characters
        vatTaxCode3:
          type: string
          example: PST
          description: VAT tax code 3. Max 10 characters
        vatTaxPercentage:
          type: number
          example: 5
          description: Rate of VAT tax
        vatTaxPercentage2:
          type: number
          example: 5
          description: Rate of VAT tax
        vatTaxPercentage3:
          type: number
          example: 5
          description: Rate of VAT tax
      title: LineItemAllocation
    PaLineItemType:
      type: object
      properties:
        externalRef:
          type: string
          example: 4320
          description: Reference to an external system's expense types. Max 50 characters
        id:
          type: integer
          format: int32
          example: 1398
          description: Internal ID of preapproval line item
        name:
          type: string
          example: Airfare
          description: Expense type of preapproval line item. Max 50 characters
        type:
          type: string
          example: LineItem
          enum:
          - LineItem
          - Header
      title: PaLineItemType
    UserDefinedAttribute:
      type: object
      properties:
        booleanValue:
          type: boolean
          description: Populated if UDA is a boolean value
        currencyValue:
          type: number
          example: 100
          description: Populated if UDA is a monetary value
        dateValue:
          type: string
          format: date-time
          description: Populated if UDA is a date value
        entityValue:
          $ref: '#/components/schemas/Entity'
        entityValueInt:
          type: integer
          format: int32
          example: 90
          description: Populated if UDA is an entity. ID of entity
        numberValue:
          type: number
          example: 100
          description: Populated if UDA is a number value
        stringValue:
          type: string
          example: 1000 North Sunset Road
          description: Populated if UDA is a String value. Max 1000 characters
        udaDataType:
          type: string
          example: booleanValue
          description: DataType of UDA
          enum:
          - booleanValue
          - stringValue
          - numberValue
          - currencyValue
          - entityValue
          - dateValue
        udaName:
          type: string
          description: Name of user defined attribute. Max 60 characters
      title: UserDefinedAttribute
    Person:
      type: object
      properties:
        firstName:
          type: string
          example: Smith
          description: Person's last name. Max 100 characters
        lastName:
          type: string
          example: Jacob
          description: Person's first name. Max 100 characters
        personEntities:
          type: array
          description: List of person entities associated with person
          items:
            $ref: '#/components/schemas/PersonEntities'
        personUniqueId:
          type: string
          example: jsmith
          description: Unique identifier for person. Max 100 characters
        primaryEmailAddress:
          type: string
          example: jacob.smith@cpa.org
          description: Person's primary email address. Max 100 characters
        reportsToUniqueId:
          type: string
          example: lkemp
          description: Unique identifier for manager person reports to
        title:
          type: string
          example: Associate Accountant
          description: Person's title. Max 255 characters
        uniquePersonId:
          type: string
      title: Person
    ExpenseReportLineItemPersonGuest:
      type: object
      properties:
        amount:
          type: number
          example: 11.98
          description: Amount of expense spent by/for guest
        company:
          type: string
          example: CFA Consultants
          description: Company of guest. Max 100 characters
        firstName:
          type: string
          example: Jennifer
          description: First name of guest. Max 100 characters
        guestType:
          type: string
          example: InternalGuest
          description: Type of guest
          enum:
          - InternalGuest
          - ExternalGuest
          - HealthCareProvider
          - TemporaryHealthCareProvider
          - CRMGuest
        lastName:
          type: string
          example: Garth
          description: Last name of guest. Max 100 characters
        percentage:
          type: number
          example: 10
          description: Percentage of expense spent by/for guest
        title:
          type: string
          example: Legal Consultant
          description: Title of guest. Max 255 characters
      title: ExpenseReportLineItemPersonGuest
    ExpenseReportLineItem:
      type: object
      properties:
        allocations:
          type: array
          description: List of allocations selected for line item
          items:
            $ref: '#/components/schemas/LineItemAllocation'
        amount:
          type: number
          example: 119.81
          description: Amount of line item
        amountApproved:
          type: number
          example: 119.81
          description: Approved amount due to expense owner
        amountCustomer:
          type: number
          example: 0
          description: AmountSpent * customer's exchange rate
        amountSpent:
          type: number
          example: 119.81
          description: Amount spent of line item
        approvalStatus:
          type: string
          example: Pending Approval
          description: NULL for parent line items (parent == true)
          enum:
          - Draft
          - Pending Approval
          - Approved For Payment
          - Returned
          - Exported
          - Paid
          - Partially Paid
        businessPurpose:
          type: string
          example: Conference
          description: Business purpose of expense. Max 2500 characters
        children:
          type: array
          description: List of child expenses. Used for hotel items.
          items:
            $ref: '#/components/schemas/ExpenseReportLineItem'
        comments:
          type: array
          description: List of comments attached to line item
          items:
            $ref: '#/components/schemas/Comment'
        complianceItems:
          type: array
          description: List of compliance issues associated with the line item
          items:
            $ref: '#/components/schemas/ComplianceItem'
        createDate:
          type: string
          format: date-time
          example: 2022-01-03 05:53:39:000
          description: Date expense line item was created on report
        currencyCodeCustomer:
          type: string
          example: USD
          description: Customer's default ISO-4217 currency code
        currencySpent:
          type: string
          example: USD
          description: ' ISO-4217 Currency code spent'
        currentApprovers:
          type: array
          description: List of approvers where line item is currently pending
          items:
            $ref: '#/components/schemas/Person'
        description:
          type: string
          example: Flight to St. Louis
          description: Description of expense. Max 2500 characters
        expenseItemType:
          type: string
          example: Airfare
          description: Expense category of line item. Max 50 characters
        exportStatus:
          type: string
          example: Exported
          description: Export status of line item
          enum:
          - In Export
          - Waiting for Export
          - Exported
          - Paid
          - Partially Paid
        feedCode:
          type: string
          example: CreditCardAmex
          description: Name of feed for expense transaction
        feedName:
          type: string
          example: Amex Corporate Card
          description: Name of feed for expense transaction
        firmPaid:
          type: boolean
        guests:
          type: array
          description: List of guests for line item
          items:
            $ref: '#/components/schemas/ExpenseReportLineItemPersonGuest'
        hasReceipt:
          type: boolean
          example: true
          description: Is a receipt attached
        hasTaxReceipt:
          type: boolean
          example: true
          description: Is a tax receipt attached
        id:
          type: string
          example: b0dd069a-ce1a-45bf-b9dd-48cac24735ff
          description: Internal ID of expense report line item. 36 characters
        images:
          type: array
          description: Filenames of images attached to this line item
          items:
            type: string
        isCreditCard:
          type: boolean
          example: true
          description: Returns true if feed of expense transaction is a credit card feed
        paLineItemType:
          $ref: '#/components/schemas/PaLineItemType'
        parent:
          type: boolean
        perDiemLineItem:
          $ref: '#/components/schemas/PerDiemLineItem'
        personal:
          type: boolean
        transactionDate:
          type: string
          format: date-time
          example: 2022-01-03 05:53:39:000
          description: Date of transaction
        udas:
          type: array
          description: List of line item user defined attributes.
          items:
            $ref: '#/comp

# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/emburse/refs/heads/main/openapi/emburse-expense-controller-v3-api-openapi.yml