Create one assignment

post

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/sites/{SupplierSiteId}/child/assignments

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Value that uniquely identifies the supplier site assignment.
  • Title: Bill Payable Distribution
    Distribution of the bills that are payable for the supplier site.
  • Title: Bill Payable Distribution
    Value that uniquely identifies the distribution of the bills that are payable for the supplier site.
  • 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.
  • Value that uniquely identifies the business unit that the application uses for billing instead of the client business unit that the user selects.
  • 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.
  • Values that uniquely identifies the default billing location on purchasing documents for the bill-to business unit that the user selects.
  • Title: Client BU
    Maximum Length: 240
    Business unit that is a client of the procurement business unit where the supplier site resides.
  • Value that uniquely identifies the business unit that is a client of the procurement business unit where the supplier site resides.
  • Title: Distribution Set
    Maximum Length: 50
    Distribution set that determines the distribution on invoices for the supplier site.
  • Title: Distribution Set
    Value that uniquely identifies the distribution set that determines the distribution on invoices for the supplier site.
  • Title: Inactive Date
    Date when the supplier site assignment is no longer active.
  • Title: Liability Distribution
    The liability distribution of new invoices for the supplier site.
  • Title: Liability Distribution
    Value that uniquely identifies the liability distribution of new invoices for the supplier site.
  • Title: Prepayment Distribution
    Prepayment distribution of the prepayments for the supplier site.
  • Title: Prepayment Distribution
    Value that uniquely identifies the distribution of the prepayments for the supplier site.
  • 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.
  • Value that uniquely identifies the default shipping location on the purchasing document for the client business unit.
  • 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.
  • Title: Withholding Tax Group
    Maximum Length: 25
    Describes the withholding tax group that the application assigned to the supplier site assignment.
  • Value that uniquely identifies the tax group that the application uses to assign the site to withhold tax.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : suppliers-sites-assignments-item-response
Type: object
Show Source
  • Value that uniquely identifies the supplier site assignment.
  • Title: Bill Payable Distribution
    Distribution of the bills that are payable for the supplier site.
  • Title: Bill Payable Distribution
    Value that uniquely identifies the distribution of the bills that are payable for the supplier site.
  • 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.
  • Value that uniquely identifies the business unit that the application uses for billing instead of the client business unit that the user selects.
  • 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.
  • 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.
  • Values that uniquely identifies the default billing location on purchasing documents for the bill-to business unit that the user selects.
  • Read Only: true
    Value that uniquely identifies the chart of account.
  • Title: Client BU
    Maximum Length: 240
    Business unit that is a client of the procurement business unit where the supplier site resides.
  • Value that uniquely identifies the business unit that is a client of the procurement business unit where the supplier site resides.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    User who created the supplier record.
  • Title: Creation Date
    Read Only: true
    Date when the user created the supplier record.
  • Title: Distribution Set
    Maximum Length: 50
    Distribution set that determines the distribution on invoices for the supplier site.
  • Title: Distribution Set
    Value that uniquely identifies the distribution set that determines the distribution on invoices for the supplier site.
  • Title: Inactive Date
    Date when the supplier site assignment is no longer active.
  • Title: Last Updated Date
    Read Only: true
    Date and time when the user most recently updated the supplier record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    User who most recently updated the supplier record.
  • Title: Liability Distribution
    The liability distribution of new invoices for the supplier site.
  • Title: Liability Distribution
    Value that uniquely identifies the liability distribution of new invoices for the supplier site.
  • Links
  • Title: Prepayment Distribution
    Prepayment distribution of the prepayments for the supplier site.
  • Title: Prepayment Distribution
    Value that uniquely identifies the distribution of the prepayments for the supplier site.
  • Title: Ship-to Location
    Read Only: true
    Maximum Length: 60
    Default shipping location on the purchasing document for the client business unit.
  • 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.
  • Value that uniquely identifies the default shipping location on the purchasing document for the client business unit.
  • Read Only: true
    Status of the supplier site assignment.
  • 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.
  • Title: Withholding Tax Group
    Maximum Length: 25
    Describes the withholding tax group that the application assigned to the supplier site assignment.
  • Value that uniquely identifies the tax group that the application uses to assign the site to withhold tax.
Back to Top

Examples

This example describes how to create an assignment.

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/suppliers/SupplierId/child/sites/SupplierSiteId/child/assignments"

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

{
	"ClientBUId" : 5186,
	"BillToBU" : "Vision Construction",
	"ShipToLocationId" : 2510,
	"BillToLocationCode" :  "FLDSVC_0_2452104113000",
	"UseWithholdingTaxFlag" : "Y",
	"WithholdingTaxGroupId" : 100100019061302,
	"DistributionSet" : "1 Line Set QA",
	"LiabilityDistribution" : "01-000-2372-0000-000",
	"PrepaymentDistribution" : "01-510-7430-0000-000",
	"InactiveDate" : ""
}

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": true,
	"WithholdingTaxGroupId": 100100019061302,
	"WithholdingTaxGroup": "WHT_AP_RRF_01B-WH9",
	"ChartOfAccountsId": 101,
	"LiabilityDistributionId": 17816,
	"LiabilityDistribution": "01-000-2372-0000-000",
	"PrepaymentDistributionId": 17485,
	"PrepaymentDistribution": "01-510-7430-0000-000",
	"BillPayableDistributionId": null,
	"BillPayableDistribution": null,
	"DistributionSetId": 300100136289243,
	"DistributionSet": "1 Line Set QA",
	"InactiveDate": "4712-12-31",
	"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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"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"
	}
	]
}

Back to Top