Create a cash advance record
post
/fscmRestApi/resources/11.13.18.05/expenseCashAdvances
Request
Header Parameters
-
Effective-Of: string
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: string
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: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AdjustedAmount: number
Amount specified by an auditor during an audit.
-
AdvanceStatus: string
Maximum Length:
255Status 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:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CashAdvanceDff: array
Cash Advance Descriptive Flexfields
Title:
Cash Advance Descriptive FlexfieldsThe 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(required): string
Maximum Length:
60Number used to identify a cash advance. -
CashAdvanceType: string
Maximum Length:
255Type 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. -
CurrencyCode: string
Maximum Length:
15Code that indicates the currency of the cash advance. -
Description: string
Maximum Length:
240Description of the cash advance. -
EmployeeNumber: string
Maximum Length:
255Employee number of the person requesting the cash advance. -
PaymentAmount: number
Cash advance amount paid to an employee.
-
PaymentCurrencyCode: string
Maximum Length:
15Code that indicates the payment currency of a cash advance. -
PaymentMethodCode: string
Maximum Length:
120Code 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:
255Name of the person requesting the cash advance. -
Purpose: string
Maximum Length:
240Purpose of the cash advance. -
SettlementDate: string
(date)
Date when the cash advance should be applied to an expense report.
-
StatusCode: string
Maximum Length:
30Code 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.
-
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:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Cash Advance Descriptive Flexfields
Type:
arrayTitle:
Cash Advance Descriptive FlexfieldsThe cash advance descriptive flexfield resource is used to manage details about the descriptive flexfield references for a cash advance.
Show Source
Nested Schema : expenseCashAdvances-Attachments-item-post-request
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : expenseCashAdvances-CashAdvanceDff-item-post-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:240Descriptive flexfield context name for a cash advance. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield number of segments for a cash advance. -
CashAdvanceId: integer
(int64)
Value that uniquely identifies a cash advance.
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 : expenseCashAdvances-item-response
Type:
Show Source
object-
AdjustedAmount: number
Amount specified by an auditor during an audit.
-
AdvanceStatus: string
Maximum Length:
255Status 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:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
BusinessUnit: string
Title:
Business UnitRead Only:trueMaximum Length:240Business unit associated with the cash advance. -
CashAdvanceDff: array
Cash Advance Descriptive Flexfields
Title:
Cash Advance Descriptive FlexfieldsThe 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:
60Number used to identify a cash advance. -
CashAdvanceType: string
Maximum Length:
255Type 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:
trueMaximum Length:64User who created the row. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the row was created. -
Currency: string
Title:
Currency NameRead Only:trueMaximum Length:80Currency of the cash advance. -
CurrencyCode: string
Maximum Length:
15Code that indicates the currency of the cash advance. -
Description: string
Maximum Length:
240Description of the cash advance. -
EmployeeNumber: string
Maximum Length:
255Employee number of the person requesting the cash advance. -
ExchangeRate: number
Read Only:
trueExchange rate used for payment to employee. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the row. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Session login associated with the user who last updated the row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Location: string
Read Only:
trueMaximum Length:200Location of the upcoming trip. -
PaymentAmount: number
Cash advance amount paid to an employee.
-
PaymentCurrency: string
Title:
Currency NameRead Only:trueMaximum Length:80Currency of the payment to the employee. -
PaymentCurrencyCode: string
Maximum Length:
15Code that indicates the payment currency of a cash advance. -
PaymentMethodCode: string
Maximum Length:
120Code 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:
255Name of the person requesting the cash advance. -
Purpose: string
Maximum Length:
240Purpose of the cash advance. -
SequoiaAdvanceStatus: string
Read Only:
trueMaximum Length:255The status of the sequoia advance associated with the cash advance. -
SequoiaStatusCode: string
Read Only:
trueMaximum Length:255Code 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:
30Code 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:
trueValue 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:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Cash Advance Descriptive Flexfields
Type:
arrayTitle:
Cash Advance Descriptive FlexfieldsThe 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:
arrayTitle:
LinksThe 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 IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 SegmentMaximum Length:240Descriptive flexfield context name for a cash advance. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield number of segments for a cash advance. -
CashAdvanceId: integer
(int64)
Value that uniquely identifies a cash advance.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/AttachmentsParameters:
- expenseCashAdvancesUniqID:
$request.path.expenseCashAdvancesUniqID
The attachments resource is used to view, create, and update attachments. - expenseCashAdvancesUniqID:
- CashAdvanceDff
-
Parameters:
- expenseCashAdvancesUniqID:
$request.path.expenseCashAdvancesUniqID
The cash advance descriptive flexfield resource is used to manage details about the descriptive flexfield references for a cash advance. - expenseCashAdvancesUniqID:
Examples
The following example shows how to create a cash advance record by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"AdvanceStatus": "Submitted",
"Amount": 3000,
"CashAdvanceType": "Travel",
"PersonName": "Mary Johnson",
"Purpose": "REST Testing",
"TripEndDate": "2020-07-20",
"TripStartDate": "2020-07-15"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"AdjustedAmount": null,
"AdvanceStatus": "Submitted",
"Amount": 3000,
"AssignmentId": 100010026335780,
"BusinessUnit": "Vision Operations",
"CashAdvanceId": 300100185923342,
"CashAdvanceNumber": "ADVEXM0185923342",
"CashAdvanceType": "Travel",
"CreatedBy": "FINUSER1",
"CreationDate": "2020-06-18T05:15:43+00:00",
"Currency": "US Dollar",
"CurrencyCode": "USD",
"EmployeeNumber": "10026335772",
"ExchangeRate": null,
"LastUpdateDate": "2020-06-18T05:15:45.433+00:00",
"LastUpdateLogin": "A84BE0FBEDC304BCE053D713F50A0BED",
"LastUpdatedBy": "FINUSER1",
"Location": null,
"PaymentAmount": null,
"PaymentCurrency": null,
"PaymentCurrencyCode": null,
"PaymentMethodCode": "CHECK",
"PersonId": 100010026335772,
"PersonName": "Mary Johnson",
"Purpose": "REST Testing",
"SettlementDate": null,
"SubmittedDate": "2020-06-18",
"TripEndDate": "2020-07-20",
"TripId": null,
"TripStartDate": "2020-07-15",
"UnappliedAmount": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances/300100185923342",
"name": "expenseCashAdvances",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances/300100185923342",
"name": "expenseCashAdvances",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseCashAdvances/300100185923342/child/CashAdvanceDff",
"name": "CashAdvanceDff",
"kind": "collection"
}
]
}