Jump to

• Request
• Response
• Examples

Get one assignment

get

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : suppliers-sites-assignments-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ClientBU":{
            "title":"Client BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that is a client of the procurement business unit where the supplier site resides.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClientBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that is a client of the procurement business unit where the supplier site resides.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "WithholdingTaxGroup":{
            "title":"Withholding Tax Group",
            "maxLength":"25",
            "type":"string",
            "description":"Describes the withholding tax group that the application assigned to the supplier site assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillPayableDistributionId":{
            "title":"Bill Payable Distribution",
            "type":"integer",
            "description":"Value that uniquely identifies the distribution of the bills that are payable for the supplier site.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"FDPmtKFFVA"
            },
            "x-queryable":true
        },
        "PrepaymentDistributionId":{
            "title":"Prepayment Distribution",
            "type":"integer",
            "description":"Value that uniquely identifies the distribution of the prepayments for the supplier site.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"PrepayKFFVA"
            },
            "x-queryable":true
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Values that uniquely identifies the default billing location on purchasing documents for the bill-to business unit that the user selects.",
            "nullable":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"BillToBuId"
            },
            "x-queryable":true
        },
        "PrepaymentDistribution":{
            "title":"Prepayment Distribution",
            "type":"string",
            "description":"Prepayment distribution of the prepayments for the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            }
        },
        "UseWithholdingTaxFlag":{
            "title":"Use Withholding Tax",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LiabilityDistributionId":{
            "title":"Liability Distribution",
            "type":"integer",
            "description":"Value that uniquely identifies the liability distribution of new invoices for the supplier site.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"AcctsPayKFFVA"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site assignment.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "title":"Ship-to Location",
            "maxLength":"150",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillToLocation":{
            "title":"Bill-to Location",
            "maxLength":"60",
            "type":"string",
            "description":"Default billing location on purchasing documents for the bill-to business unit that the user selects.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the supplier site assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InactiveDate"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InactiveDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Date when the supplier site assignment is no longer active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionSet":{
            "title":"Distribution Set",
            "maxLength":"50",
            "type":"string",
            "description":"Distribution set that determines the distribution on invoices for the supplier site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BillToBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that the application uses for billing instead of the client business unit that the user selects.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default shipping location on the purchasing document for the client business unit.",
            "nullable":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"BuId"
            },
            "x-queryable":true
        },
        "DistributionSetId":{
            "title":"Distribution Set",
            "type":"integer",
            "description":"Value that uniquely identifies the distribution set that determines the distribution on invoices for the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "BillPayableDistribution":{
            "title":"Bill Payable Distribution",
            "type":"string",
            "description":"Distribution of the bills that are payable for the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            }
        },
        "BillToLocationCode":{
            "title":"Bill-to Location",
            "maxLength":"150",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WithholdingTaxGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tax group that the application uses to assign the site to withhold tax.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChartOfAccountsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the chart of account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_StructureID":"AcctsPayKFFVA",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":"60",
            "type":"string",
            "description":"Default shipping location on the purchasing document for the client business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToBU":{
            "title":"Bill-to BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that the application uses for billing instead of the client business unit that the user selects.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LiabilityDistribution":{
            "title":"Liability Distribution",
            "type":"string",
            "description":"The liability distribution of new invoices for the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 get one assignment.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/sites/SupplierSiteId/child/assignments/AssignmentId"

For example, the following command gets one assignment where the assignment identifier is 300100153044579:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579"

Example Response Body

The following shows an example of the response body in JSON format.

{
  "AssignmentId" : 300100153044579,
  "ClientBUId" : 204,
  "ClientBU" : "Vision Corporation",
  "BillToBUId" : 204,
  "BillToBU" : "Vision Corporation",
  "ShipToLocationId": 18621,
  "ShipToLocation": "V10 Virginia",
  "ShipToLocationCode": "V10_VIRGINIA",
  "BillToLocationId": 18621,
  "BillToLocation": "V10 Virginia",
  "BillToLocationCode": "V10_VIRGINIA",
  "UseWithholdingTaxFlag" : null,
  "WithholdingTaxGroupId" : null,
  "WithholdingTaxGroup" : null,
  "ChartOfAccountsId" : 101,
  "LiabilityDistributionId" : 89276,
  "LiabilityDistribution" : "01-000-2120-0000-000",
  "PrepaymentDistributionId" : 300100153044580,
  "PrepaymentDistribution" : "01-000-1140-1300-000",
  "BillPayableDistributionId" : 300100153044581,
  "BillPayableDistribution" : "01-000-1130-1200-000",
  "DistributionSetId" : 10020,
  "DistributionSet" : "Advertising, Public Relations (Full)",
  "InactiveDate" : null,
  "Status" : "ACTIVE",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579",
    "name" : "assignments",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579",
    "name" : "assignments",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573",
    "name" : "sites",
    "kind" : "item"
  } ]
}

Back to Top