Get all expense itemization records

get

/fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseItemization

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Expenses resource and used to uniquely identify an instance of Expenses. The client should not generate the hash key value. Instead, the client should query on the Expenses collection resource in order to navigate to a specific instance of Expenses to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds the expense descriptive flexfield record using an expense identifier that matches the primary key criteria specified.
      Finder Variables:
      • ExpenseId; integer; Expense identifier of the expense descriptive flexfield record.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AssignmentId; integer; Value that uniquely identifies the individual on the corporate card.
    • AuditAdjustmentReason; string; Auditor's reason for adjusting the reimbursable amount to the individual.
    • AuditAdjustmentReasonCode; string; Code that indicates the auditor's reason for adjusting the reimbursable amount to the individual.
    • AwtGroupId; integer; Value that uniquely identifies an alternate tax withholding group.
    • CardId; integer; Value that uniquely identifies a specific corporate card.
    • CheckoutDate; string; Date when a person departs a place associated with an accommodations expense category.
    • CreatedBy; string; User who created the row.
    • CreationDate; string; Date and time when the row was created.
    • CreditCardTrxnId; integer; Value that uniquely identifies a specific corporate card transaction.
    • DailyDistance; number; Distance traveled in a day for business.
    • DepartureLocationId; integer; Value that uniquely identifies the departure location.
    • Description; string; Description of an expense item.
    • DestinationFrom; string; Starting or departure location of the trip.
    • DestinationTo; string; Ending or arrival location of the trip.
    • DistanceUnitCode; string; Code that indicates the travel distance unit. Possible values are KILOMETER and MILE.
    • EndOdometer; number; Odometer reading at the end of a trip.
    • ExchangeRate; number; Rate that represents the amount one currency can be exchanged for another at a specific point in time.
    • ExpenseCategoryCode; string; Code that indicates the classification of an expense item. Possible values are BUSINESS and PERSONAL.
    • ExpenseCreationMethodCode; string; Code that indicates the method of expense item creation. Possible values are MOBILE iOS DEVICE and MOBILE ANDROID DEVICE.
    • ExpenseId; integer; Value that uniquely identifies a specific expense item.
    • ExpenseReportId; integer; Value that uniquely identifies a specific expense report.
    • ExpenseSource; string; Source of an expense item. Possible values are CASH and CORPORATE CARD.
    • ExpenseTemplateId; integer; Value that uniquely identifies a specific expense template.
    • ExpenseType; string; Potential expense defined during setup and against which an expense item is incurred.
    • ExpenseTypeId; integer; Value that uniquely identifies a specific expense type.
    • FlightDuration; number; Duration of an airline flight in hours.
    • FlightNumber; string; Number of an airline flight.
    • FuelType; string; Types of fuel for which a fuel charge is reimbursed.
    • ImgReceiptRequiredFlag; boolean; Indicates whether an expense requires an imaged receipt.
    • ItemizationParentExpenseId; integer; Value that uniquely identifies the parent expense of an itemized expense item. Possible values are NULL, which indicates that the expense is not itemized, -1 which indicates that the expense is a parent line with itemization, and greater than 0, which indicates that the expense is an itemized child line and the value is the parent line's identifier.
    • ItineraryReservationId; integer; Value that uniquely identifies a travel reservation.
    • Justification; string; Reason an expense was incurred.
    • JustificationRequiredFlag; boolean; Indicates whether an expense requires justification.
    • LastUpdateDate; string; Date when the row was last updated.
    • LastUpdatedBy; string; User who last updated the row.
    • LicensePlateNumber; string; Number of the vehicle license plate.
    • Location; string; Location where the expense was incurred.
    • LocationId; integer; Value that uniquely identifies a specific expense location.
    • LongTermTripFlag; boolean; Indicates whether a trip is long-term.
    • LongTermTripStartDate; string; Date when a long-term trip started.
    • MerchantDocumentNumber; string; Number on the receipt issued by the merchant.
    • MerchantName; string; Name of the merchant where the expense was incurred.
    • MerchantReference; string; Purchase identification of a transaction provided by the merchant at the point of sale.
    • MerchantTaxRegNumber; string; Unique sequence of letters or numbers assigned to a party or party site by a tax authority when it is registered and by which the party or party site registration is identified.
    • MerchantTaxpayerId; string; Value that uniquely identifies a merchant tax payer.
    • NumberOfAttendees; number; Number of people that attended an event for which expenses were incurred. For example, the number of people who attended a business dinner or an entertainment event.
    • NumberPeople; integer; Number of passengers in the vehicle.
    • OrgId; integer; Value that uniquely identifies the business unit associated with the row.
    • PassengerAmount; number; Total reimbursement for carrying passengers in the vehicle.
    • PassengerName; string; Name of airline flight passenger.
    • PassengerRateType; string; Passenger rate type used for mileage reimbursement for an expense.
    • PersonId; integer; Value that uniquely identifies the individual on the corporate card.
    • PersonalReceiptAmount; number; Amount of the receipt that is marked as a personal expense.
    • PolicyShortpayFlag; boolean; Indicates whether the expense is short-paid due to policy noncompliance.
    • PolicyViolatedFlag; boolean; Indicates whether the expense violates company policies.
    • PolicyWarningFlag; boolean; Indicates whether the expense is marked with a warning.
    • PolicyWarningReasonCode; string; Code that indicates the reason for a warning that an expense auditor applies to an expense item. A list of accepted values are defined in the lookup type ORA_EXM_WARNING_REASON.
    • PreparerId; integer; Value that uniquely identifies the person who created the expense report.
    • RatePerPassenger; number; Mileage rate per passenger for an expense.
    • ReceiptAmount; number; Amount of the receipt in the receipt currency.
    • ReceiptCurrencyCode; string; Code that indicates the receipt currency of an expense item.
    • ReceiptMissingDecRequiredFlag; boolean; Indicates whether an expense item with missing receipts requires submission of a missing receipts declaration.
    • ReceiptMissingFlag; boolean; Indicates whether receipts are missing for an expense.
    • ReceiptRequiredFlag; boolean; Indicates whether an expense requires a receipt.
    • ReceiptVerifiedFlag; boolean; Indicates whether an auditor verifies the receipt for an expense.
    • ReimbursableAmount; number; Amount to be reimbursed to the individual in reimbursable currency for an expense.
    • ReimbursementCurrencyCode; string; Code that indicates the currency of the amount to be reimbursed to the individual for expenses incurred.
    • SequenceNumber; number; Number associated with a sequence in which expense items are entered in an expense report.
    • TaxClassificationCode; string; Code that indicates a tax classification that applies to an expense item.
    • TicketClassCode; string; Code that indicates the ticket class of a ship cabin or a flight. Possible values are BUSINESS and ECONOMY.
    • TicketNumber; string; Number of the airline ticket.
    • TravelMethodCode; string; Code that indicates the method of travel used during a trip.
    • TravelType; string; Type of flight. Possible values are DOMESTIC and INTERNATIONAL.
    • TripDistance; number; Total distance traveled during a business trip for which mileage reimbursement is requested.
    • UOMDays; number; Calculation for the number of per diem expense days based on the unit of measure.
    • VehicleCategoryCode; string; Code that indicates the vehicle type category. Possible values are COMPANY, PRIVATE, and RENTAL.
    • VehicleType; string; Type of vehicle for which mileage reimbursement is permitted. Possible values are CAR, MOTORCYCLE, and VAN.
    • ZoneCode; string; Code that indicates the geographical area of the trip.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : expenses-ExpenseItemization
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : expenses-ExpenseItemization-item-response
Type: object
Show Source
Nested Schema : Daily sum limit
Type: object
Title: Daily sum limit
Daily expense limit of a trip.
Back to Top

