Create requests
post
/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
Action(required): string
Maximum Length:
25Action to perform on the external purchase prices. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute. -
ApprovalRequiredFlag: boolean
Maximum Length:
25Default Value:falseContains one of the following values: true or false. If true, then the external purchase prices are created in the pending approval status. If false, then external purchase prices are created as approved. The default value is true. -
BatchId: number
Value that uniquely identifies the external purchase prices request batch.
-
CurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency of the external purchase prices. -
ErrorFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value. -
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the external purchase prices requests.
-
InterfaceHeaderKey(required): string
Maximum Length:
30Number that uniquely identifies the external purchase prices requests. -
lines: array
Lines
Title:
LinesThe Lines resource manages the external purchase prices request lines. -
LoadRequestId: number
Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.
-
ManufacturerName: string
Maximum Length:
700Name of the manufacturer. -
ManufacturerPartyId: integer
(int64)
Value that uniquely identifies the manufacturer.
-
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the requisitioning business unit.
-
RequisitioningBUName: string
Maximum Length:
240Name of the requisitioning business unit. -
Source: string
Maximum Length:
60Name of the person or organization in the source contract. -
SourceContractDescription: string
Maximum Length:
2000Description of the source contract. -
SourceContractEndDate(required): string
(date)
Date when the source contract becomes ineffective.
-
SourceContractNumber(required): string
Maximum Length:
120Number that uniquely identifies the source contract. -
SourceContractStartDate(required): string
(date)
Date when the source contract becomes effective.
-
SourceContractType: string
Maximum Length:
80Type of the source contract. -
SourceContractTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of the source contract. -
SourceOrganization: string
Maximum Length:
240Value that uniquely identifies the source organization. -
SourceReferenceId(required): string
Maximum Length:
30Value that uniquely identifies the external purchase prices in the source application. -
SourceType: string
Maximum Length:
60Source type of the contract. -
SourceVendor: string
Maximum Length:
360Value that uniquely identifies the source supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierNumber: string
Maximum Length:
30Number that uniquely identifies the supplier. -
SupplierSite: string
Maximum Length:
240Name of the supplier site. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
TierDescription: string
Maximum Length:
2000Description of the tier to which the source organization belongs. -
TierLevel: integer
(int64)
Number that indicates the tier to which the source organization belongs.
Nested Schema : Lines
Type:
arrayTitle:
LinesThe Lines resource manages the external purchase prices request lines.
Show Source
Nested Schema : externalPurchasePricesRequests-lines-item-post-request
Type:
Show Source
object-
Action: string
Maximum Length:
25Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute. -
AdjustedPrice: number
Value of the unit price after adjustment.
-
AdjustmentPercentage: number
Value by which the base price is adjusted.
-
BatchId: number
Value that uniquely identifies the external purchase prices request batch.
-
ErrorFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value. -
InterfaceHeaderKey: string
Maximum Length:
30Number that uniquely identifies the external purchase prices requests. -
InterfaceLineId: integer
(int64)
Value that uniquely identifies the request line.
-
InterfaceLineKey: string
Maximum Length:
30Number that uniquely identifies the request line. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemDescription: string
Maximum Length:
240Description of the item. -
ItemNumber: string
Maximum Length:
300Number that uniquely identifies the item. -
LineNumber: integer
(int64)
Number that uniquely identifies the external purchase prices line.
-
LoadRequestId: number
Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.
-
ManufacturerPartNumber: string
Maximum Length:
700Number that uniquely identifies the manufacturer part. -
ManufacturerTradingPartnerItemId: integer
(int64)
Value that uniquely identifies the manufacturer part.
-
Price: number
Value of the unit price before adjustment.
-
PriceEndDate: string
(date)
Date when the price becomes effective.
-
PriceStartDate: string
(date)
Date when the price becomes ineffective.
-
PurchasingCategoryCode: string
Maximum Length:
820Abbreviation that identifies the purchasing category of the manufacturer part. -
PurchasingCategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
SourcePurchasingCategory: string
Maximum Length:
700Name of the purchasing category of the manufacturer. -
SourceReferenceId: string
Maximum Length:
30Value that uniquely identifies the external purchase prices in the source system. -
SourceUnitOfMeasure: string
Maximum Length:
25Name of the source unit of measure. -
SourceUOMQuantity: number
Quantity of the source unit of measure.
-
UnitOfMeasure: string
Title:
UOM NameMaximum Length:25Name of the unit of measure. -
UnitOfMeasureCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure. -
VendorItemId: integer
(int64)
Value that uniquely identifies the supplier part.
-
VendorPartNumber: string
Maximum Length:
300Number that uniquely identifies the supplier part.
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.
Root Schema : externalPurchasePricesRequests-item-response
Type:
Show Source
object-
Action: string
Maximum Length:
25Action to perform on the external purchase prices. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute. -
ApprovalRequiredFlag: boolean
Maximum Length:
25Default Value:falseContains one of the following values: true or false. If true, then the external purchase prices are created in the pending approval status. If false, then external purchase prices are created as approved. The default value is true. -
BatchId: number
Value that uniquely identifies the external purchase prices request batch.
-
CurrencyCode: string
Maximum Length:
15Abbreviation that identifies the currency of the external purchase prices. -
ErrorFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value. -
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the external purchase prices requests.
-
InterfaceHeaderKey: string
Maximum Length:
30Number that uniquely identifies the external purchase prices requests. -
lines: array
Lines
Title:
LinesThe Lines resource manages the external purchase prices request lines. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadRequestId: number
Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.
-
ManufacturerName: string
Maximum Length:
700Name of the manufacturer. -
ManufacturerPartyId: integer
(int64)
Value that uniquely identifies the manufacturer.
-
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the requisitioning business unit.
-
RequisitioningBUName: string
Maximum Length:
240Name of the requisitioning business unit. -
Source: string
Maximum Length:
60Name of the person or organization in the source contract. -
SourceContractDescription: string
Maximum Length:
2000Description of the source contract. -
SourceContractEndDate: string
(date)
Date when the source contract becomes ineffective.
-
SourceContractNumber: string
Maximum Length:
120Number that uniquely identifies the source contract. -
SourceContractStartDate: string
(date)
Date when the source contract becomes effective.
-
SourceContractType: string
Maximum Length:
80Type of the source contract. -
SourceContractTypeCode: string
Maximum Length:
30Abbreviation that identifies the type of the source contract. -
SourceOrganization: string
Maximum Length:
240Value that uniquely identifies the source organization. -
SourceReferenceId: string
Maximum Length:
30Value that uniquely identifies the external purchase prices in the source application. -
SourceType: string
Maximum Length:
60Source type of the contract. -
SourceVendor: string
Maximum Length:
360Value that uniquely identifies the source supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierNumber: string
Maximum Length:
30Number that uniquely identifies the supplier. -
SupplierSite: string
Maximum Length:
240Name of the supplier site. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
TierDescription: string
Maximum Length:
2000Description of the tier to which the source organization belongs. -
TierLevel: integer
(int64)
Number that indicates the tier to which the source organization belongs.
Nested Schema : Lines
Type:
arrayTitle:
LinesThe Lines resource manages the external purchase prices request lines.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : externalPurchasePricesRequests-lines-item-response
Type:
Show Source
object-
Action: string
Maximum Length:
25Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute. -
AdjustedPrice: number
Value of the unit price after adjustment.
-
AdjustmentPercentage: number
Value by which the base price is adjusted.
-
BatchId: number
Value that uniquely identifies the external purchase prices request batch.
-
ErrorFlag: boolean
Maximum Length:
1Default Value:falseContains one of the following values: true or false. If true, then an error exists in the external purchase prices requests. If false, then no error exists and the external purchase prices are imported successfully. This attribute doesn't have a default value. -
InterfaceHeaderKey: string
Maximum Length:
30Number that uniquely identifies the external purchase prices requests. -
InterfaceLineId: integer
(int64)
Value that uniquely identifies the request line.
-
InterfaceLineKey: string
Maximum Length:
30Number that uniquely identifies the request line. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemDescription: string
Maximum Length:
240Description of the item. -
ItemNumber: string
Maximum Length:
300Number that uniquely identifies the item. -
LineNumber: integer
(int64)
Number that uniquely identifies the external purchase prices line.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LoadRequestId: number
Value that uniquely identifies the process that loaded the external purchase prices request data to the interface tables.
-
ManufacturerPartNumber: string
Maximum Length:
700Number that uniquely identifies the manufacturer part. -
ManufacturerTradingPartnerItemId: integer
(int64)
Value that uniquely identifies the manufacturer part.
-
Price: number
Value of the unit price before adjustment.
-
PriceEndDate: string
(date)
Date when the price becomes effective.
-
PriceStartDate: string
(date)
Date when the price becomes ineffective.
-
PurchasingCategoryCode: string
Maximum Length:
820Abbreviation that identifies the purchasing category of the manufacturer part. -
PurchasingCategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
SourcePurchasingCategory: string
Maximum Length:
700Name of the purchasing category of the manufacturer. -
SourceReferenceId: string
Maximum Length:
30Value that uniquely identifies the external purchase prices in the source system. -
SourceUnitOfMeasure: string
Maximum Length:
25Name of the source unit of measure. -
SourceUOMQuantity: number
Quantity of the source unit of measure.
-
UnitOfMeasure: string
Title:
UOM NameMaximum Length:25Name of the unit of measure. -
UnitOfMeasureCode: string
Maximum Length:
3Abbreviation that identifies the unit of measure. -
VendorItemId: integer
(int64)
Value that uniquely identifies the supplier part.
-
VendorPartNumber: string
Maximum Length:
300Number that uniquely identifies the supplier part.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- lines
-
Operation: /fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/{InterfaceHeaderId}/child/linesParameters:
- InterfaceHeaderId:
$request.path.InterfaceHeaderId
The Lines resource manages the external purchase prices request lines. - InterfaceHeaderId:
Examples
Example 1: Create a Header and Lines for New External Purchase Prices
This example describes how to create header and lines for new external purchase prices.
Example 1 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.batch+json" -d 'request payload' server:port/fscmRestApi/resources/version
Example 1 Request Body
The following example includes the contents of the request body in JSON format.
{
"parts": [
{
"id": "part1",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload": {
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000001",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "GPO-10000",
"SourceContractDescription": "GPO Contract for Vision Operations for the year 2021.",
"SourceContractType": "GPO",
"SourceType": "GPO-Regional",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000001",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1001",
"Price": 12.50,
"AdjustmentPercentage": 20,
"AdjustedPrice": 10,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1002",
"Price": 25,
"AdjustmentPercentage": 20,
"AdjustedPrice": 20,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1003",
"Price": 37.50,
"AdjustmentPercentage": 20,
"AdjustedPrice": 30,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 50 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1004",
"Price": 50.00,
"AdjustmentPercentage": 20,
"AdjustedPrice": 40,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 25 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1005",
"Price": 62.50,
"AdjustmentPercentage": 20,
"AdjustedPrice": 50,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Methotrexate 7.5 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
},
{ "id": "part2",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000002",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000002",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1001",
"AdjustedPrice": 12,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1002",
"AdjustedPrice": 22,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1003",
"AdjustedPrice": 32,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 50 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1004",
"AdjustedPrice": 42,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 25 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1005",
"AdjustedPrice": 52,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Methotrexate 7.5 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
},
{ "id": "part3",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000003",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000003",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1001",
"AdjustedPrice": 15,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1002",
"AdjustedPrice": 25,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1003",
"AdjustedPrice": 35,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Methotrexate 7.5 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
}
]
}Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{
"parts": [
{
"id": "part1",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload": {
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000001",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "GPO-10000",
"SourceContractDescription": "GPO Contract for Vision Operations for the year 2021.",
"SourceContractType": "GPO",
"SourceType": "GPO-Regional",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000001",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1001",
"Price": 12.50,
"AdjustmentPercentage": 20,
"AdjustedPrice": 10,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1002",
"Price": 25,
"AdjustmentPercentage": 20,
"AdjustedPrice": 20,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1003",
"Price": 37.50,
"AdjustmentPercentage": 20,
"AdjustedPrice": 30,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 50 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1004",
"Price": 50.00,
"AdjustmentPercentage": 20,
"AdjustedPrice": 40,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 25 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1005",
"Price": 62.50,
"AdjustmentPercentage": 20,
"AdjustedPrice": 50,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Methotrexate 7.5 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
},
{ "id": "part2",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000002",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000002",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1001",
"AdjustedPrice": 12,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1002",
"AdjustedPrice": 22,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1003",
"AdjustedPrice": 32,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 50 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1004",
"AdjustedPrice": 42,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"ItemDescription": "Diclofenac Injection 25 ml",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1005",
"AdjustedPrice": 52,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Methotrexate 7.5 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
},
{ "id": "part3",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000003",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000003",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1001",
"AdjustedPrice": 15,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1002",
"AdjustedPrice": 25,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CREATE",
"ManufacturerPartNumber": "MPN-1003",
"AdjustedPrice": 35,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Methotrexate 7.5 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
}
]
}
Example 2: Creating a Header Only for New External Purchase Prices
This example describes how to create a header only for new external purchase prices.
Example 2 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.batch+json" -d 'request payload' server:port/fscmRestApi/resources/version
Example 2 Request Body
The following example includes the contents of the request body in JSON format.
{
"parts": [
{
"id": "part1",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload": {
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000001",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "GPO-10000",
"SourceContractDescription": "GPO Contract for Vision Operations for the year 2021.",
"SourceContractType": "GPO",
"SourceType": "GPO-Regional",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000001",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)"
}
},
{ "id": "part2",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000002",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000002",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)"
}
},
{ "id": "part3",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "CREATE",
"BatchId": "1347",
"SourceReferenceId": "1000000003",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000003",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)"
}
}
]
}
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{
"parts": [
{
"id": "part1",
"path": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests",
"operation": "create",
"payload": {
"InterfaceHeaderId": 300100556739490,
"InterfaceHeaderKey": "300100556739490",
"SourceReferenceId": "1000000001",
"Action": "CREATE",
"ApprovalRequiredFlag": true,
"SourceOrganization": "2000000001",
"RequisitioningBUId": null,
"RequisitioningBUName": null,
"SourceContractNumber": "GPO-10000",
"SourceContractDescription": "GPO Contract for Vision Operations for the year 2021.",
"SourceContractType": "GPO",
"SourceContractTypeCode": "ORA_SCH_EPP_GPO",
"SourceType": "GPO-Regional",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"ManufacturerPartyId": null,
"SourceVendor": "3000000001",
"SupplierId": null,
"SupplierNumber": null,
"SupplierSiteId": null,
"SupplierSite": null,
"CurrencyCode": "USD",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"ErrorFlag": false,
"BatchId": 1347,
"LoadRequestId": null,
"links": [
{
"rel": "self",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739490",
"name": "externalPurchasePricesRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739490",
"name": "externalPurchasePricesRequests",
"kind": "item"
},
{
"rel": "child",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739490/child/lines",
"name": "lines",
"kind": "collection"
}
]
}
},
{
"id": "part2",
"path": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests",
"operation": "create",
"payload": {
"InterfaceHeaderId": 300100556739491,
"InterfaceHeaderKey": "300100556739491",
"SourceReferenceId": "1000000002",
"Action": "CREATE",
"ApprovalRequiredFlag": true,
"SourceOrganization": "2000000001",
"RequisitioningBUId": null,
"RequisitioningBUName": null,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceContractTypeCode": "ORA_SCH_EPP_LOCAL",
"SourceType": "Local-Government",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"ManufacturerPartyId": null,
"SourceVendor": "3000000002",
"SupplierId": null,
"SupplierNumber": null,
"SupplierSiteId": null,
"SupplierSite": null,
"CurrencyCode": "USD",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"ErrorFlag": false,
"BatchId": 1347,
"LoadRequestId": null,
"links": [
{
"rel": "self",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739491",
"name": "externalPurchasePricesRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739491",
"name": "externalPurchasePricesRequests",
"kind": "item"
},
{
"rel": "child",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739491/child/lines",
"name": "lines",
"kind": "collection"
}
]
}
},
{
"id": "part3",
"path": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests",
"operation": "create",
"payload": {
"InterfaceHeaderId": 300100556739492,
"InterfaceHeaderKey": "300100556739492",
"SourceReferenceId": "1000000003",
"Action": "CREATE",
"ApprovalRequiredFlag": true,
"SourceOrganization": "2000000001",
"RequisitioningBUId": null,
"RequisitioningBUName": null,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceContractTypeCode": "ORA_SCH_EPP_LOCAL",
"SourceType": "Local-Government",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"ManufacturerPartyId": null,
"SourceVendor": "3000000003",
"SupplierId": null,
"SupplierNumber": null,
"SupplierSiteId": null,
"SupplierSite": null,
"CurrencyCode": "USD",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"ErrorFlag": false,
"BatchId": 1347,
"LoadRequestId": null,
"links": [
{
"rel": "self",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739492",
"name": "externalPurchasePricesRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739492",
"name": "externalPurchasePricesRequests",
"kind": "item"
},
{
"rel": "child",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739492/child/lines",
"name": "lines",
"kind": "collection"
}
]
}
}
]
}
Example 3: Create a Header and Lines for Updating Existing External Purchase Prices or Lines
This example describes how to create a header and lines for updating existing external purchase prices or lines.
Example 3 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.batch+json" -d 'request payload' server:port/fscmRestApi/resources/version
Example 3 Request Body
The following example includes the contents of the request body in JSON format.
{
"parts": [
{
"id": "part1",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload": {
"Action": "UPDATE",
"BatchId": "1347",
"SourceReferenceId": "1000000001",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "GPO-10000",
"SourceContractDescription": "GPO Contract for Vision Operations for the year 2021.",
"SourceContractType": "GPO",
"SourceType": "GPO-Regional",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000001",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 4,
"TierDescription": "TIER 4: >=$600,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)"
}
},
{ "id": "part2",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "UPDATE",
"BatchId": "1347",
"SourceReferenceId": "1000000002",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000002",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "UPDATE",
"ManufacturerPartNumber": "MPN-1001",
"AdjustedPrice": 17,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "UPDATE",
"ManufacturerPartNumber": "MPN-1002",
"AdjustedPrice": 27,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
}
]
}
Example 3 Response Body
The following example includes the contents of the response body in JSON format:
{
"parts": [
{
"id": "part1",
"path": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests",
"operation": "create",
"payload": {
"InterfaceHeaderId": 300100556739457,
"InterfaceHeaderKey": "300100556739457",
"SourceReferenceId": "1000000001",
"Action": "UPDATE",
"ApprovalRequiredFlag": true,
"SourceOrganization": "2000000001",
"RequisitioningBUId": null,
"RequisitioningBUName": null,
"SourceContractNumber": "GPO-10000",
"SourceContractDescription": "GPO Contract for Vision Operations for the year 2021.",
"SourceContractType": "GPO",
"SourceContractTypeCode": "ORA_SCH_EPP_GPO",
"SourceType": "GPO-Regional",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"ManufacturerPartyId": null,
"SourceVendor": "3000000001",
"SupplierId": null,
"SupplierNumber": null,
"SupplierSiteId": null,
"SupplierSite": null,
"CurrencyCode": "USD",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"TierLevel": 4,
"TierDescription": "TIER 4: >=$600,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"ErrorFlag": false,
"BatchId": 1347,
"LoadRequestId": null,
"links": [
{
"rel": "self",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739457",
"name": "externalPurchasePricesRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739457",
"name": "externalPurchasePricesRequests",
"kind": "item"
},
{
"rel": "child",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739457/child/lines",
"name": "lines",
"kind": "collection"
}
]
}
},
{
"id": "part2",
"path": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests",
"operation": "create",
"payload": {
"InterfaceHeaderId": 300100556739458,
"InterfaceHeaderKey": "300100556739458",
"SourceReferenceId": "1000000002",
"Action": "UPDATE",
"ApprovalRequiredFlag": true,
"SourceOrganization": "2000000001",
"RequisitioningBUId": null,
"RequisitioningBUName": null,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceContractTypeCode": "ORA_SCH_EPP_LOCAL",
"SourceType": "Local-Government",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"ManufacturerPartyId": null,
"SourceVendor": "3000000002",
"SupplierId": null,
"SupplierNumber": null,
"SupplierSiteId": null,
"SupplierSite": null,
"CurrencyCode": "USD",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"ErrorFlag": false,
"BatchId": 1347,
"LoadRequestId": null,
"lines": [
{
"InterfaceLineId": 300100556739459,
"InterfaceLineKey": "300100556739459",
"InterfaceHeaderKey": "300100556739458",
"SourceReferenceId": "1000000002",
"LineNumber": null,
"Action": "UPDATE",
"VendorPartNumber": null,
"VendorItemId": null,
"ItemNumber": null,
"InventoryItemId": null,
"ManufacturerPartNumber": "MPN-1001",
"ManufacturerTradingPartnerItemId": null,
"Price": null,
"AdjustmentPercentage": null,
"AdjustedPrice": 17,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"UnitOfMeasure": null,
"UnitOfMeasureCode": null,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PurchasingCategoryId": null,
"PurchasingCategoryCode": null,
"SourcePurchasingCategory": null,
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31",
"ErrorFlag": false,
"BatchId": null,
"LoadRequestId": null,
"links": [
{
"rel": "self",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458/child/lines/300100556739459",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458/child/lines/300100556739459",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458",
"name": "externalPurchasePricesRequests",
"kind": "item"
}
]
},
{
"InterfaceLineId": 300100556739460,
"InterfaceLineKey": "300100556739460",
"InterfaceHeaderKey": "300100556739458",
"SourceReferenceId": "1000000002",
"LineNumber": null,
"Action": "UPDATE",
"VendorPartNumber": null,
"VendorItemId": null,
"ItemNumber": null,
"InventoryItemId": null,
"ManufacturerPartNumber": "MPN-1002",
"ManufacturerTradingPartnerItemId": null,
"Price": null,
"AdjustmentPercentage": null,
"AdjustedPrice": 27,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"UnitOfMeasure": null,
"UnitOfMeasureCode": null,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PurchasingCategoryId": null,
"PurchasingCategoryCode": null,
"SourcePurchasingCategory": null,
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31",
"ErrorFlag": false,
"BatchId": null,
"LoadRequestId": null,
"links": [
{
"rel": "self",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458/child/lines/300100556739460",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458/child/lines/300100556739460",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458",
"name": "externalPurchasePricesRequests",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458",
"name": "externalPurchasePricesRequests",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458",
"name": "externalPurchasePricesRequests",
"kind": "item"
},
{
"rel": "child",
"href": "server:port/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739458/child/lines",
"name": "lines",
"kind": "collection"
}
]
}
}
]
}
Example 4: Create a Header and Lines for Canceling Existing External Purchase Prices or Lines
This example describes how to create a header and lines for canceling existing external purchase prices or lines.
Example 4 cURL Command
Use the following cURL command to submit a request on the REST resource.
Example 4 Request Body
The following example includes the contents of the request body in JSON format.
{
"parts": [
{
"id": "part1",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload": {
"Action": "CANCEL",
"BatchId": "1347",
"SourceReferenceId": "1000000001",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "GPO-10000",
"SourceContractDescription": "GPO Contract for Vision Operations for the year 2021.",
"SourceContractType": "GPO",
"SourceType": "GPO-Regional",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000001",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 4,
"TierDescription": "TIER 4: >=$600,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)"
}
},
{ "id": "part2",
"path": "/externalPurchasePricesRequests/",
"operation": "create",
"payload":
{
"Action": "UPDATE",
"BatchId": "1347",
"SourceReferenceId": "1000000002",
"ApprovalRequiredFlag": true,
"SourceContractNumber": "Local-10000",
"SourceContractDescription": "Local Contract for Vision Operations for the year 2021.",
"SourceContractType": "Local",
"SourceType": "Local-Government",
"SourceOrganization": "2000000001",
"Source": "Cardio Healthcare",
"ManufacturerName": "Axon Medicals",
"SourceVendor": "3000000002",
"SourceContractStartDate": "2021-01-01",
"SourceContractEndDate": "2021-12-31",
"CurrencyCode": "USD",
"TierLevel": 3,
"TierDescription": "TIER 3: >=$400,000 OR Academic Health System (as defined on Membership Roster) Total Product Purchases ($Per Calendar Year)",
"lines": [
{
"Action": "CANCEL",
"ManufacturerPartNumber": "MPN-1001",
"AdjustedPrice": 17,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 50 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
},
{
"Action": "CANCEL",
"ManufacturerPartNumber": "MPN-1002",
"AdjustedPrice": 27,
"SourceUnitOfMeasure": "Box",
"SourceUOMQuantity": 20,
"ItemDescription": "Diclofenac Tablet 25 mg",
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31"
}
]
}
}
]
}
Example 4 Response Body
The following example includes the contents of the response body in JSON format:
{
"InterfaceLineId": 300100556739608,
"InterfaceLineKey": "300100556739608",
"InterfaceHeaderKey": "300100556739393",
"SourceReferenceId": "1000000002",
"LineNumber": null,
"Action": "CREATE",
"VendorPartNumber": null,
"VendorItemId": null,
"ItemNumber": null,
"InventoryItemId": null,
"ManufacturerPartNumber": "MPN-1005",
"ManufacturerTradingPartnerItemId": null,
"Price": 50,
"AdjustmentPercentage": 20,
"AdjustedPrice": 40,
"SourceUnitOfMeasure": "Each",
"SourceUOMQuantity": 1,
"UnitOfMeasure": null,
"UnitOfMeasureCode": null,
"ItemDescription": "Methotrexate 7.5 mg",
"PurchasingCategoryId": null,
"PurchasingCategoryCode": null,
"SourcePurchasingCategory": null,
"PriceStartDate": "2021-01-01",
"PriceEndDate": "2021-12-31",
"ErrorFlag": false,
"BatchId": null,
"LoadRequestId": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines/300100556739608",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393/child/lines/300100556739608",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/11.13.18.05/externalPurchasePricesRequests/300100556739393",
"name": "externalPurchasePricesRequests",
"kind": "item"
}
]
}