Jump to

• Request
• Response
• Examples

Create one requisition processing request header

post

/fscmRestApi/resources/11.13.18.05/requisitionProcessingRequests

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Buyer: string
  Title: Buyer

  Maximum Length: 240

  Person who is responsible for managing the procurement document.
• BuyerId: integer (int64)
  Value that uniquely identifies the buyer.
• ConversionRate: number
  Rate to use when converting currency.
• ConversionRateDate: string (date)
  Date to use for the conversion rate when converting an ordered amount into another currency. The conversion rate varies depending on the date.
• ConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  Type of rate that the application uses to determine the currency conversion rate for the purchase order.
• ConversionRateTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of rate that the application uses to determine the currency conversion rate for the purchase order.
• Currency: string
  Title: Currency

  Maximum Length: 80

  Abbreviation that identifies the currency of the purchase order.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency code of the purchase order.
• DocumentStyle: string
  Title: Document Style

  Maximum Length: 240

  Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.
• DocumentStyleId: integer (int64)
  Value that uniquely identifies the purchasing style of the document.
• GroupRequisitionLines: string
  Contains one of the following values: Y or N. If Y, then requisition lines are combined on order lines in the purchase order. If N, then you can't group requisition lines.
• lines: array Lines
  Title: Lines

  The Lines resource manages the requisition lines that need to be processed into a procurement document.
• OrderNumber: string
  Maximum Length: 30

  Number that uniquely identifies the purchase order.
• POHeaderId: integer (int64)
  Value that uniquely identifies the purchase order header.
• ProcurementBU: string
  Title: Procurement BU

  Maximum Length: 240

  Business unit that manages and owns the requisition and corresponding purchase order or a negotiation.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the business unit that manages and owns the requisition and corresponding purchase order or a negotiation.
• RequisitioningBU: string
  Title: Requisitioning BU

  Maximum Length: 240

  Name of the business unit that raised the requisition for goods and services.
• RequisitioningBUId: integer (int64)
  Value that uniquely identifies the business unit that raised the requisition for goods and services.
• SoldToLegalEntity: string
  Title: Sold-to Legal Entity

  Legal entity that is financially responsible for purchases on the purchase order.
• SoldToLegalEntityId: integer (int64)
  Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.
• SourceAgreement: string
  Title: Source Agreement

  Maximum Length: 30

  Number that uniquely identifies the source agreement.
• SourceAgreementId: integer (int64)
  Value that uniquely identifies the source agreement.
• Supplier: string
  Title: Supplier

  Maximum Length: 360

  Name of the supplier.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 240

  Location that the supplier uses to purchase the item.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.
• Type(required): string
  Title: Type

  Values that uniquely identify the document type. Type can be a new order or an existing order or a negotiation.

{
    "required":[
        "Type"
    ],
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that raised the requisition for goods and services.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "SoldToLegalEntity":{
            "title":"Sold-to Legal Entity",
            "type":"string",
            "description":"Legal entity that is financially responsible for purchases on the purchase order.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ProcurementBU",
                    "RequisitioningBU"
                ]
            }
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":"240",
            "type":"string",
            "description":"Person who is responsible for managing the procurement document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBU"
                ]
            }
        },
        "OrderNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the purchase order.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DocumentStyle":{
            "title":"Document Style",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of rate that the application uses to determine the currency conversion rate for the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency code of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit that raised the requisition for goods and services.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBU"
                ]
            }
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "OrderLocallyBuId",
                    "RequisitioningBU",
                    "Supplier"
                ]
            }
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the currency of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBU",
                    "RequisitioningBU",
                    "SourceAgreement"
                ]
            }
        },
        "ConversionRateDate":{
            "type":"string",
            "description":"Date to use for the conversion rate when converting an ordered amount into another currency. The conversion rate varies depending on the date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "lines":{
            "title":"Lines",
            "type":"array",
            "description":"The Lines resource manages the requisition lines that need to be processed into a procurement document.",
            "items":{
                "$ref":"#/components/schemas/requisitionProcessingRequests-lines-item-post-request"
            }
        },
        "SourceAgreement":{
            "title":"Source Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the source agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the requisition and corresponding purchase order or a negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that manages and owns the requisition and corresponding purchase order or a negotiation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SoldToLegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "GroupRequisitionLines":{
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then requisition lines are combined on order lines in the purchase order. If N, then you can't group requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceAgreementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source agreement.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ConversionRateTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of rate that the application uses to determine the currency conversion rate for the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "Type":{
            "title":"Type",
            "type":"string",
            "description":"Values that uniquely identify the document type. Type can be a new order or an existing order or a negotiation.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConversionRate":{
            "type":"number",
            "description":"Rate to use when converting currency.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Location that the supplier uses to purchase the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrderLocallyBuId",
                    "RequisitioningBU",
                    "Supplier"
                ]
            }
        },
        "DocumentStyleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing style of the document.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        }
    }
}

