Create a receipt method assignment at customer account or site
post
/fscmRestApi/resources/11.13.18.05/receiptMethodAssignments
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
-
CustomerAccountNumber: string
Title:
Account Number
Maximum Length:30
The account number of the customer. -
CustomerReceiptMethodId: integer
(int64)
Title:
Customer Receipt Method ID
The unique identifier of the customer receipt method. -
CustomerSiteNumber: string
Title:
Site Number
Maximum Length:30
The site number of the customer account. -
EndDate: string
(date)
Title:
End Date
The date when the receipt method is no longer active. -
Primary: string
Title:
Primary
Maximum Length:30
Indicates whether the receipt method is the primary receipt method for the customer. -
ReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The name of the receipt method. -
StartDate: string
(date)
Title:
Start Date
The date when the receipt method becomes active.
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 : receiptMethodAssignments-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
CustomerAccountNumber: string
Title:
Account Number
Maximum Length:30
The account number of the customer. -
CustomerReceiptMethodId: integer
(int64)
Title:
Customer Receipt Method ID
The unique identifier of the customer receipt method. -
CustomerSiteNumber: string
Title:
Site Number
Maximum Length:30
The site number of the customer account. -
EndDate: string
(date)
Title:
End Date
The date when the receipt method is no longer active. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Primary: string
Title:
Primary
Maximum Length:30
Indicates whether the receipt method is the primary receipt method for the customer. -
ReceiptMethodName: string
Title:
Receipt Method
Maximum Length:30
The name of the receipt method. -
StartDate: string
(date)
Title:
Start Date
The date when the receipt method becomes active.
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.
Examples
The following example shows how to create a receipt method assignment at customer account or site, 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/receiptMethodAssignments
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "CustomerAccountNumber" : "CDRM_3195", "CustomerSiteNumber" : "CDRM_27422", "ReceiptMethodName" : "Check", "Primary" : "No", "StartDate" : "2018-09-28", "EndDate" : "2030-09-28" }
Example of Response Body
The following example shows the contents of the response body in JSON format:
{ "CustomerReceiptMethodId": 300100169169066, "CustomerAccountNumber": "CDRM_3195", "CustomerSiteNumber": "CDRM_27422", "ReceiptMethodName": "Check", "Primary": "No", "StartDate": "2018-09-28", "EndDate": "2030-09-28", "CreatedBy": "AR_MGR_OPERATIONS", "CreationDate": "2018-11-23T09:34:57.031+00:00", "LastUpdateDate": "2018-11-23T09:34:57.830+00:00", "LastUpdatedBy": "AR_MGR_OPERATIONS", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receiptMethodAssignments/300100169169066", "name": "receiptMethodAssignments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/receiptMethodAssignments/300100169169066", "name": "receiptMethodAssignments", "kind": "item" } ] }