Update an expense itemization record for a specific expense identifier
patch
/fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseItemization/{ExpenseId}
Request
Path Parameters
-
ExpenseId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
ExpenseUniqID(required): string
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.
-
expenseReportsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Expense Reports resource and used to uniquely identify an instance of Expense Reports. The client should not generate the hash key value. Instead, the client should query on the Expense Reports collection resource in order to navigate to a specific instance of Expense Reports to get the hash key.
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Value that uniquely identifies the individual on the corporate card.
-
AuditAdjustmentReason: string
Title:
Additional Information
Maximum Length:240
Auditor's reason for adjusting the reimbursable amount to the individual. -
AuditAdjustmentReasonCode: string
Title:
Audit Issue
Maximum Length:30
Code that indicates the auditor's reason for adjusting the reimbursable amount to the individual. -
AwtGroupId: integer
(int64)
Value that uniquely identifies an alternate tax withholding group.
-
BilledAmount: number
Title:
Billed Amount
Amount billed to the corporate card account. -
BilledCurrencyCode: string
Code that indicates the amount billed to the corporate card account.
-
CardId: integer
(int64)
Value that uniquely identifies a specific corporate card.
-
CheckoutDate: string
(date)
Title:
Checkout Date
Date when a person departs a place associated with an accommodations expense category. -
CreditCardTrxnId: integer
(int64)
Value that uniquely identifies a specific corporate card transaction.
-
DailyAmount: number
Title:
Daily Amount
Amount of the daily expense receipt in the receipt currency. -
DailyDistance: number
Distance traveled in a day for business.
-
DailyLimit: object
Daily sum limit
Title:
Daily sum limit
Daily expense limit of a trip. -
DepartureLocationId: integer
(int64)
Title:
Departure City
Value that uniquely identifies the departure location. -
Description: string
Title:
Description
Maximum Length:240
Description of an expense item. -
DestinationFrom: string
Title:
Departure City
Maximum Length:4000
Starting or departure location of the trip. -
DestinationTo: string
Title:
Arrival City
Maximum Length:4000
Ending or arrival location of the trip. -
DistanceUnitCode: string
Maximum Length:
30
Code that indicates the travel distance unit. Possible values are KILOMETER and MILE. -
EndDate: string
Title:
End Date
Last day of an expense that spans multiple days. -
EndOdometer: number
Title:
Ending Odometer Reading
Odometer reading at the end of a trip. -
ExchangeRate: number
Title:
Conversion Rate
Rate that represents the amount one currency can be exchanged for another at a specific point in time. -
ExpenseCategoryCode: string
Title:
Expense Class
Maximum Length:30
Code that indicates the classification of an expense item. Possible values are BUSINESS and PERSONAL. -
ExpenseCreationMethodCode: string
Maximum Length:
30
Code that indicates the method of expense item creation. Possible values are MOBILE iOS DEVICE and MOBILE ANDROID DEVICE. -
ExpenseId: integer
(int64)
Value that uniquely identifies a specific expense item.
-
ExpenseReportId: integer
(int64)
Value that uniquely identifies a specific expense report.
-
ExpenseSource: string
Title:
Source
Maximum Length:30
Source of an expense item. Possible values are CASH and CORPORATE CARD. -
ExpenseTemplateId: integer
(int64)
Title:
Expense Template
Value that uniquely identifies a specific expense template. -
ExpenseType: string
Maximum Length:
80
Potential expense defined during setup and against which an expense item is incurred. -
ExpenseTypeId: integer
(int64)
Title:
Expense Type
Value that uniquely identifies a specific expense type. -
FlightClassLimit: string
Expense limit for a flight class.
-
FlightDuration: number
Title:
Flight Duration
Duration of an airline flight in hours. -
FlightNumber: string
Maximum Length:
80
Number of an airline flight. -
FuelType: string
Title:
Fuel Type
Maximum Length:30
Types of fuel for which a fuel charge is reimbursed. -
ImgReceiptRequiredFlag: boolean
Title:
Imaged Receipt Required
Maximum Length:1
Indicates whether an expense requires an imaged receipt. -
ItemizationParentExpenseId: integer
(int64)
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.
-
ItemizationReceiptBusinessTotalAmount: number
Expense receipt amount to be reimbursed by the employer.
-
ItemizationReceiptPersonalTotalAmount: number
Amount on the receipt that was incurred by the employee for personal use.
-
ItineraryReservationId: integer
(int64)
Value that uniquely identifies a travel reservation.
-
Justification: string
Title:
Justification
Maximum Length:240
Reason an expense was incurred. -
JustificationRequiredFlag: boolean
Maximum Length:
1
Indicates whether an expense requires justification. -
LicensePlateNumber: string
Title:
License Plate Number
Maximum Length:30
Number of the vehicle license plate. -
Location: string
Title:
Expense Location
Maximum Length:80
Location where the expense was incurred. -
LocationId: integer
(int64)
Value that uniquely identifies a specific expense location.
-
LongTermTripFlag: boolean
Maximum Length:
1
Indicates whether a trip is long-term. -
LongTermTripStartDate: string
(date)
Title:
Original Start Date of Long-Term Trip
Date when a long-term trip started. -
MerchantDocumentNumber: string
Title:
Receipt Number
Maximum Length:80
Number on the receipt issued by the merchant. -
MerchantName: string
Title:
Merchant Name
Maximum Length:80
Name of the merchant where the expense was incurred. -
MerchantReference: string
Title:
Merchant Reference
Maximum Length:240
Purchase identification of a transaction provided by the merchant at the point of sale. -
MerchantTaxpayerId: string
Title:
Taxpayer ID
Maximum Length:80
Value that uniquely identifies a merchant tax payer. -
MerchantTaxRegNumber: string
Title:
Tax Registration Number
Maximum Length:80
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. -
MileagePolicyId: integer
Value that uniquely identifies a mileage policy.
-
NumberOfAttendees: number
Title:
Number of Attendees
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. -
NumberOfDays: integer
Title:
Number of Days
Number of days the expense is incurred. -
NumberPeople: integer
Title:
Number of Passengers
Number of passengers in the vehicle. -
OrgId: integer
(int64)
Value that uniquely identifies the business unit associated with the row.
-
PassengerAmount: number
Total reimbursement for carrying passengers in the vehicle.
-
PassengerName: string
Title:
Passenger Name
Maximum Length:240
Name of airline flight passenger. -
PassengerRateType: string
Maximum Length:
30
Passenger rate type used for mileage reimbursement for an expense. -
PaymentDueFromCode: string
Code that indicates the liability owner of the transaction.
-
PersonalReceiptAmount: number
Title:
Personal Amount
Amount of the receipt that is marked as a personal expense. -
PersonId: integer
(int64)
Value that uniquely identifies the individual on the corporate card.
-
PolicyShortpayFlag: boolean
Title:
Short Pay
Maximum Length:1
Indicates whether the expense is short-paid due to policy noncompliance. -
PolicyViolatedFlag: boolean
Maximum Length:
1
Indicates whether the expense violates company policies. -
PolicyWarningFlag: boolean
Maximum Length:
1
Indicates whether the expense is marked with a warning. -
PolicyWarningReasonCode: string
Maximum Length:
30
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
(int64)
Value that uniquely identifies the person who created the expense report.
-
RatePerPassenger: number
Mileage rate per passenger for an expense.
-
ReceiptAmount: number
Title:
Amount
Amount of the receipt in the receipt currency. -
ReceiptCurrencyCode: string
Maximum Length:
15
Code that indicates the receipt currency of an expense item. -
ReceiptDate: string
(date)
Title:
Date
Date when a receipt is generated. -
ReceiptMissingDecRequiredFlag: boolean
Maximum Length:
1
Indicates whether an expense item with missing receipts requires submission of a missing receipts declaration. -
ReceiptMissingFlag: boolean
Title:
Receipt missing
Maximum Length:1
Indicates whether receipts are missing for an expense. -
ReceiptRequiredFlag: boolean
Title:
Original Receipt Required
Maximum Length:1
Indicates whether an expense requires a receipt. -
ReceiptVerifiedFlag: boolean
Title:
Receipt Verified
Maximum Length:1
Indicates whether an auditor verifies the receipt for an expense. -
ReimbursableAmount: number
Title:
Reimbursable Amount
Amount to be reimbursed to the individual in reimbursable currency for an expense. -
ReimbursementCurrencyCode: string
Maximum Length:
15
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.
-
StartDate: string
(date)
Title:
Date
Date when the expense occurred or the first day of an expense that spans multiple days. -
TaxClassificationCode: string
Maximum Length:
30
Code that indicates a tax classification that applies to an expense item. -
TicketClassCode: string
Title:
Flight Class
Maximum Length:30
Code that indicates the ticket class of a ship cabin or a flight. Possible values are BUSINESS and ECONOMY. -
TicketNumber: string
Title:
Ticket Number
Maximum Length:80
Number of the airline ticket. -
TravelMethodCode: string
Maximum Length:
30
Code that indicates the method of travel used during a trip. -
TravelType: string
Title:
Flight Type
Maximum Length:30
Type of flight. Possible values are DOMESTIC and INTERNATIONAL. -
TripDistance: number
Title:
Trip Distance
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.
-
ValidationErrorFlag: boolean
Indicates whether a validation error exists.
-
ValidationErrorMessages: string
Error messages populated during validation.
-
ValidationWarningMessages: string
Warning messages populated during validation.
-
VehicleCategoryCode: string
Title:
Vehicle Category
Maximum Length:30
Code that indicates the vehicle type category. Possible values are COMPANY, PRIVATE, and RENTAL. -
VehicleType: string
Title:
Vehicle Type
Maximum Length:30
Type of vehicle for which mileage reimbursement is permitted. Possible values are CAR, MOTORCYCLE, and VAN. -
ZoneCode: string
Title:
Zone
Maximum Length:30
Code that indicates the geographical area of the trip. -
ZoneTypeCode: string
Code that indicates the lookup type that defines the zones for which mileage rates are defined.
Nested Schema : Daily sum limit
Type:
object
Title:
Daily sum limit
Daily expense limit of a trip.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : expenseReports-Expense-ExpenseItemization-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Value that uniquely identifies the individual on the corporate card.
-
AuditAdjustmentReason: string
Title:
Additional Information
Maximum Length:240
Auditor's reason for adjusting the reimbursable amount to the individual. -
AuditAdjustmentReasonCode: string
Title:
Audit Issue
Maximum Length:30
Code that indicates the auditor's reason for adjusting the reimbursable amount to the individual. -
AwtGroupId: integer
(int64)
Value that uniquely identifies an alternate tax withholding group.
-
BilledAmount: number
Title:
Billed Amount
Amount billed to the corporate card account. -
BilledCurrencyCode: string
Code that indicates the amount billed to the corporate card account.
-
CardId: integer
(int64)
Value that uniquely identifies a specific corporate card.
-
CheckoutDate: string
(date)
Title:
Checkout Date
Date when a person departs a place associated with an accommodations expense category. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the row was created. -
CreditCardTrxnId: integer
(int64)
Value that uniquely identifies a specific corporate card transaction.
-
DailyAmount: number
Title:
Daily Amount
Amount of the daily expense receipt in the receipt currency. -
DailyDistance: number
Distance traveled in a day for business.
-
DailyLimit: object
Daily sum limit
Title:
Daily sum limit
Daily expense limit of a trip. -
DepartureLocationId: integer
(int64)
Title:
Departure City
Value that uniquely identifies the departure location. -
Description: string
Title:
Description
Maximum Length:240
Description of an expense item. -
DestinationFrom: string
Title:
Departure City
Maximum Length:4000
Starting or departure location of the trip. -
DestinationTo: string
Title:
Arrival City
Maximum Length:4000
Ending or arrival location of the trip. -
DistanceUnitCode: string
Maximum Length:
30
Code that indicates the travel distance unit. Possible values are KILOMETER and MILE. -
EndDate: string
Title:
End Date
Last day of an expense that spans multiple days. -
EndOdometer: number
Title:
Ending Odometer Reading
Odometer reading at the end of a trip. -
ExchangeRate: number
Title:
Conversion Rate
Rate that represents the amount one currency can be exchanged for another at a specific point in time. -
ExpenseCategoryCode: string
Title:
Expense Class
Maximum Length:30
Code that indicates the classification of an expense item. Possible values are BUSINESS and PERSONAL. -
ExpenseCreationMethodCode: string
Maximum Length:
30
Code that indicates the method of expense item creation. Possible values are MOBILE iOS DEVICE and MOBILE ANDROID DEVICE. -
ExpenseId: integer
(int64)
Value that uniquely identifies a specific expense item.
-
ExpenseReportId: integer
(int64)
Value that uniquely identifies a specific expense report.
-
ExpenseSource: string
Title:
Source
Maximum Length:30
Source of an expense item. Possible values are CASH and CORPORATE CARD. -
ExpenseTemplateId: integer
(int64)
Title:
Expense Template
Value that uniquely identifies a specific expense template. -
ExpenseType: string
Maximum Length:
80
Potential expense defined during setup and against which an expense item is incurred. -
ExpenseTypeId: integer
(int64)
Title:
Expense Type
Value that uniquely identifies a specific expense type. -
FlightClassLimit: string
Expense limit for a flight class.
-
FlightDuration: number
Title:
Flight Duration
Duration of an airline flight in hours. -
FlightNumber: string
Maximum Length:
80
Number of an airline flight. -
FuelType: string
Title:
Fuel Type
Maximum Length:30
Types of fuel for which a fuel charge is reimbursed. -
ImgReceiptRequiredFlag: boolean
Title:
Imaged Receipt Required
Maximum Length:1
Indicates whether an expense requires an imaged receipt. -
ItemizationParentExpenseId: integer
(int64)
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.
-
ItemizationReceiptBusinessTotalAmount: number
Expense receipt amount to be reimbursed by the employer.
-
ItemizationReceiptPersonalTotalAmount: number
Amount on the receipt that was incurred by the employee for personal use.
-
ItineraryReservationId: integer
(int64)
Value that uniquely identifies a travel reservation.
-
Justification: string
Title:
Justification
Maximum Length:240
Reason an expense was incurred. -
JustificationRequiredFlag: boolean
Maximum Length:
1
Indicates whether an expense requires justification. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the row. -
LicensePlateNumber: string
Title:
License Plate Number
Maximum Length:30
Number of the vehicle license plate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Title:
Expense Location
Maximum Length:80
Location where the expense was incurred. -
LocationId: integer
(int64)
Value that uniquely identifies a specific expense location.
-
LongTermTripFlag: boolean
Maximum Length:
1
Indicates whether a trip is long-term. -
LongTermTripStartDate: string
(date)
Title:
Original Start Date of Long-Term Trip
Date when a long-term trip started. -
MerchantDocumentNumber: string
Title:
Receipt Number
Maximum Length:80
Number on the receipt issued by the merchant. -
MerchantName: string
Title:
Merchant Name
Maximum Length:80
Name of the merchant where the expense was incurred. -
MerchantReference: string
Title:
Merchant Reference
Maximum Length:240
Purchase identification of a transaction provided by the merchant at the point of sale. -
MerchantTaxpayerId: string
Title:
Taxpayer ID
Maximum Length:80
Value that uniquely identifies a merchant tax payer. -
MerchantTaxRegNumber: string
Title:
Tax Registration Number
Maximum Length:80
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. -
MileagePolicyId: integer
Value that uniquely identifies a mileage policy.
-
NumberOfAttendees: number
Title:
Number of Attendees
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. -
NumberOfDays: integer
Title:
Number of Days
Number of days the expense is incurred. -
NumberPeople: integer
Title:
Number of Passengers
Number of passengers in the vehicle. -
OrgId: integer
(int64)
Value that uniquely identifies the business unit associated with the row.
-
PassengerAmount: number
Total reimbursement for carrying passengers in the vehicle.
-
PassengerName: string
Title:
Passenger Name
Maximum Length:240
Name of airline flight passenger. -
PassengerRateType: string
Maximum Length:
30
Passenger rate type used for mileage reimbursement for an expense. -
PaymentDueFromCode: string
Code that indicates the liability owner of the transaction.
-
PersonalReceiptAmount: number
Title:
Personal Amount
Amount of the receipt that is marked as a personal expense. -
PersonId: integer
(int64)
Value that uniquely identifies the individual on the corporate card.
-
PolicyShortpayFlag: boolean
Title:
Short Pay
Maximum Length:1
Indicates whether the expense is short-paid due to policy noncompliance. -
PolicyViolatedFlag: boolean
Maximum Length:
1
Indicates whether the expense violates company policies. -
PolicyWarningFlag: boolean
Maximum Length:
1
Indicates whether the expense is marked with a warning. -
PolicyWarningReasonCode: string
Maximum Length:
30
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
(int64)
Value that uniquely identifies the person who created the expense report.
-
RatePerPassenger: number
Mileage rate per passenger for an expense.
-
ReceiptAmount: number
Title:
Amount
Amount of the receipt in the receipt currency. -
ReceiptCurrencyCode: string
Maximum Length:
15
Code that indicates the receipt currency of an expense item. -
ReceiptDate: string
(date)
Title:
Date
Date when a receipt is generated. -
ReceiptMissingDecRequiredFlag: boolean
Maximum Length:
1
Indicates whether an expense item with missing receipts requires submission of a missing receipts declaration. -
ReceiptMissingFlag: boolean
Title:
Receipt missing
Maximum Length:1
Indicates whether receipts are missing for an expense. -
ReceiptRequiredFlag: boolean
Title:
Original Receipt Required
Maximum Length:1
Indicates whether an expense requires a receipt. -
ReceiptVerifiedFlag: boolean
Title:
Receipt Verified
Maximum Length:1
Indicates whether an auditor verifies the receipt for an expense. -
ReimbursableAmount: number
Title:
Reimbursable Amount
Amount to be reimbursed to the individual in reimbursable currency for an expense. -
ReimbursementCurrencyCode: string
Maximum Length:
15
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.
-
StartDate: string
(date)
Title:
Date
Date when the expense occurred or the first day of an expense that spans multiple days. -
TaxClassificationCode: string
Maximum Length:
30
Code that indicates a tax classification that applies to an expense item. -
TicketClassCode: string
Title:
Flight Class
Maximum Length:30
Code that indicates the ticket class of a ship cabin or a flight. Possible values are BUSINESS and ECONOMY. -
TicketNumber: string
Title:
Ticket Number
Maximum Length:80
Number of the airline ticket. -
TravelMethodCode: string
Maximum Length:
30
Code that indicates the method of travel used during a trip. -
TravelType: string
Title:
Flight Type
Maximum Length:30
Type of flight. Possible values are DOMESTIC and INTERNATIONAL. -
TripDistance: number
Title:
Trip Distance
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.
-
ValidationErrorFlag: boolean
Indicates whether a validation error exists.
-
ValidationErrorMessages: string
Error messages populated during validation.
-
ValidationWarningMessages: string
Warning messages populated during validation.
-
VehicleCategoryCode: string
Title:
Vehicle Category
Maximum Length:30
Code that indicates the vehicle type category. Possible values are COMPANY, PRIVATE, and RENTAL. -
VehicleType: string
Title:
Vehicle Type
Maximum Length:30
Type of vehicle for which mileage reimbursement is permitted. Possible values are CAR, MOTORCYCLE, and VAN. -
ZoneCode: string
Title:
Zone
Maximum Length:30
Code that indicates the geographical area of the trip. -
ZoneTypeCode: string
Code that indicates the lookup type that defines the zones for which mileage rates are defined.
Nested Schema : Daily sum limit
Type:
object
Title:
Daily sum limit
Daily expense limit of a trip.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.