Nested Schema : Lines

Type: array

Title: Lines

The Lines resource manages the requisition lines that need to be processed into a procurement document.

Show Source

• Array of: object requisitionProcessingRequests-lines-item-post-request

{
    "title":"Lines",
    "type":"array",
    "description":"The Lines resource manages the requisition lines that need to be processed into a procurement document.",
    "items":{
        "$ref":"#/components/schemas/requisitionProcessingRequests-lines-item-post-request"
    }
}

Nested Schema : requisitionProcessingRequests-lines-item-post-request

Type: object

Show Source

• RequisitionLineId: integer (int64)
  Value that uniquely identifies the requisition line.

{
    "type":"object",
    "properties":{
        "RequisitionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisition line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : requisitionProcessingRequests-item-response

Type: object

Show Source

• Buyer: string
  Title: Buyer

  Maximum Length: 240

  Person who is responsible for managing the procurement document.
• BuyerId: integer (int64)
  Value that uniquely identifies the buyer.
• ConversionRate: number
  Rate to use when converting currency.
• ConversionRateDate: string (date)
  Date to use for the conversion rate when converting an ordered amount into another currency. The conversion rate varies depending on the date.
• ConversionRateType: string
  Title: Conversion Rate Type

  Maximum Length: 30

  Type of rate that the application uses to determine the currency conversion rate for the purchase order.
• ConversionRateTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of rate that the application uses to determine the currency conversion rate for the purchase order.
• Currency: string
  Title: Currency

  Maximum Length: 80

  Abbreviation that identifies the currency of the purchase order.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency code of the purchase order.
• DocumentStyle: string
  Title: Document Style

  Maximum Length: 240

  Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.
• DocumentStyleId: integer (int64)
  Value that uniquely identifies the purchasing style of the document.
• GroupRequisitionLines: string
  Contains one of the following values: Y or N. If Y, then requisition lines are combined on order lines in the purchase order. If N, then you can't group requisition lines.
• lines: array Lines
  Title: Lines

  The Lines resource manages the requisition lines that need to be processed into a procurement document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderNumber: string
  Maximum Length: 30

  Number that uniquely identifies the purchase order.
• POHeaderId: integer (int64)
  Value that uniquely identifies the purchase order header.
• ProcurementBU: string
  Title: Procurement BU

  Maximum Length: 240

  Business unit that manages and owns the requisition and corresponding purchase order or a negotiation.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the business unit that manages and owns the requisition and corresponding purchase order or a negotiation.
• RequestHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the request header.
• RequisitioningBU: string
  Title: Requisitioning BU

  Maximum Length: 240

  Name of the business unit that raised the requisition for goods and services.
• RequisitioningBUId: integer (int64)
  Value that uniquely identifies the business unit that raised the requisition for goods and services.
• SoldToLegalEntity: string
  Title: Sold-to Legal Entity

  Legal entity that is financially responsible for purchases on the purchase order.
• SoldToLegalEntityId: integer (int64)
  Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.
• SourceAgreement: string
  Title: Source Agreement

  Maximum Length: 30

  Number that uniquely identifies the source agreement.
• SourceAgreementId: integer (int64)
  Value that uniquely identifies the source agreement.
• Supplier: string
  Title: Supplier

  Maximum Length: 360

  Name of the supplier.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierSite: string
  Title: Supplier Site

  Maximum Length: 240

  Location that the supplier uses to purchase the item.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.
• Type: string
  Title: Type

  Values that uniquely identify the document type. Type can be a new order or an existing order or a negotiation.

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that raised the requisition for goods and services.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SoldToLegalEntity":{
            "title":"Sold-to Legal Entity",
            "type":"string",
            "description":"Legal entity that is financially responsible for purchases on the purchase order.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ProcurementBU",
                    "RequisitioningBU"
                ]
            },
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":"240",
            "type":"string",
            "description":"Person who is responsible for managing the procurement document.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBU"
                ]
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the purchase order.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DocumentStyle":{
            "title":"Document Style",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of rate that the application uses to determine the currency conversion rate for the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency code of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit that raised the requisition for goods and services.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBU"
                ]
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "OrderLocallyBuId",
                    "RequisitioningBU",
                    "Supplier"
                ]
            }
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the currency of the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ProcurementBU",
                    "RequisitioningBU",
                    "SourceAgreement"
                ]
            }
        },
        "ConversionRateDate":{
            "type":"string",
            "description":"Date to use for the conversion rate when converting an ordered amount into another currency. The conversion rate varies depending on the date.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "lines":{
            "title":"Lines",
            "type":"array",
            "description":"The Lines resource manages the requisition lines that need to be processed into a procurement document.",
            "items":{
                "$ref":"#/components/schemas/requisitionProcessingRequests-lines-item-response"
            }
        },
        "SourceAgreement":{
            "title":"Source Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the source agreement.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the requisition and corresponding purchase order or a negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that manages and owns the requisition and corresponding purchase order or a negotiation.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SoldToLegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GroupRequisitionLines":{
            "type":"string",
            "description":"Contains one of the following values: Y or N. If Y, then requisition lines are combined on order lines in the purchase order. If N, then you can't group requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceAgreementId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source agreement.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ConversionRateTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of rate that the application uses to determine the currency conversion rate for the purchase order.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "Type":{
            "title":"Type",
            "type":"string",
            "description":"Values that uniquely identify the document type. Type can be a new order or an existing order or a negotiation.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConversionRate":{
            "type":"number",
            "description":"Rate to use when converting currency.",
            "nullable":true,
            "x-queryable":false
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Location that the supplier uses to purchase the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrderLocallyBuId",
                    "RequisitioningBU",
                    "Supplier"
                ]
            }
        },
        "DocumentStyleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing style of the document.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "RequestHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Lines

