Emburse expense-report-line-item-controller API

openapi: 3.0.0
info:
  description: Api Documentation
  version: '1.0'
  title: Api Documentation Accounts expense-report-line-item-controller 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-report-line-item-controller
  description: Retrieve expense report line items
paths:
  /v1/expense-report-line-item-search:
    get:
      tags:
      - expense-report-line-item-controller
      summary: getLineItems
      operationId: getLineItemsUsingGET_1
      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: expenseReportHeaderIds
        in: query
        description: Filter to only include line items that belong to a list of comma-separated list of expense report header IDs
        required: false
        allowEmptyValue: false
        explode: true
        schema:
          type: array
          items:
            type: string
      - 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: hasComplianceItems
        in: query
        description: Filter by whether a line item has compliance items
        required: false
        allowEmptyValue: false
        schema:
          type: boolean
          enum:
          - 'true'
          - 'false'
      - name: includeMergedTransactions
        in: query
        description: Return child transactions in the expenseTransaction data (for merge sets)
        required: false
        allowEmptyValue: false
        schema:
          type: boolean
          enum:
          - 'true'
          - 'false'
      - name: isCreatedByAces
        in: query
        description: Filter by whether a line item was created by the ACES (Accelerated Expense Service)
        required: false
        allowEmptyValue: false
        schema:
          type: boolean
          enum:
          - 'true'
          - 'false'
      - 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: reportId
        in: query
        description: Filter by line item's header report ID
        required: false
        allowEmptyValue: false
        example: DEV028700864
        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
      responses:
        '200':
          description: OK
          content:
            application/json;charset=UTF-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ExpenseReportLineItemV3'
      deprecated: false
