Jump to

• Request
• Response
• Examples

Create a charge related line

post

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargeRelatedLines

Request

Path Parameters

• TradeOperationChargeId(required): integer(int64)
  Value that uniquely identifies the trade operation charge.
• TradeOperationId(required): integer(int64)
  Value that uniquely identifies the trade operation.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChargeLineNumber: integer
  Title: Related Charge Line Number

  Value that uniquely identifies the charge line number for the charge entered as related in a charge line.
• IncludePurchaseValueFlag: boolean
  Title: Include item value

  Contains one of the following values: true or false. If true, then the purchase value needs to be included for the purpose of deriving the charge amount. If false, then the purchase value is not included for the purpose of deriving the charge amount. The default value is false.
• PercentageOfItemValue: number
  Title: Percentage of Item Value

  Percent of the purchase value. It is required only when Include Item Value Flag is set to yes.
• RelatedChargeLineId: integer (int64)
  Title: Related Charge Line ID

  Value that uniquely identifies the related charge line for a trade operation charge.
• RelatedChargeLinePercentage: number
  Title: Related Charge Line Percentage

  Percent for each of the related charge line based on which the charge line amount will be derived.
• TradeOperationChargeId: integer (int64)
  Title: Trade Operation Charge ID

  Value that uniquely identifies the trade operation charge.
• TradeOperationChargeRelatedLineId: integer (int64)
  Title: Trade Operation Charge Related Line ID

  Value that uniquely identifies the trade operation charge related line.

