Jump to

• Request
• Response
• Examples

Create a charge reference

post

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

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: 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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: 64

  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.

{
    "type":"object",
    "properties":{
        "ChargeReferenceTypeId":{
            "title":"Trade Operation Charge Reference Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies the type of charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            }
        },
        "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
            }
        },
        "AutoAssociateFlag":{
            "title":"Automatically Associate on Match",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "ReferenceValueText":{
            "title":"Alphanumeric Reference",
            "maxLength":64,
            "type":"string",
            "description":"Alphanumeric value of the charge reference attribute.",
            "nullable":true
        },
        "ReferenceValueNumber":{
            "title":"Numeric Reference",
            "type":"number",
            "description":"Numeric value of the charge reference attribute.",
            "nullable":true
        },
        "TradeOperationChargeReferenceValueId":{
            "title":"Trade Operation Charge Reference Value ID",
            "type":"integer",
            "description":"Value that uniquely identifies the charge reference to a charge line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ChargeReferenceName":{
            "title":"Charge Reference Name",
            "type":"string",
            "description":"Name of the charge reference for a charge line.",
            "nullable":true
        },
        "ReferenceValueDate":{
            "title":"Date Reference",
            "type":"string",
            "description":"Date value of the charge reference attribute.",
            "format":"date-time",
            "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:
  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.

Body ()

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

Type: object

Show Source

• 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: 64

  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.

{
    "type":"object",
    "properties":{
        "ChargeReferenceTypeId":{
            "title":"Trade Operation Charge Reference Type ID",
            "type":"integer",
            "description":"Value that uniquely identifies the type of charge reference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"PrcBuId"
            },
            "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
        },
        "AutoAssociateFlag":{
            "title":"Automatically Associate on Match",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PreDefinedFlag":{
            "title":"Predefined",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "ReferenceValueText":{
            "title":"Alphanumeric Reference",
            "maxLength":64,
            "type":"string",
            "description":"Alphanumeric value of the charge reference attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceValueNumber":{
            "title":"Numeric Reference",
            "type":"number",
            "description":"Numeric value of the charge reference attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TradeOperationChargeReferenceValueId":{
            "title":"Trade Operation Charge Reference Value ID",
            "type":"integer",
            "description":"Value that uniquely identifies the charge reference to a charge line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ChargeReferenceName":{
            "title":"Charge Reference Name",
            "type":"string",
            "description":"Name of the charge reference for a charge line.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargeReferenceTypeDescription":{
            "title":"Reference Type Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the charge reference for a charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChargeReferenceValueDataType":{
            "title":"Reference Data Type",
            "maxLength":80,
            "type":"string",
            "description":"Value that identifies the input data type for charge references.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ChargeRefValueDataType1"
                ]
            },
            "x-queryable":true
        },
        "ReferenceValueDate":{
            "title":"Date Reference",
            "type":"string",
            "description":"Date value of the charge reference attribute.",
            "format":"date-time",
            "nullable":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 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": [....]
}

Back to Top