Create a charge reference
/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargeReferences
Request
-
TradeOperationChargeId(required): integer(int64)
Value that uniquely identifies the trade operation charge.
-
TradeOperationId(required): integer(int64)
Value that uniquely identifies the trade operation.
-
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.
- application/json
object
-
AutoAssociateFlag: boolean
Title:
Automatically Associate on Match
Maximum Length:1
Default Value:false
Contains one of the following values: yes or no. If yes, then automatically associate invoice to trade operation charge on match. If no, then manual action is needed for invoice association to trade operation charge. The default value is no. -
ChargeReferenceName: string
Title:
Charge Reference Name
Name of the charge reference for a charge line. -
ChargeReferenceTypeId: integer
(int64)
Title:
Trade Operation Charge Reference Type ID
Value that uniquely identifies the type of charge reference. -
ReferenceValueDate: string
(date-time)
Title:
Date Reference
Date value of the charge reference attribute. -
ReferenceValueNumber: number
Title:
Numeric Reference
Numeric value of the charge reference attribute. -
ReferenceValueText: string
Title:
Alphanumeric Reference
Maximum Length:60
Alphanumeric value of the charge reference attribute. -
TradeOperationChargeId: integer
(int64)
Title:
Trade Operation Charge ID
Value that uniquely identifies the trade operation charge. -
TradeOperationChargeReferenceValueId: integer
(int64)
Title:
Trade Operation Charge Reference Value ID
Value that uniquely identifies the charge reference to a charge line.
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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.
object
-
AutoAssociateFlag: boolean
Title:
Automatically Associate on Match
Maximum Length:1
Default Value:false
Contains one of the following values: yes or no. If yes, then automatically associate invoice to trade operation charge on match. If no, then manual action is needed for invoice association to trade operation charge. The default value is no. -
ChargeReferenceName: string
Title:
Charge Reference Name
Name of the charge reference for a charge line. -
ChargeReferenceTypeDescription: string
Title:
Reference Type Description
Read Only:true
Maximum Length:240
Description of the charge reference for a charge line. -
ChargeReferenceTypeId: integer
(int64)
Title:
Trade Operation Charge Reference Type ID
Value that uniquely identifies the type of charge reference. -
ChargeReferenceValueDataType: string
Title:
Reference Data Type
Read Only:true
Maximum Length:80
Value that identifies the input data type for charge references. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PreDefinedFlag: boolean
Title:
Predefined
Read Only:true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then reference type was predefined in default charge references setup. If false, then reference type is not predefined. The default value is false. -
ReferenceValueDate: string
(date-time)
Title:
Date Reference
Date value of the charge reference attribute. -
ReferenceValueNumber: number
Title:
Numeric Reference
Numeric value of the charge reference attribute. -
ReferenceValueText: string
Title:
Alphanumeric Reference
Maximum Length:60
Alphanumeric value of the charge reference attribute. -
TradeOperationChargeId: integer
(int64)
Title:
Trade Operation Charge ID
Value that uniquely identifies the trade operation charge. -
TradeOperationChargeReferenceValueId: integer
(int64)
Title:
Trade Operation Charge Reference Value ID
Value that uniquely identifies the charge reference to a charge line.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create a charge reference.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/tradeOperations/TradeOperationId/child/charges/TradeOperationChargeId/child/chargeReferences"
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "ChargeReferenceName": "Shipment_Ref", "ReferenceValueNumber": "20" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [{ "ChargeReferenceTypeId": 300100071793243, "ChargeReferenceName": "Shipment_Ref", "ChargeReferenceTypeDescription": "Shipment_Ref", "ChargeReferenceValueDataType": "NUMERIC", "TropChargeReferenceValueId": 300100125839488, "ReferenceValueNumber": 20, "ReferenceValueDate": null, "ReferenceValueText": null, "AutoAssociateFlag": "N", "TradeOperationChargeId": 300100085591716, "PreDefinedFlag": "N", "links": [.....] }], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [....] }
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "parts":[ { "id": "part1", "path": "/tradeOperations/", "operation": "create", "payload": {"ChargeReferenceName": "Shipment_Ref", "ReferenceValueNumber": "20"}}, { "id": "part2", "path": "/tradeOperations/", "operation": "create", "payload": {"ChargeReferenceName": "Discount_Ref", "ReferenceValueNumber": "20%"}} ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [{ "ChargeReferenceTypeId": 300100071793243, "ChargeReferenceName": "Shipment_Ref", "ChargeReferenceTypeDescription": "Shipment_Ref", "ChargeReferenceValueDataType": "NUMERIC", "TropChargeReferenceValueId": 300100125839488, "ReferenceValueNumber": 20, "ReferenceValueDate": null, "ReferenceValueText": null, "AutoAssociateFlag": "N", "TradeOperationChargeId": 300100085591716, "PreDefinedFlag": "N", "links": [.....] }], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [....] }