{
    "type":"object",
    "properties":{
        "RelatedChargeLinePercentage":{
            "title":"Related Charge Line Percentage",
            "type":"number",
            "description":"Percent for each of the related charge line based on which the charge line amount will be derived.",
            "nullable":false
        },
        "TradeOperationChargeId":{
            "title":"Trade Operation Charge ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IncludePurchaseValueFlag":{
            "title":"Include item value",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the purchase value needs to be included for the purpose of deriving the charge amount. If false, then the purchase value is not included for the purpose of deriving the charge amount. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "RelatedChargeLineId":{
            "title":"Related Charge Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the related charge line for a trade operation charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PercentageOfItemValue":{
            "title":"Percentage of Item Value",
            "type":"number",
            "description":"Percent of the purchase value. It is required only when Include Item Value Flag is set to yes.",
            "nullable":true,
            "x-queryable":false
        },
        "TradeOperationChargeRelatedLineId":{
            "title":"Trade Operation Charge Related Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation charge related line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ChargeLineNumber":{
            "title":"Related Charge Line Number",
            "type":"integer",
            "description":"Value that uniquely identifies the charge line number for the charge entered as related in a charge line.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : tradeOperations-charges-chargeRelatedLines-item-response

Type: object

Show Source

• ChargeBU: string
  Title: Charge BU

  Read Only: true

  Maximum Length: 240

  Value that indicates the requisitioning business unit that incurs the charge.
• ChargeLineNumber: integer
  Title: Related Charge Line Number

  Value that uniquely identifies the charge line number for the charge entered as related in a charge line.
• ChargeLineStatus: string
  Title: Charge Line Status Meaning

  Read Only: true

  Maximum Length: 80

  Value that indicates the meaning of the charge line status.
• ChargeLineStatusCode: string
  Title: Charge Line Status

  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies the status of the charge line. Values include Allocated, Allocated with Warning, Allocation in Error, Cancelled, Draft Allocation, Incomplete, New, Pending Association, Ready for Allocation, and Requires Reallocation.
• ChargeName: string
  Title: Related Charge Name

  Read Only: true

  Maximum Length: 80

  Name of the charge for the related charge line entered in a charge line.
• EnteredCurrencyCode: string
  Title: Charge Currency

  Read Only: true

  Maximum Length: 15

  Transaction currency in which the charge is entered.
• IncludePurchaseValueFlag: boolean
  Title: Include item value

  Contains one of the following values: true or false. If true, then the purchase value needs to be included for the purpose of deriving the charge amount. If false, then the purchase value is not included for the purpose of deriving the charge amount. The default value is false.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PercentageOfItemValue: number
  Title: Percentage of Item Value

  Percent of the purchase value. It is required only when Include Item Value Flag is set to yes.
• RelatedChargeLineId: integer (int64)
  Title: Related Charge Line ID

  Value that uniquely identifies the related charge line for a trade operation charge.
• RelatedChargeLinePercentage: number
  Title: Related Charge Line Percentage

  Percent for each of the related charge line based on which the charge line amount will be derived.
• TotalAmount: number
  Title: Total Amount

  Read Only: true

  Estimated total amount on the charge line.
• TradeOperationChargeId: integer (int64)
  Title: Trade Operation Charge ID

  Value that uniquely identifies the trade operation charge.
• TradeOperationChargeRelatedLineId: integer (int64)
  Title: Trade Operation Charge Related Line ID

  Value that uniquely identifies the trade operation charge related line.

{
    "type":"object",
    "properties":{
        "RelatedChargeLinePercentage":{
            "title":"Related Charge Line Percentage",
            "type":"number",
            "description":"Percent for each of the related charge line based on which the charge line amount will be derived.",
            "nullable":false,
            "x-queryable":true
        },
        "EnteredCurrencyCode":{
            "title":"Charge Currency",
            "maxLength":15,
            "type":"string",
            "description":"Transaction currency in which the charge is entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludePurchaseValueFlag":{
            "title":"Include item value",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the purchase value needs to be included for the purpose of deriving the charge amount. If false, then the purchase value is not included for the purpose of deriving the charge amount. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeName":{
            "title":"Related Charge Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the charge for the related charge line entered in a charge line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PercentageOfItemValue":{
            "title":"Percentage of Item Value",
            "type":"number",
            "description":"Percent of the purchase value. It is required only when Include Item Value Flag is set to yes.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"number",
            "description":"Estimated total amount on the charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChargeLineNumber":{
            "title":"Related Charge Line Number",
            "type":"integer",
            "description":"Value that uniquely identifies the charge line number for the charge entered as related in a charge line.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeLineStatusCode":{
            "title":"Charge Line Status",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies the status of the charge line. Values include Allocated, Allocated with Warning, Allocation in Error, Cancelled, Draft Allocation, Incomplete, New, Pending Association, Ready for Allocation, and Requires Reallocation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationChargeId":{
            "title":"Trade Operation Charge ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChargeBU":{
            "title":"Charge BU",
            "maxLength":240,
            "type":"string",
            "description":"Value that indicates the requisitioning business unit that incurs the charge.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeLineStatus":{
            "title":"Charge Line Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the meaning of the charge line status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedChargeLineId":{
            "title":"Related Charge Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the related charge line for a trade operation charge.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TradeOperationChargeRelatedLineId":{
            "title":"Trade Operation Charge Related Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation charge related line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to create a charge related line.

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/chargeRelatedLines"

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.

{
	"ChargeLineNumber":2,
	"RelatedChargeLinePercentage":18,
	"PercentageOfItemValue":20,
	"IncludePurchaseValueFlag":true
}

Example 1 Response Body

The following example includes the contents of the response body in JSON format:

{
	"ChargeBU": "Vision Services",
	"ChargeLineNumber": 2,
	"ChargeLineStatusCode": "INCOMPLETE",
	"ChargeLineStatus": "Incomplete",
	"ChargeName": "Freight",
	"EnteredCurrencyCode": "USD",
	"IncludePurchaseValueFlag": true,
	"PercentageOfItemValue": 20,
	"RelatedChargeLineId": 300100125725126,
	"RelatedChargeLinePercentage": 18,
	"TotalAmount": null,
	"TradeOperationChargeId": 300100125727023,
	"TradeOperationChargeRelatedLineId": 300100125775113,
	"links": [{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100125727022/child/charges/300100125727023/child/chargeRelatedLines/300100125775113",
		"name": "chargeRelatedLines",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	}, {
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100125727022/child/charges/300100125727023/child/chargeRelatedLines/300100125775113",
		"name": "chargeRelatedLines",
		"kind": "item"
	}, {
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100125727022/child/charges/300100125727023",
		"name": "charges",
		"kind": "item"
	}, {
		"rel": "lov",
		"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100125727022/child/charges/300100125727023/child/chargeRelatedLines/300100125775113/lov/relatedChargeLineNumberLOV",
		"name": "relatedChargeLineNumberLOV",
		"kind": "collection"
	}]
}

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/300100169198027/child/charges/300100169198177/child/chargeRelatedLines/",            
		"operation": "create",            
		"payload":  {
			"ChargeLineNumber":3,
			"RelatedChargeLinePercentage":20
		}
	}
	]
}

Example 2 Response Body

The following example includes the contents of the response body in JSON format:

{
	"parts": [{
		"id": "part1",
		"path": "https://servername/fscmRestApi/resources/version/tradeOperations/300100169198027/child/charges/300100169198177/child/chargeRelatedLines",
		"operation": "create",
		"payload": {
			"ChargeBU": "Vision Services",
			"ChargeLineNumber": 3,
			"ChargeLineStatusCode": "ALLOCATED",
			"ChargeLineStatus": "Successfully allocated",
			"ChargeName": "Miscellaneous",
			"EnteredCurrencyCode": "USD",
			"IncludePurchaseValueFlag": true,
			"PercentageOfItemValue": 20,
			"RelatedChargeLineId": 300100169198079,
			"RelatedChargeLinePercentage": 20,
			"TotalAmount": 3,
			"TradeOperationChargeId": 300100169198177,
			"TradeOperationChargeRelatedLineId": 300100169330911,
			"links": [{
				"rel": "self",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100169198027/child/charges/300100169198177/child/chargeRelatedLines/300100169330911",
				"name": "chargeRelatedLines",
				"kind": "item",
				"properties": {
					"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
				}
			}, {
				"rel": "canonical",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100169198027/child/charges/300100169198177/child/chargeRelatedLines/300100169330911",
				"name": "chargeRelatedLines",
				"kind": "item"
			}, {
				"rel": "parent",
				"href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100169198027/child/charges/300100169198177",
				"name": "charges",
				"kind": "item"
			}]
		}
	}]
}

Back to Top