Type: array

Title: Lines

The Lines resource manages the requisition lines that need to be processed into a procurement document.

Show Source

• Array of: object requisitionProcessingRequests-lines-item-response

{
    "title":"Lines",
    "type":"array",
    "description":"The Lines resource manages the requisition lines that need to be processed into a procurement document.",
    "items":{
        "$ref":"#/components/schemas/requisitionProcessingRequests-lines-item-response"
    }
}

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 : requisitionProcessingRequests-lines-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the request header.
• RequestLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the request line.
• RequisitionLineId: integer (int64)
  Value that uniquely identifies the requisition line.

{
    "type":"object",
    "properties":{
        "RequestLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequisitionLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisition line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the request header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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."
        }
    }
}

Links

lines

Operation: /fscmRestApi/resources/11.13.18.05/requisitionProcessingRequests/{requisitionProcessingRequestsUniqID}/child/lines

Parameters:

• requisitionProcessingRequestsUniqID: $request.path.requisitionProcessingRequestsUniqID

The Lines resource manages the requisition lines that need to be processed into a procurement document.

processRequest

Operation: /fscmRestApi/resources/11.13.18.05/requisitionProcessingRequests/{requisitionProcessingRequestsUniqID}/action/processRequest

Parameters:

• requisitionProcessingRequestsUniqID: $request.path.requisitionProcessingRequestsUniqID

Validates the requisition processing request and either creates a draft purchase order or an incomplete change order.

Back to Top

Examples

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/json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/requisitionProcessingRequests"

The following examples describe how to create a requisition-processing request. In addition to creating a request header, you can also specify request lines in a single payload.

Example Number	Description
Example 1	Create a requisition-processing request and specify a blanket purchase agreement to which the selected requisition lines should be sourced.
Example 2	Create a requisition-processing request that will group the requisition lines into a fewer purchase-order lines.
Example 3	Create a requisition-processing request providing the header ID of the draft purchase order for which the requisition line should be processed.
Example 4	Create a requisition-processing request and specify a contract purchase agreement to which the selected requisition lines should be sourced.

Example 1 Request Body

The following example includes the contents of the request body in JSON format to create a requisition-processing request from requisition lines awaiting processing. This example illustrates how requisition lines can be processed to a different agreement. Upon successful creation of the requisition-processing request, values for the following attributes are derived from the source agreement: Document Style, Supplier, Supplier Site, and Currency. This step is similar to adding requisition lines to the document builder online.

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.

{
    "ProcurementBU": "Vision Corporation",
    "RequisitioningBU": "Vision Corporation",
    "Type": "New Order",
    "SourceAgreement": "1002786",
    "lines": [
        {
            "RequisitionLineId": 300100542878086
        }
    ]
}

