Get all cash advance records
get
/fscmRestApi/resources/11.13.18.05/expenseCashAdvances
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
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).
-
fields: string
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 -
finder: string
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 cash advance record using a cash advance identifier that matches the primary key criteria specified.
Finder Variables:- CashAdvanceId; integer; Cash advance identifier of the cash advance record.
- PrimaryKey: Finds the cash advance record using a cash advance identifier that matches the primary key criteria specified.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- AdjustedAmount; number; Amount specified by an auditor during an audit.
- AdvanceStatus; string; Status of the cash advance. References lookup type EXM_CASH_ADVANCE_STATUS.
- Amount; number; Amount of a cash advance.
- AssignmentId; integer; Value that uniquely identifies the assignment of the person requesting a cash advance.
- BusinessUnit; string; Business unit associated with the cash advance.
- CashAdvanceId; integer; Value that uniquely identifies a cash advance.
- CashAdvanceNumber; string; Number used to identify a cash advance.
- CashAdvanceType; string; Type of cash advance. The default value for CashAdvanceType is TRAVEL. A list of accepted values is defined in the lookup type EXM_CASH_ADVANCE_TYPE.
- CreatedBy; string; User who created the row.
- CreationDate; string; Date and time when the row was created.
- Currency; string; Currency of the cash advance.
- CurrencyCode; string; Code that indicates the currency of the cash advance.
- Description; string; Description of the cash advance.
- EmployeeNumber; string; Employee number of the person requesting the cash advance.
- ExchangeRate; number; Exchange rate used for payment to employee.
- LastUpdateDate; string; Date and time when the row was last updated.
- LastUpdateLogin; string; Session login associated with the user who last updated the row.
- LastUpdatedBy; string; User who last updated the row.
- Location; string; Location of the upcoming trip.
- PaymentAmount; number; Cash advance amount paid to an employee.
- PaymentCurrency; string; Currency of the payment to the employee.
- PaymentCurrencyCode; string; Code that indicates the payment currency of a cash advance.
- PaymentMethodCode; string; Code that indicates the payment method of a cash advance.
- PersonId; integer; Value that uniquely identifies the person requesting the cash advance.
- PersonName; string; Name of the person requesting the cash advance.
- Purpose; string; Purpose of the cash advance.
- SequoiaAdvanceStatus; string; The status of the sequoia advance associated with the cash advance.
- SequoiaStatusCode; string; Code that indicates the sequoia status associated with the cash advance.
- SettlementDate; string; Date when the cash advance should be applied to an expense report.
- StatusCode; string; Code that indicates the status of the cash advance.
- SubmittedDate; string; Date when the cash advance was submitted.
- TripEndDate; string; Date when the trip ends for which a cash advance was requested.
- TripId; integer; Value that uniquely identifies a trip.
- TripStartDate; string; Date when the trip starts for which a cash advance was requested.
- UnappliedAmount; number; Outstanding cash advance balance that remains to be applied to expense reports.
-
totalResults: boolean
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
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
There's no request body for this operation.
Back to TopResponse
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 : expenseCashAdvances
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseCashAdvances-item-response
Type:
Show Source
object
-
AdjustedAmount: number
Amount specified by an auditor during an audit.
-
AdvanceStatus: string
Maximum Length:
255
Status of the cash advance. References lookup type EXM_CASH_ADVANCE_STATUS. -
Amount: number
Amount of a cash advance.
-
AssignmentId: integer
(int64)
Value that uniquely identifies the assignment of the person requesting a cash advance.
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BusinessUnit: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Business unit associated with the cash advance. -
CashAdvanceDff: array
Cash Advance Descriptive Flexfields
Title:
Cash Advance Descriptive Flexfields
The cash advance descriptive flexfield resource is used to manage details about the descriptive flexfield references for a cash advance. -
CashAdvanceId: integer
(int64)
Value that uniquely identifies a cash advance.
-
CashAdvanceNumber: string
Maximum Length:
60
Number used to identify a cash advance. -
CashAdvanceType: string
Maximum Length:
255
Type of cash advance. The default value for CashAdvanceType is TRAVEL. A list of accepted values is defined in the lookup type EXM_CASH_ADVANCE_TYPE. -
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. -
Currency: string
Title:
Currency Name
Read Only:true
Maximum Length:80
Currency of the cash advance. -
CurrencyCode: string
Maximum Length:
15
Code that indicates the currency of the cash advance. -
Description: string
Maximum Length:
240
Description of the cash advance. -
EmployeeNumber: string
Maximum Length:
255
Employee number of the person requesting the cash advance. -
ExchangeRate: number
Read Only:
true
Exchange rate used for payment to employee. -
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. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Location: string
Read Only:
true
Maximum Length:200
Location of the upcoming trip. -
PaymentAmount: number
Cash advance amount paid to an employee.
-
PaymentCurrency: string
Title:
Currency Name
Read Only:true
Maximum Length:80
Currency of the payment to the employee. -
PaymentCurrencyCode: string
Maximum Length:
15
Code that indicates the payment currency of a cash advance. -
PaymentMethodCode: string
Maximum Length:
120
Code that indicates the payment method of a cash advance. -
PersonId: integer
(int64)
Value that uniquely identifies the person requesting the cash advance.
-
PersonName: string
Maximum Length:
255
Name of the person requesting the cash advance. -
Purpose: string
Maximum Length:
240
Purpose of the cash advance. -
SequoiaAdvanceStatus: string
Read Only:
true
Maximum Length:255
The status of the sequoia advance associated with the cash advance. -
SequoiaStatusCode: string
Read Only:
true
Maximum Length:255
Code that indicates the sequoia status associated with the cash advance. -
SettlementDate: string
(date)
Date when the cash advance should be applied to an expense report.
-
StatusCode: string
Maximum Length:
30
Code that indicates the status of the cash advance. -
SubmittedDate: string
(date)
Date when the cash advance was submitted.
-
TripEndDate: string
(date)
Date when the trip ends for which a cash advance was requested.
-
TripId: integer
(int64)
Read Only:
true
Value that uniquely identifies a trip. -
TripStartDate: string
(date)
Date when the trip starts for which a cash advance was requested.
-
UnappliedAmount: number
Outstanding cash advance balance that remains to be applied to expense reports.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Cash Advance Descriptive Flexfields
Type:
array
Title:
Cash Advance Descriptive Flexfields
The cash advance descriptive flexfield resource is used to manage details about the descriptive flexfield references for a cash advance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : expenseCashAdvances-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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.
Nested Schema : expenseCashAdvances-CashAdvanceDff-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:240
Descriptive flexfield context name for a cash advance. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield number of segments for a cash advance. -
CashAdvanceId: integer
(int64)
Value that uniquely identifies a cash advance.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all the cash advance records 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/expenseCashAdvances
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "AdjustedAmount": null, "AdvanceStatus": "Partially applied", "Amount": 3000, "AssignmentId": 100010026335780, "BusinessUnit": "Vision Operations", "CashAdvanceId": 300100031453777, "CashAdvanceNumber": "ADVEXM0031453777", "CashAdvanceType": "Travel", "CreatedBy": "FINUSER1", "CreationDate": "2013-12-10T10:29:09+00:00", "Currency": "US Dollar", "CurrencyCode": "USD", "EmployeeNumber": "10026335772", "ExchangeRate": null, "LastUpdateDate": "2013-12-10T10:47:52+00:00", "LastUpdateLogin": "ED337C30CB947DFEE0432720F00A00F2", "LastUpdatedBy": "EXPENSE_AUDITOR_OPERATIONS", "Location": null, "PaymentAmount": 3000, "PaymentCurrency": "US Dollar", "PaymentCurrencyCode": "USD", "PaymentMethodCode": "CHECK", "PersonId": 100010026335772, "PersonName": "Mary Johnson", "Purpose": "Traveling to Nicaragua on business trip", "SettlementDate": "2013-12-11", "SubmittedDate": "2013-12-10", "TripEndDate": "2014-01-31", "TripId": null, "TripStartDate": "2014-01-02", "UnappliedAmount": 1091, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances/300100031453777", "name": "expenseCashAdvances", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances/300100031453777", "name": "expenseCashAdvances", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances/300100031453777/child/CashAdvanceDff", "name": "CashAdvanceDff", "kind": "collection" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances", "name": "expenseCashAdvances", "kind": "collection" } ] }