Create payment format mappings
post
/fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings
Request
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.
-
Upsert-Mode:
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
-
CheckType: string
Title:
Check Type
Maximum Length:255
Check type used for the payment format mapping. -
ElectronicType: string
Title:
Electronic Type
Maximum Length:255
Electronic type used for the payment format mapping. -
fedPaymentFormatMappingDFF: array
fedPaymentFormatMappingDFF
-
FormatMappingId: integer
(int64)
Unique identifier for the payment format mapping.
-
PayGroup: string
Title:
Pay Group
Maximum Length:255
Pay group used for the payment format mapping. -
PaymentFormat(required): string
Title:
Payment Format Code
Maximum Length:30
Payment format used for the payment format mapping. -
PaymentType: string
Title:
Payment Type Code
Maximum Length:255
Payment type used for the payment format mapping. -
WireFormat: string
Title:
Wire
Maximum Length:255
Default Value:No
Wire format used for the payment format mapping.
Nested Schema : fedPaymentFormatMappings-fedPaymentFormatMappingDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FormatMappingId: integer
(int64)
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 : fedPaymentFormatMappings-item-response
Type:
Show Source
object
-
CheckType: string
Title:
Check Type
Maximum Length:255
Check type used for the payment format mapping. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
ElectronicType: string
Title:
Electronic Type
Maximum Length:255
Electronic type used for the payment format mapping. -
fedPaymentFormatMappingDFF: array
fedPaymentFormatMappingDFF
-
FormatMappingId: integer
(int64)
Unique identifier for the payment format mapping.
-
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayGroup: string
Title:
Pay Group
Maximum Length:255
Pay group used for the payment format mapping. -
PayGroupMeaning: string
Read Only:
true
Maximum Length:255
Pay group used for the payment format mapping. -
PaymentFormat: string
Title:
Payment Format Code
Maximum Length:30
Payment format used for the payment format mapping. -
PaymentType: string
Title:
Payment Type Code
Maximum Length:255
Payment type used for the payment format mapping. -
WireFormat: string
Title:
Wire
Maximum Length:255
Default Value:No
Wire format used for the payment format mapping.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedPaymentFormatMappings-fedPaymentFormatMappingDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FormatMappingId: integer
(int64)
-
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
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.
Links
- fedPaymentFormatMappingDFF
-
Parameters:
- FormatMappingId:
$request.path.FormatMappingId
- FormatMappingId:
Examples
The following example shows how to create a payment format mapping 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/fedPaymentFormatMappings
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "PaymentFormat": "PAM", "PayGroup": "Employee Miscelleneous PPD", "PaymentType": "Miscellaneous", "CheckType": null, "ElectronicType": "PPD", "WireFormat": "No" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "FormatMappingId": 300100211882108, "PaymentFormat": "PAM", "PayGroup": "Employee Miscelleneous PPD", "PaymentType": "Miscellaneous", "CheckType": null, "ElectronicType": "PPD", "WireFormat": "No", "PayGroupMeaning": null, "CreatedBy": "FEDERAL", "CreationDate": "2020-12-10T11:05:53+00:00", "LastUpdatedBy": "FEDERAL", "LastUpdateDate": "2020-12-10T11:05:53.347+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/300100211882108", "name": "fedPaymentFormatMappings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/300100211882108", "name": "fedPaymentFormatMappings", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/300100211882108/child/fedPaymentFormatMappingDFF", "name": "fedPaymentFormatMappingDFF", "kind": "collection" } ] }