Example 1 Response Body

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

{
    "RequestHeaderId": 300100542879973,
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Corporation",
    "RequisitioningBUId": 204,
    "RequisitioningBU": "Vision Corporation",
    "Type": "New Order",
    "SoldToLegalEntityId": null,
    "SoldToLegalEntity": null,
    "SupplierId": 1716,
    "Supplier": "CV_SuppA06",
    "SupplierSiteId": 1716,
    "SupplierSite": "CVSuppA06Site01",
    "DocumentStyleId": 1,
    "DocumentStyle": "Purchase Order",
    "SourceAgreementId": 594310,
    "SourceAgreement": "1002786",
    "CurrencyCode": "USD",
    "Currency": "US Dollar",
    "ConversionRateTypeCode": null,
    "ConversionRateType": null,
    "ConversionRateDate": null,
    "ConversionRate": null,
    "BuyerId": null,
    "Buyer": null,
    "GroupRequisitionLines": null,
    "lines": [
        {
            "RequestLineId": 300100542879974,
            "RequestHeaderId": 300100542879973,
            "RequisitionLineId": 300100542878086,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542879973/child/lines/300100542879974",
                    "name": "lines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542879973/child/lines/300100542879974",
                    "name": "lines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542879973",
                    "name": "requisitionProcessingRequests",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542879973",
            "name": "requisitionProcessingRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542879973",
            "name": "requisitionProcessingRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542879973/child/lines",
            "name": "lines",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542879973/action/processRequest",
            "name": "processRequest",
            "kind": "other"
        }
    ]
}

Example 2 Request Body

The following example includes the contents of the request body in JSON format to create a requisition-processing request and consolidate the requisition lines into a single order line. The GroupRequisitionLines attribute determines whether each requisition line fulfilled in the document should have its own order line, or should be combined with other requisition lines.

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.

{
    "ProcurementBU": "Vision Corporation",
    "RequisitioningBU": "Vision Corporation",
    "Type": "New Order",
    "Supplier": "Tall Manufacturing",
    "SupplierSite": "New York",
    "GroupRequisitionLines": "Y",
    "lines": [
        {
            "RequisitionLineId": 300100542407035
        },
        {
            "RequisitionLineId": 300100542407037
        }
    ]
}

Example 2 Response Body

Here's an example of the response body in JSON format.

{
    "RequestHeaderId": 300100542745176,
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Corporation",
    "RequisitioningBUId": 204,
    "RequisitioningBU": "Vision Corporation",
    "Type": "New Order",
    "SoldToLegalEntityId": null,
    "SoldToLegalEntity": null,
    "SupplierId": 254,
    "Supplier": "Tall Manufacturing",
    "SupplierSiteId": 32,
    "SupplierSite": "New York",
    "DocumentStyleId": null,
    "DocumentStyle": null,
    "SourceAgreementId": null,
    "SourceAgreement": null,
    "CurrencyCode": null,
    "Currency": null,
    "ConversionRateTypeCode": null,
    "ConversionRateType": null,
    "ConversionRateDate": null,
    "ConversionRate": null,
    "BuyerId": null,
    "Buyer": null,
    "GroupRequisitionLines": "Y",
    "lines": [
        {
            "RequestLineId": 300100542745177,
            "RequestHeaderId": 300100542745176,
            "RequisitionLineId": 300100542407035,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176/child/lines/300100542745177",
                    "name": "lines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176/child/lines/300100542745177",
                    "name": "lines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176",
                    "name": "requisitionProcessingRequests",
                    "kind": "item"
                }
            ]
        },
        {
            "RequestLineId": 300100542745178,
            "RequestHeaderId": 300100542745176,
            "RequisitionLineId": 300100542407037,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176/child/lines/300100542745178",
                    "name": "lines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176/child/lines/300100542745178",
                    "name": "lines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176",
                    "name": "requisitionProcessingRequests",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176",
            "name": "requisitionProcessingRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176",
            "name": "requisitionProcessingRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176/child/lines",
            "name": "lines",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542745176/action/processRequest",
            "name": "processRequest",
            "kind": "other"
        }
    ]
}

Example 3 Request Body

The following example includes the contents of the request body in JSON format. This step is like adding requisition lines to the document builder online. In this example, you provide the header ID of the draft purchase order for which the requisition line should be processed.

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.

Here's an example of the request body in JSON format.

