Update one assignment
patch
/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/sites/{SupplierSiteId}/child/assignments/{AssignmentId}
Request
Path Parameters
-
AssignmentId(required): integer
Value that uniquely identifies the supplier site assignment.
-
SupplierId(required): integer(int64)
Value that uniquely identifies the supplier.
-
SupplierSiteId(required): integer(int64)
Value that uniquely identifies the supplier site.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BillPayableDistribution: string
Title:
Bill Payable Distribution
Distribution of the bills that are payable for the supplier site. -
BillPayableDistributionId: integer
Title:
Bill Payable Distribution
Value that uniquely identifies the distribution of the bills that are payable for the supplier site. -
BillToBU: string
Title:
Bill-to BU
Maximum Length:240
Business unit that the application uses for billing instead of the client business unit that the user selects. -
BillToBUId: integer
(int64)
Value that uniquely identifies the business unit that the application uses for billing instead of the client business unit that the user selects.
-
BillToLocationCode: string
Title:
Bill-to Location
Maximum Length:150
Abbreviation that identifies the bill to location. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Locations task. -
BillToLocationId: integer
Values that uniquely identifies the default billing location on purchasing documents for the bill-to business unit that the user selects.
-
DistributionSet: string
Title:
Distribution Set
Maximum Length:50
Distribution set that determines the distribution on invoices for the supplier site. -
DistributionSetId: integer
Title:
Distribution Set
Value that uniquely identifies the distribution set that determines the distribution on invoices for the supplier site. -
InactiveDate: string
(date)
Title:
Inactive Date
Date when the supplier site assignment is no longer active. -
LiabilityDistribution: string
Title:
Liability Distribution
The liability distribution of new invoices for the supplier site. -
LiabilityDistributionId: integer
Title:
Liability Distribution
Value that uniquely identifies the liability distribution of new invoices for the supplier site. -
PrepaymentDistribution: string
Title:
Prepayment Distribution
Prepayment distribution of the prepayments for the supplier site. -
PrepaymentDistributionId: integer
Title:
Prepayment Distribution
Value that uniquely identifies the distribution of the prepayments for the supplier site. -
ShipToLocationCode: string
Title:
Ship-to Location
Maximum Length:150
Abbreviation that identifies the ship to location. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Locations task. -
ShipToLocationId: integer
Value that uniquely identifies the default shipping location on the purchasing document for the client business unit.
-
UseWithholdingTaxFlag: boolean
Title:
Use Withholding Tax
Maximum Length:1
Contains one of the following values: true or false. If true, then the withholding tax is applicable to the supplier assignment. If false, then withholding tax is not applicable. The default value is false. -
WithholdingTaxGroup: string
Title:
Withholding Tax Group
Maximum Length:25
Describes the withholding tax group that the application assigned to the supplier site assignment. -
WithholdingTaxGroupId: integer
(int64)
Value that uniquely identifies the tax group that the application uses to assign the site to withhold tax.
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.
Root Schema : suppliers-sites-assignments-item-response
Type:
Show Source
object
-
AssignmentId: integer
Value that uniquely identifies the supplier site assignment.
-
BillPayableDistribution: string
Title:
Bill Payable Distribution
Distribution of the bills that are payable for the supplier site. -
BillPayableDistributionId: integer
Title:
Bill Payable Distribution
Value that uniquely identifies the distribution of the bills that are payable for the supplier site. -
BillToBU: string
Title:
Bill-to BU
Maximum Length:240
Business unit that the application uses for billing instead of the client business unit that the user selects. -
BillToBUId: integer
(int64)
Value that uniquely identifies the business unit that the application uses for billing instead of the client business unit that the user selects.
-
BillToLocation: string
Title:
Bill-to Location
Read Only:true
Maximum Length:60
Default billing location on purchasing documents for the bill-to business unit that the user selects. -
BillToLocationCode: string
Title:
Bill-to Location
Maximum Length:150
Abbreviation that identifies the bill to location. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Locations task. -
BillToLocationId: integer
Values that uniquely identifies the default billing location on purchasing documents for the bill-to business unit that the user selects.
-
ChartOfAccountsId: integer
(int64)
Read Only:
true
Value that uniquely identifies the chart of account. -
ClientBU: string
Title:
Client BU
Maximum Length:240
Business unit that is a client of the procurement business unit where the supplier site resides. -
ClientBUId: integer
(int64)
Value that uniquely identifies the business unit that is a client of the procurement business unit where the supplier site resides.
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the supplier record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the supplier record. -
DistributionSet: string
Title:
Distribution Set
Maximum Length:50
Distribution set that determines the distribution on invoices for the supplier site. -
DistributionSetId: integer
Title:
Distribution Set
Value that uniquely identifies the distribution set that determines the distribution on invoices for the supplier site. -
InactiveDate: string
(date)
Title:
Inactive Date
Date when the supplier site assignment is no longer active. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the user most recently updated the supplier record. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the supplier record. -
LiabilityDistribution: string
Title:
Liability Distribution
The liability distribution of new invoices for the supplier site. -
LiabilityDistributionId: integer
Title:
Liability Distribution
Value that uniquely identifies the liability distribution of new invoices for the supplier site. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrepaymentDistribution: string
Title:
Prepayment Distribution
Prepayment distribution of the prepayments for the supplier site. -
PrepaymentDistributionId: integer
Title:
Prepayment Distribution
Value that uniquely identifies the distribution of the prepayments for the supplier site. -
ShipToLocation: string
Title:
Ship-to Location
Read Only:true
Maximum Length:60
Default shipping location on the purchasing document for the client business unit. -
ShipToLocationCode: string
Title:
Ship-to Location
Maximum Length:150
Abbreviation that identifies the ship to location. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Locations task. -
ShipToLocationId: integer
Value that uniquely identifies the default shipping location on the purchasing document for the client business unit.
-
Status: string
Read Only:
true
Status of the supplier site assignment. -
UseWithholdingTaxFlag: boolean
Title:
Use Withholding Tax
Maximum Length:1
Contains one of the following values: true or false. If true, then the withholding tax is applicable to the supplier assignment. If false, then withholding tax is not applicable. The default value is false. -
WithholdingTaxGroup: string
Title:
Withholding Tax Group
Maximum Length:25
Describes the withholding tax group that the application assigned to the supplier site assignment. -
WithholdingTaxGroupId: integer
(int64)
Value that uniquely identifies the tax group that the application uses to assign the site to withhold tax.
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
This example describes how to update an assignment.
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/suppliers/SupplierId/child/sites/SupplierSiteId/child/assignments/AssignmentId"
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.
{ "UseWithholdingTaxFlag" : "N", "WithholdingTaxGroupId" : "", "LiabilityDistribution": "01-000-2220-0000-000", }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AssignmentId": 300100184732422, "ClientBUId": 5186, "ClientBU": "Vision Construction", "BillToBUId": 5186, "BillToBU": "Vision Construction", "ShipToLocationId": 2510, "ShipToLocation": "FldSvc", "ShipToLocationCode": "FLDSVC_0_2452104113000", "BillToLocationId": 2510, "BillToLocation": "FldSvc", "BillToLocationCode": "FLDSVC_0_2452104113000", "UseWithholdingTaxFlag": false, "WithholdingTaxGroupId": null, "WithholdingTaxGroup": null, "ChartOfAccountsId": 101, "LiabilityDistributionId": 17816, "LiabilityDistribution": "01-000-2220-0000-000", "PrepaymentDistributionId": 17485, "PrepaymentDistribution": "01-510-7430-0000-000", "BillPayableDistributionId": null, "BillPayableDistribution": null, "DistributionSetId": 300100136289243, "DistributionSet": "1 Line Set QA", "InactiveDate": null, "Status": "ACTIVE", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422", "name": "assignments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422", "name": "assignments", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416", "name": "sites", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422/lov/WithholdingTaxGroupLookup", "name": "WithholdingTaxGroupLookup", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422/lov/ClientBuSiteAssignmentLookup", "name": "ClientBuSiteAssignmentLookup", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422/lov/ShipToLocationLookup", "name": "ShipToLocationLookup", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422/lov/BillToBuSiteAssignmentLookup", "name": "BillToBuSiteAssignmentLookup", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422/lov/BillToLocationLookup", "name": "BillToLocationLookup", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/suppliers/300100184731456/child/sites/300100184732416/child/assignments/300100184732422/lov/DistributionSetLookup", "name": "DistributionSetLookup", "kind": "collection" } ] }