components:
  schemas:
    FeedDetail:
      type: object
      properties:
        code:
          type: string
          example: CreditCardAmex
          description: Feed code. Max 21 characters
        financialInstitution:
          type: string
          example: Amex
          description: Financial institution for the feed. Max 20 characters
        isCreditCard:
          type: boolean
          example: true
          description: True if this is a credit card feed
        name:
          type: string
          example: Amex Credit Card Feed
          description: Feed name. Max 50 characters
        typeName:
          type: string
          example: Credit Card
          description: Feed type name. Max 20 characters
      title: FeedDetail
    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
    Entity:
      type: object
      properties:
        code:
          type: string
          example: 100
          description: Entity code. Max 50 characters
        extraData1:
          type: string
          example: Main
          description: Extra data field. Max 1000 characters
        extraData2:
          type: string
          example: Office
          description: Extra data field. Max 1000 characters
        extraData3:
          type: string
          example: 1000
          description: Extra data field. Max 1000 characters
        extraData4:
          type: string
          example: 900
          description: Extra data field. Max 1000 characters
        extraData5:
          type: string
          example: '0000'
          description: Extra data field. Max 1000 characters
        name:
          type: string
          example: Los Angeles
          description: Name of entity. Max 100 characters
      title: Entity
    LineItemAllocationReference:
      type: object
      properties:
        allocationSeg1:
          type: string
          description: Allocation reference segment 1. Max 100 characters
        allocationSeg10:
          type: string
          description: Allocation reference segment 10. Max 100 characters
        allocationSeg11:
          type: string
          description: Allocation reference segment 11. Max 100 characters
        allocationSeg12:
          type: string
          description: Allocation reference segment 12. Max 100 characters
        allocationSeg13:
          type: string
          description: Allocation reference segment 13. Max 100 characters
        allocationSeg14:
          type: string
          description: Allocation reference segment 14. Max 100 characters
        allocationSeg15:
          type: string
          description: Allocation reference segment 15. Max 100 characters
        allocationSeg16:
          type: string
          description: Allocation reference segment 16. Max 100 characters
        allocationSeg2:
          type: string
          description: Allocation reference segment 2. Max 100 characters
        allocationSeg3:
          type: string
          description: Allocation reference segment 3. Max 100 characters
        allocationSeg4:
          type: string
          description: Allocation reference segment 4. Max 100 characters
        allocationSeg5:
          type: string
          description: Allocation reference segment 5. Max 100 characters
        allocationSeg6:
          type: string
          description: Allocation reference segment 6. Max 100 characters
        allocationSeg7:
          type: string
          description: Allocation reference segment 7. Max 100 characters
        allocationSeg8:
          type: string
          description: Allocation reference segment 8. Max 100 characters
        allocationSeg9:
          type: string
          description: Allocation reference segment 9. Max 100 characters
      title: LineItemAllocationReference
    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
    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
    ComplianceItem:
      type: object
      properties:
        description:
          type: string
          example: Receipt must be attached > 10.00 USD
          description: Description of compliance issue
        messageCode:
          type: string
          example: 422
          description: Compliance code that was issued. Max 10 characters
        response:
          type: string
          example: Lost the receipt
          description: Expense owner's response to compliance issue. Max 255 characters
        status:
          type: string
          example: Validated
          description: Compliance status
          enum:
          - New
          - Violation
          - Warning
          - Validated
          - NonValidated
        type:
          type: integer
          format: int32
          example: 0
          enum:
          - 0
          - 1
      title: ComplianceItem
    PerDiemLineItem:
      type: object
      properties:
        additionalDeductionAmount:
          type: number
          example: 0
          description: Any additional amounts that need to be deducted not covered by the itemized line items
        address:
          type: string
          example: 5700 Olympic Blvd
          description: Address for expense. Max 400 characters
        allowableAmount:
          type: number
        alocholAmount:
          type: number
        amountPerDiem:
          type: number
          example: 150
          description: Amount of per diem expense
        baseRate:
          type: number
        breakfastAmountIMR:
          type: number
          example: 11
          description: Individual meal rate- breakfast
        breakfastDeductionAmount:
          type: number
          example: 0
          description: Amount of breakfast deduction
        city:
          type: string
          example: Los Angeles
          description: City of expense. Max 100 characters
        country:
          type: string
          example: United States
          description: Country of expense. Max 50 characters
        county:
          type: string
          example: Los Angeles County
          description: County of expense. Max 100 characters
        currencyCode:
          type: string
          example: USD
          description: Currency code of per diem line item. ISO-4217
        dinnerAmountIMR:
          type: number
          example: 22
          description: Individual meal rate- dinner
        dinnerDeductionAmount:
          type: number
          example: 0
          description: Amount of dinner deduction
        endDate:
          type: string
          format: date-time
          description: End date of per diem expense
        foodAmount:
          type: number
        foodOverage:
          type: number
        incidentalDeductionAmount:
          type: number
          example: 0
          description: The dollar amount of any incidental per diem allowance
        isArriveNextDay:
          type: boolean
          example: false
          description: Indicates whether traveller will arrive the following day
        isArrivePreviousDay:
          type: boolean
          example: false
          description: Indicates if person arrived previous day
        isBreakfastDeducted:
          type: boolean
          example: false
          description: Indicates if breakfast deduction is taken
        isDinnerDeducted:
          type: boolean
          example: false
          description: Indicates if dinner deduction is taken
        isDiscardedDay:
          type: boolean
        isFullTravelDay:
          type: boolean
          example: false
          description: Indicates whether travel is full day
        isLodgingDeducted:
          type: boolean
          example: false
          description: Indicates if lodging is deducted
        isLunchDeducted:
          type: boolean
          example: false
          description: Indicates if lunch deduction is taken
        isOvernightStay:
          type: boolean
          example: false
          description: Indicates if trip had an overnight stay
        isTravelDayDeducted:
          type: boolean
          description: If the travel day deduction is taken, this field will be true
        latitude:
          type: number
          format: double
          example: 193.29283
          description: Latitude of start position
        lodgingDeductionAmount:
          type: number
          example: 0
          description: Amount of lodging deduction
        longitude:
          type: number
          format: double
          example: 30.5445022
          description: Longitude of start position
        lunchAmountIMR:
          type: number
          example: 23
          description: Individual meal rate- lunch
        lunchDeductionAmount:
          type: number
          example: 0
          description: Amount of lunch deduction
        mealType:
          type: string
          example: Dinner
          description: Meal type for meal expense. Max 15 characters
        numberOfAttendees:
          type: integer
          format: int32
          example: Dinner
          description: Meal type for meal expense. Max 15 characters
        otherCity:
          type: string
          example: San Diego
          description: Another city where travel took place if trip spans >1 city. Max 50 characters
        perDiemDayPosition:
          type: string
          example: SNGL
          description: Position of day in trip
          enum:
          - FRST
          - LAST
          - NORM
          - SNGL
        rate:
          $ref: '#/components/schemas/PerDiemRate'
        rooms:
          type: integer
          format: int32
          example: 1
          description: Number of rooms for lodging expense
        startDate:
          type: string
          format: date-time
          description: Start date of per diem expense
        state:
          type: string
          example: CA
          description: State of expense. Max 50 characters
        taxTip:
          type: number
        totalAlcoholAmount:
          type: number
        totalFoodAmount:
          type: number
      title: PerDiemLineItem
    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
    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
    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
    Mileage:
      type: object
      properties:
        carPlanModifierGroup:
          type: string
          example: Passengers_CA
          description: Car plan modifier group. Max 20 characters
        carPlanName:
          type: string
          example: US Personal Car
          description: Name of car plan. Max 50 characters
        carPlanTierName:
          type: string
          example: < 1000 KM
          description: Name of car plan tier. Max 50 characters
        mapImageURL:
          type: string
        rate:
          type: number
          example: 50
          description: Rate of mileage
        trips:
          type: array
          description: List of trip points
          items:
            $ref: '#/components/schemas/MapTripPoint'
      title: Mileage
    ExpenseTransaction:
      type: object
      properties:
        amountEditable:
          type: boolean
          example: false
          description: Property to signal if the amount spent on the transaction is updatable
        amountOriginal:
          type: number
          example: 100
          description: Converted amount spent for expense transaction in original currency
        amountSpent:
          type: number
          example: 100
          description: Amount spent for expense transaction
        childrenMergedTransactions:
          type: array
          description: Any mergeset children attached to this expense transaction
          items:
            $ref: '#/components/schemas/ExpenseTransaction'
        createDate:
          type: string
          format: date-time
          example: 2023-11-30 05:23:39:000
          description: Date of expense transaction created
        currencyCodeOriginal:
          type: string
          example: USD
          description: Currency code of original currency (ISO-4217)
        currencyCodeSpent:
          type: string
          example: USD
          description: Currency spent (ISO-4217)
        currencyEditable:
          type: boolean
          example: false
          description: Property to signal if the currency code on the transaction is updatable
        dateEditable:
          type: boolean
          example: false
          description: Property to signal if the transaction date on the transaction is updatable
        expenseTypePredictions:
          type: array
          description: Value of ExpenseTypePredictions for each transaction
          items:
            $ref: '#/components/schemas/ExpenseTypePrediction'
        feedTransactionUniqueID:
          type: string
          example: 5q6CFwAKlPRZoQT0PbbD-39454187904441-1
          description: Unique identifier for expense transaction. Max 360 characters
        merchant:
          type: string
          example: Amazon.com Services LLC
          description: Name of merchant of transaction. Max 255 characters
        merchantUda:
          type: string
          example: Amazon.com Services LLC
          description: Name of merchant of transaction. Max 255 characters
        numImages:
          type: integer
          format: int32
          example: 1
          description: The number of images attached to the expense
        primaryTransactionDate:
          type: string
          format: date-time
          description: Date of expense transaction
        transactionId:
          type: integer
          format: int32
          description: Unique identifier for expense transaction
      title: ExpenseTransaction
    ExpenseReportLineItemV3:
      type: object
      properties:
        allocations:
          type: array
          description: List of allocations selected for line item
          items:
            $ref: '#/components/schemas/LineItemAllocation'
        amountApproved:
          type: number
          example: 0
          description: Amount approved 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
        amountSpentConverted:
          type: number
          example: 119.81
          description: Amount spent of line item converted to customer currency code
        amountSpentPersonal:
          type: number
          example: 0
          description: Amount of line item due to personal expenses
        businessPurpose:
          type: string
          example: Conference
          description: Business purpose of expense. Max 2500 characters
        childLineItemIds:
          type: array
          description: List of line item IDs for child expenses. Used for hotel items.
          items:
            type: string
        children:
          type: array
          description: List of child expenses. Used for hotel items.
          items:
            $ref: '#/components/schemas/ExpenseReportLineItemV3'
        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
        currencyCustomer:
          type: string
          example: USD
          description: Customer's default ISO-4217 currency code
        currencySpent:
          type: string
          example: USD
          description: ' ISO-4217 Currency code spent'
        currencySpentApproved:
          type: string
          example: USD
          description: Currency code approved
        currencySpentConverted:
          type: string
        currencySpentPersonal:
          type: string
          example: USD
          description: Currency of personal expenses (ISO-4217)
        currentApprover:
          type: array
          description: List of current approvers where line item is pending
          items:
            $ref: '#/components/schemas/CurrentApprover'
        description:
          type: string
          example: Flight to St. Louis
          description: Description of expense. Max 2500 characters
        expenseItemType:
          type: string
          example: Breakfast
          description: Expense category of line item. Max 50 characters
        expenseItemTypeDisplayName:
          type: string
          example: Meal - Breakfast
          description: Display name of expense category of line item. Max 50 characters
        expenseItemTypeIcon:
          type: string
          example: coffee.png
          description: File name of icon that represents the item type of this line item
        expenseTransactions:
          $ref: '#/components/schemas/ExpenseTran

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