Jump to

• Request
• Response
• Examples

Update one sales credit

patch

/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/salesCredits/{SalesCreditId}

Request

Path Parameters

• OrderKey(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• SalesCreditId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Percent: number
  Value that specifies the sales credit percent for the salesperson.
• SalesCreditType: string
  Maximum Length: 255

  Name of the sales credit type.
• SalesCreditTypeId: integer (int64)
  Value that identifies the sales credit type.
• Salesperson: string
  Maximum Length: 255

  Name of person who sold the item.
• SalespersonId: integer (int64)
  Value that identifies the person who sold the item.
• SourceTransactionSalesCreditIdentifier: string
  Maximum Length: 50

  Value that uniquely identifies the sales credit. The source application assigns this value.

{
    "type":"object",
    "properties":{
        "Percent":{
            "type":"number",
            "description":"Value that specifies the sales credit percent for the salesperson.",
            "nullable":false
        },
        "SalesCreditType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the sales credit type.",
            "nullable":true
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"Value that identifies the sales credit type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Salesperson":{
            "maxLength":255,
            "type":"string",
            "description":"Name of person who sold the item.",
            "nullable":true
        },
        "SalespersonId":{
            "type":"integer",
            "description":"Value that identifies the person who sold the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceTransactionSalesCreditIdentifier":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the sales credit. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SalesCreditId"
                ]
            }
        }
    }
}

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 : salesOrdersForOrderHub-salesCredits-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Percent: number
  Value that specifies the sales credit percent for the salesperson.
• SalesCreditId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sales credit.
• SalesCreditType: string
  Maximum Length: 255

  Name of the sales credit type.
• SalesCreditTypeId: integer (int64)
  Value that identifies the sales credit type.
• Salesperson: string
  Maximum Length: 255

  Name of person who sold the item.
• SalespersonId: integer (int64)
  Value that identifies the person who sold the item.
• SourceTransactionSalesCreditIdentifier: string
  Maximum Length: 50

  Value that uniquely identifies the sales credit. The source application assigns this value.

{
    "type":"object",
    "properties":{
        "Percent":{
            "type":"number",
            "description":"Value that specifies the sales credit percent for the salesperson.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sales credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SalesCreditType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the sales credit type.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "type":"integer",
            "description":"Value that identifies the sales credit type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Salesperson":{
            "maxLength":255,
            "type":"string",
            "description":"Name of person who sold the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SalespersonId":{
            "type":"integer",
            "description":"Value that identifies the person who sold the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionSalesCreditIdentifier":{
            "maxLength":50,
            "type":"string",
            "description":"Value that uniquely identifies the sales credit. The source application assigns this value.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SalesCreditId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 update one sales credit.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/OrderKey/child/salesCredits/SalesCreditId"

For example, use the following command:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/salesOrdersForOrderHub/GPR%3AR13_sample_HdrSC_01/child/salesCredits/300100185390588"

Example 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 updates.

You can achieve the same result with Create sales orders using the upsert-mode header parameter. Refer to the examples in the Create sales orders section to see how to update child resource in the existing order.

{ 
	"Percent" : 75
}	

Example Response Body

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

{
}

Back to Top