{ 
  "Type" : "Existing Order",
     "POHeaderId": 593296,
 
   "lines": [	
		{
			"RequisitionLineId": 300100551698198
			
		}
	]
 }

Example 3 Response Body

Here's an example of the response body in JSON format.

{
    "RequestHeaderId": 300100551759371,
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Corporation",
    "RequisitioningBUId": 204,
    "RequisitioningBU": "Vision Corporation",
    "Type": "Existing Order",
    "SoldToLegalEntityId": 204,
    "SoldToLegalEntity": "Vision Corporation",
    "SupplierId": 415,
    "Supplier": "CV_SuppA03",
    "SupplierSiteId": 2078,
    "SupplierSite": "05",
    "DocumentStyleId": 1,
    "DocumentStyle": "Purchase Order",
    "SourceAgreementId": null,
    "SourceAgreement": null,
    "CurrencyCode": "USD",
    "Currency": "US Dollar",
    "ConversionRateTypeCode": null,
    "ConversionRateType": null,
    "ConversionRateDate": null,
    "ConversionRate": null,
    "BuyerId": 100010026863783,
    "Buyer": "Furey,Clare",
    "GroupRequisitionLines": null,
    "OrderNumber": "1005382",
    "POHeaderId": 593296,
    "lines": [
        {
            "RequestLineId": 300100551759372,
            "RequestHeaderId": 300100551759371,
            "RequisitionLineId": 184414,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100551759371/child/lines/300100551759372",
                    "name": "lines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100551759371/child/lines/300100551759372",
                    "name": "lines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100551759371",
                    "name": "requisitionProcessingRequests",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100551759371",
            "name": "requisitionProcessingRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100551759371",
            "name": "requisitionProcessingRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100551759371/child/lines",
            "name": "lines",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100551759371/action/processRequest",
            "name": "processRequest",
            "kind": "other"
        }
    ]
}

Example 4 Request Body

The following example includes the contents of the request body in JSON format to create a requisition-processing request from requisition lines awaiting processing. This example illustrates how requisition lines can be processed by specifying a contract purchase agreement. After you successfully create the requisition-processing request, values for these attributes are derived from the source agreement: Document Style, Supplier, and Supplier Site. This step is similar to adding requisition lines to the document builder online. To create the purchase order, you need to submit the requisition-processing request.

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.

Note:

If you don't provide the currency while processing the request, the currency defaults from the requisition line when you submit the request.

Here's an example of the request body in JSON format.

{
    "ProcurementBU": "Vision Corporation",
    "RequisitioningBU": "Vision Corporation",
    "Type": "New Order",
    "SourceAgreement": "1000320",
    "lines": [
        {
            "RequisitionLineId": 300100562897853
        }
    ]
}

Example 4 Response Body

Here's an example of the response body in JSON format.

{
    "RequestHeaderId": 300100563068401,
    "ProcurementBUId": 204,
    "ProcurementBU": "Vision Corporation",
    "RequisitioningBUId": 204,
    "RequisitioningBU": "Vision Corporation",
    "Type": "New Order",
    "SoldToLegalEntityId": null,
    "SoldToLegalEntity": null,
    "SupplierId": 100000011547508,
    "Supplier": "cPO-Supplier09",
    "SupplierSiteId": 100000011547553,
    "SupplierSite": "cPO-SITE01",
    "DocumentStyleId": 1,
    "DocumentStyle": "Purchase Order",
    "SourceAgreementId": 100000012298234,
    "SourceAgreement": "1000320",
    "CurrencyCode": null,
    "Currency": null,
    "ConversionRateTypeCode": null,
    "ConversionRateType": null,
    "ConversionRateDate": null,
    "ConversionRate": null,
    "BuyerId": null,
    "Buyer": null,
    "GroupRequisitionLines": null,
    "OrderNumber": null,
    "POHeaderId": null,
    "lines": [
        {
            "RequestLineId": 300100563068402,
            "RequestHeaderId": 300100563068401,
            "RequisitionLineId": 100100867265689,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100563068401/child/lines/300100563068402",
                    "name": "lines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100563068401/child/lines/300100563068402",
                    "name": "lines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100563068401",
                    "name": "requisitionProcessingRequests",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100563068401",
            "name": "requisitionProcessingRequests",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100563068401",
            "name": "requisitionProcessingRequests",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100563068401/child/lines",
            "name": "lines",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100563068401/action/processRequest",
            "name": "processRequest",
            "kind": "other"
        }
    ]
}

Back to Top