Examples

The following example shows how to retrieve all the expense itemization records for an expense by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967/child/ExpenseItemization

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "AssignmentId": 100010026335780,
      "AuditAdjustmentReason": null,
      "AuditAdjustmentReasonCode": null,
      "AwtGroupId": null,
      "BilledAmount": null,
      "BilledCurrencyCode": null,
      "CardId": null,
      "CheckoutDate": null,
      "CreatedBy": "FINUSER1",
      "CreationDate": "2020-06-03T23:01:35.664+00:00",
      "CreditCardTrxnId": null,
      "DailyAmount": null,
      "DailyDistance": null,
      "DepartureLocationId": null,
      "Description": null,
      "DestinationFrom": null,
      "DestinationTo": null,
      "DistanceUnitCode": null,
      "EndDate": "2018-09-25",
      "EndOdometer": null,
      "ExchangeRate": 1,
      "ExpenseCategoryCode": "BUSINESS",
      "ExpenseCreationMethodCode": "WEB",
      "ExpenseId": 300100185230970,
      "ExpenseReportId": 300100185230944,
      "ExpenseSource": "CASH",
      "ExpenseTemplateId": 10024,
      "ExpenseTypeId": 100000010094094,
      "FlightClassLimit": null,
      "FlightDuration": null,
      "FlightNumber": null,
      "FuelType": null,
      "ImgReceiptRequiredFlag": true,
      "ItemizationParentExpenseId": 300100185230967,
      "ItemizationReceiptBusinessTotalAmount": 0,
      "ItemizationReceiptPersonalTotalAmount": 0,
      "ItineraryReservationId": null,
      "Justification": null,
      "JustificationRequiredFlag": false,
      "LastUpdateDate": "2020-06-03T23:02:36.468+00:00",
      "LastUpdatedBy": "FINUSER1",
      "LicensePlateNumber": null,
      "Location": "'S Graveland, Wijdemeren, NOORD HOLLAND, Netherlands",
      "LocationId": 999988034675746,
      "LongTermTripFlag": null,
      "LongTermTripStartDate": null,
      "MerchantDocumentNumber": null,
      "MerchantName": null,
      "MerchantReference": null,
      "MerchantTaxRegNumber": null,
      "MerchantTaxpayerId": null,
      "MileagePolicyId": null,
      "NumberOfAttendees": null,
      "NumberOfDays": null,
      "NumberPeople": null,
      "OrgId": 204,
      "PassengerAmount": null,
      "PassengerName": null,
      "PassengerRateType": null,
      "PaymentDueFromCode": null,
      "PersonId": 100010026335772,
      "PersonalReceiptAmount": 0,
      "PolicyShortpayFlag": null,
      "PolicyViolatedFlag": null,
      "PolicyWarningFlag": null,
      "PolicyWarningReasonCode": null,
      "PreparerId": null,
      "RatePerPassenger": null,
      "ReceiptAmount": 100,
      "ReceiptCurrencyCode": "USD",
      "ReceiptDate": "2018-09-25",
      "ReceiptMissingDecRequiredFlag": null,
      "ReceiptMissingFlag": null,
      "ReceiptRequiredFlag": true,
      "ReceiptVerifiedFlag": null,
      "ReimbursableAmount": 100,
      "ReimbursementCurrencyCode": "USD",
      "SequenceNumber": null,
      "StartDate": "2018-09-25",
      "TaxClassificationCode": null,
      "TicketClassCode": null,
      "TicketNumber": null,
      "TravelMethodCode": null,
      "TravelType": null,
      "TripDistance": 0,
      "UOMDays": null,
      "ValidationErrorFlag": null,
      "ValidationErrorMessages": null,
      "ValidationWarningMessages": null,
      "VehicleCategoryCode": null,
      "VehicleType": null,
      "ZoneCode": null,
      "ZoneTypeCode": null,
      "ExpenseType": "Room Charge",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967/child/ExpenseItemization/300100185230970",
          "name": "ExpenseItemization",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967/child/ExpenseItemization/300100185230970",
          "name": "ExpenseItemization",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967",
          "name": "Expense",
          "kind": "item"
        }
      ]
    },
    {
      "AssignmentId": 100010026335780,
      "AuditAdjustmentReason": null,
      "AuditAdjustmentReasonCode": null,
      "AwtGroupId": null,
      "BilledAmount": null,
      "BilledCurrencyCode": null,
      "CardId": null,
      "CheckoutDate": null,
      "CreatedBy": "FINUSER1",
      "CreationDate": "2020-06-03T23:02:14.066+00:00",
      "CreditCardTrxnId": null,
      "DailyAmount": null,
      "DailyDistance": null,
      "DepartureLocationId": null,
      "Description": null,
      "DestinationFrom": null,
      "DestinationTo": null,
      "DistanceUnitCode": null,
      "EndDate": "2018-09-25",
      "EndOdometer": null,
      "ExchangeRate": 1,
      "ExpenseCategoryCode": "BUSINESS",
      "ExpenseCreationMethodCode": "WEB",
      "ExpenseId": 300100185230975,
      "ExpenseReportId": 300100185230944,
      "ExpenseSource": "CASH",
      "ExpenseTemplateId": 10024,
      "ExpenseTypeId": 100000010094095,
      "FlightClassLimit": null,
      "FlightDuration": null,
      "FlightNumber": null,
      "FuelType": null,
      "ImgReceiptRequiredFlag": true,
      "ItemizationParentExpenseId": 300100185230967,
      "ItemizationReceiptBusinessTotalAmount": 0,
      "ItemizationReceiptPersonalTotalAmount": 0,
      "ItineraryReservationId": null,
      "Justification": null,
      "JustificationRequiredFlag": false,
      "LastUpdateDate": "2020-06-03T23:02:36.478+00:00",
      "LastUpdatedBy": "FINUSER1",
      "LicensePlateNumber": null,
      "Location": "'S Graveland, Wijdemeren, NOORD HOLLAND, Netherlands",
      "LocationId": 999988034675746,
      "LongTermTripFlag": null,
      "LongTermTripStartDate": null,
      "MerchantDocumentNumber": null,
      "MerchantName": null,
      "MerchantReference": null,
      "MerchantTaxRegNumber": null,
      "MerchantTaxpayerId": null,
      "MileagePolicyId": null,
      "NumberOfAttendees": null,
      "NumberOfDays": null,
      "NumberPeople": null,
      "OrgId": 204,
      "PassengerAmount": null,
      "PassengerName": null,
      "PassengerRateType": null,
      "PaymentDueFromCode": null,
      "PersonId": 100010026335772,
      "PersonalReceiptAmount": 0,
      "PolicyShortpayFlag": null,
      "PolicyViolatedFlag": null,
      "PolicyWarningFlag": null,
      "PolicyWarningReasonCode": null,
      "PreparerId": null,
      "RatePerPassenger": null,
      "ReceiptAmount": 20,
      "ReceiptCurrencyCode": "USD",
      "ReceiptDate": "2018-09-25",
      "ReceiptMissingDecRequiredFlag": null,
      "ReceiptMissingFlag": null,
      "ReceiptRequiredFlag": true,
      "ReceiptVerifiedFlag": null,
      "ReimbursableAmount": 20,
      "ReimbursementCurrencyCode": "USD",
      "SequenceNumber": null,
      "StartDate": "2018-09-25",
      "TaxClassificationCode": null,
      "TicketClassCode": null,
      "TicketNumber": null,
      "TravelMethodCode": null,
      "TravelType": null,
      "TripDistance": 0,
      "UOMDays": null,
      "ValidationErrorFlag": null,
      "ValidationErrorMessages": null,
      "ValidationWarningMessages": null,
      "VehicleCategoryCode": null,
      "VehicleType": null,
      "ZoneCode": null,
      "ZoneTypeCode": null,
      "ExpenseType": "Movie",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967/child/ExpenseItemization/300100185230975",
          "name": "ExpenseItemization",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967/child/ExpenseItemization/300100185230975",
          "name": "ExpenseItemization",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967",
          "name": "Expense",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenses/300100185230967/child/ExpenseItemization",
      "name": "ExpenseItemization",
      "kind": "collection"
    }
  ]
}
Back to Top