Update one line
/fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/child/fiscalDocumentLines/{fiscalDocumentLinesUniqID}
Request
-
DocumentId(required): integer(int64)
Value that uniquely identifies the inbound fiscal document.
-
fiscalDocumentLinesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Fiscal Document Lines resource and used to uniquely identify an instance of Fiscal Document Lines. The client should not generate the hash key value. Instead, the client should query on the Fiscal Document Lines collection resource in order to navigate to a specific instance of Fiscal Document Lines to get the hash key.
-
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.
- application/json
object
-
fiscalDocumentSchedules: array
Fiscal Document Schedules
Title:
Fiscal Document Schedules
The Fiscal Document Schedules resource gets the schedule information of the fiscal document. -
PhysicalReceiptQuantity: number
Title:
Delivered Quantity
Quantity that was physically received. -
SecondaryQuantity: number
Title:
Secondary Quantity
Indicates the quantity in the secondary unit of measure for a dual-UOM-controlled item. -
Status: string
Title:
Status
Maximum Length:30
Status of the fiscal document line.
array
Fiscal Document Schedules
object
-
AllocatedQuantity: number
Title:
Allocated Quantity
Allocated quantity on the fiscal document schedule. -
AllocatedQuantityInFiscalDocumentLineUOM: number
Title:
Allocated Quantity
Source document quantity allocated on a fiscal document schedule in the fiscal document unit of measure of the item line. -
AllocatedQuantityInSecondaryUOM: number
Title:
Secondary Quantity
Source document quantity allocated on a fiscal document schedule in the secondary unit of measure of the item. -
ASNLineNumber: string
Title:
ASN Line Number
Maximum Length:80
Advanced shipment notice line associated with the drop ship seller flow. -
ConsumptionAdviceLine: string
Title:
Consumption Advice Line Number
Maximum Length:80
Consumption advice line number associated with the consigned fiscal flow. -
DocumentId: integer
(int64)
Title:
Document ID
Value that uniquely identifies the inbound fiscal document. -
LineId: integer
(int64)
Title:
Document Line ID
Value that uniquely identifies the fiscal document line. -
ReceiptLineNumber: integer
Title:
Receipt Line
Line number of the physical receipt. -
ReceiptNumber: string
Title:
Receipt Number
Maximum Length:30
Number that identifies the purchase order receipt. -
SalesReturnOrderLine: string
Title:
Sales Return Order Line
Maximum Length:30
Number that identifies the line of a return order. -
SalesReturnOrderNumber: string
Title:
Sales Return Order Number
Maximum Length:30
Number that identifies the return order. -
SalesReturnOrderSchedule: string
Title:
Sales Return Order Schedule
Maximum Length:30
Number that identifies the schedule of a return order. -
ScheduleId: integer
(int64)
Title:
Schedule ID
Value that uniquely identifies the fiscal document schedule. -
ScheduleNumber: number
Title:
Schedule Number
Number that identifies the schedule of the fiscal document item line. -
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:30
Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
ShipmentLine: string
Title:
Shipment Line
Maximum Length:30
Number that identifies the line of a shipment. -
ShipmentNumber: string
Title:
Shipment Number
Maximum Length:30
Number that identifies the shipment. -
SourceDocumentCurrencyCode: string
Title:
Source Document Currency Code
Maximum Length:30
Code that identifies the currency of the source document. -
SourceDocumentId: integer
(int64)
Title:
Source Document ID
Value that uniquely identifies the source document of the schedule. -
SourceDocumentLineId: integer
(int64)
Title:
Source Document Line ID
Value that uniquely identifies the source document line of the schedule. -
SourceDocumentPrice: number
Title:
Source Document Price
Price of the item that is taken from the source document. -
SourceDocumentScheduleId: integer
(int64)
Title:
Source Document Schedule ID
Value that uniquely identifies the source document schedule of the schedule. -
SourceDocumentTypeCode: string
Title:
Source Document Type Code
Maximum Length:30
Default Value:PURCHASE_ORDER
Code that identifies the document type that acts as source for the fiscal document that is captured or created. -
SourceDocumentUOMCode: string
Title:
Source Document UOM Code
Maximum Length:30
Code that identifies the unit of measure of the source document. -
SourceReferenceDocumentLineId: integer
(int64)
Value that uniquely identifies the reference source document line.
Response
- application/json
Default Response
-
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.
object
-
Amount: number
Title:
Amount
Read Only:true
Amount on the fiscal document item line. -
ChargesAmount: number
Title:
Charges
Read Only:true
Unit price of goods or services. -
DocumentId: integer
(int64)
Title:
Document ID
Read Only:true
Value that uniquely identifies the inbound fiscal document. -
ExternalItem: string
Title:
External Item
Read Only:true
Maximum Length:300
Indicates the name of the item given on the fiscal document sent by the issuer. -
ExternalItemDescription: string
Title:
Description
Read Only:true
Maximum Length:250
Indicates the description of the item given on the fiscal document sent by the issuer. -
FciControlNumber: string
Title:
FCI Number
Read Only:true
Maximum Length:36
Displays the FCI Number for imported products that are subject to industrial processing on the fiscal document line. -
fiscalDocumentSchedules: array
Fiscal Document Schedules
Title:
Fiscal Document Schedules
The Fiscal Document Schedules resource gets the schedule information of the fiscal document. -
InventoryItemDescription: string
Title:
Item Description
Read Only:true
Description of the item on the fiscal document line. -
InventoryItemId: integer
(int64)
Title:
Item ID
Read Only:true
Value that uniquely identifies the item. -
InventoryItemNumber: string
Title:
Item Code
Read Only:true
Maximum Length:80
Number that identifies the item on the fiscal document line. -
LineId: integer
(int64)
Title:
Document Line ID
Read Only:true
Value that uniquely identifies the fiscal document line. -
LineNumber: number
Title:
Line Number
Read Only:true
Number that identifies the line of the fiscal document item. -
LineSourceDocumentType: string
Title:
Source Document Type
Read Only:true
Maximum Length:255
Type of the fiscal document sent by supplier or party. -
LineSourceDocumentTypeCode: string
Title:
Source Document Type Code
Read Only:true
Maximum Length:30
Code that identifies the document type that acts as source for the fiscal document that is captured or created. -
LineStatus: string
Title:
Status Code
Read Only:true
Maximum Length:30
Default Value:NEW
Status of the item line. This value is generated by the application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhysicalReceiptDate: string
(date)
Title:
Physical Receipt Date
Read Only:true
Date when goods or service are physically received. -
PhysicalReceiptQuantity: number
Title:
Delivered Quantity
Quantity that was physically received. -
Price: number
Title:
Unit Price
Read Only:true
Unit price of goods or services. -
Quantity: number
Title:
Quantity
Read Only:true
Quantity on the fiscal document line. -
SecondaryQuantity: number
Title:
Secondary Quantity
Indicates the quantity in the secondary unit of measure for a dual-UOM-controlled item. -
SecondaryUOMCode: string
Title:
Secondary UOM
Read Only:true
Maximum Length:30
Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
SecondaryUOMName: string
Title:
Secondary UOM
Read Only:true
Maximum Length:25
Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
SourceDocumentBUId: integer
(int64)
Title:
Source Document BU ID
Read Only:true
Value that uniquely identifies the source document business unit. -
SourceDocumentBUName: string
Title:
Source Document BU
Read Only:true
Maximum Length:255
Name of the business unit for the source document. Valid values are Procurement BU, Requisition BU, or Receivable BU. -
Status: string
Title:
Status
Maximum Length:30
Status of the fiscal document line. -
Type: string
Title:
Line Type
Read Only:true
Maximum Length:255
Type of line on the fiscal document. -
TypeCode: string
Title:
Type Code
Read Only:true
Maximum Length:30
Code that identifies the type of line on the fiscal document. -
UOMCode: string
Title:
UOM Code
Read Only:true
Maximum Length:30
Code that identifies the unit of measure of the item quantity that was physically received. -
UOMName: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Name of the base unit of measure to be used where allocation basis is quantity, weight, or volume.
array
Fiscal Document Schedules
array
Links
object
-
AllocatedQuantity: number
Title:
Allocated Quantity
Allocated quantity on the fiscal document schedule. -
AllocatedQuantityInFiscalDocumentLineUOM: number
Title:
Allocated Quantity
Source document quantity allocated on a fiscal document schedule in the fiscal document unit of measure of the item line. -
AllocatedQuantityInSecondaryUOM: number
Title:
Secondary Quantity
Source document quantity allocated on a fiscal document schedule in the secondary unit of measure of the item. -
ASNLineNumber: string
Title:
ASN Line Number
Maximum Length:80
Advanced shipment notice line associated with the drop ship seller flow. -
ConsumptionAdviceLine: string
Title:
Consumption Advice Line Number
Maximum Length:80
Consumption advice line number associated with the consigned fiscal flow. -
DocumentId: integer
(int64)
Title:
Document ID
Value that uniquely identifies the inbound fiscal document. -
ItemDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Indicates the description of the item. -
LineId: integer
(int64)
Title:
Document Line ID
Value that uniquely identifies the fiscal document line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
POLineNumber: number
Title:
PO Line Number
Read Only:true
Number that identifies the line of the purchase order. -
PONumber: string
Title:
PO Number
Read Only:true
Maximum Length:30
Number that identifies the purchase order. -
POScheduleNumber: number
Title:
PO Schedule Number
Read Only:true
Number that identifies the schedule of the purchase order. -
PricingUOMCode: string
Title:
Pricing UOM
Read Only:true
Maximum Length:3
Indicates the UOM code in which the price of the item in the source document is shown. -
PricingUOMName: string
Title:
Pricing UOM
Read Only:true
Maximum Length:255
Indicates the unit of measure in which the price of the item in the source document is shown. -
PromisedDate: string
(date-time)
Title:
Promised Delivery Date
Read Only:true
Date when the materials are promised to be delivered. -
ReceiptLineNumber: integer
Title:
Receipt Line
Line number of the physical receipt. -
ReceiptNumber: string
Title:
Receipt Number
Maximum Length:30
Number that identifies the purchase order receipt. -
SalesReturnOrderLine: string
Title:
Sales Return Order Line
Maximum Length:30
Number that identifies the line of a return order. -
SalesReturnOrderNumber: string
Title:
Sales Return Order Number
Maximum Length:30
Number that identifies the return order. -
SalesReturnOrderSchedule: string
Title:
Sales Return Order Schedule
Maximum Length:30
Number that identifies the schedule of a return order. -
ScheduleId: integer
(int64)
Title:
Schedule ID
Value that uniquely identifies the fiscal document schedule. -
ScheduleNumber: number
Title:
Schedule Number
Number that identifies the schedule of the fiscal document item line. -
SecondaryUOMCode: string
Title:
Secondary UOM
Maximum Length:30
Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
SecondaryUOMName: string
Title:
Secondary UOM
Read Only:true
Maximum Length:25
Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item. -
ShipmentLine: string
Title:
Shipment Line
Maximum Length:30
Number that identifies the line of a shipment. -
ShipmentNumber: string
Title:
Shipment Number
Maximum Length:30
Number that identifies the shipment. -
SourceDocumentCurrencyCode: string
Title:
Source Document Currency Code
Maximum Length:30
Code that identifies the currency of the source document. -
SourceDocumentCurrencyName: string
Title:
Source Document Currency
Read Only:true
Maximum Length:255
Name of the currency of the item that is taken from the source document. -
SourceDocumentId: integer
(int64)
Title:
Source Document ID
Value that uniquely identifies the source document of the schedule. -
SourceDocumentLineId: integer
(int64)
Title:
Source Document Line ID
Value that uniquely identifies the source document line of the schedule. -
SourceDocumentPrice: number
Title:
Source Document Price
Price of the item that is taken from the source document. -
SourceDocumentScheduleId: integer
(int64)
Title:
Source Document Schedule ID
Value that uniquely identifies the source document schedule of the schedule. -
SourceDocumentType: string
Title:
Source Document Type
Read Only:true
Maximum Length:255
Type of document for which the fiscal document is captured or created. -
SourceDocumentTypeCode: string
Title:
Source Document Type Code
Maximum Length:30
Default Value:PURCHASE_ORDER
Code that identifies the document type that acts as source for the fiscal document that is captured or created. -
SourceDocumentUOMCode: string
Title:
Source Document UOM Code
Maximum Length:30
Code that identifies the unit of measure of the source document. -
SourceDocumentUOMName: string
Title:
Source Document UOM
Read Only:true
Maximum Length:255
Name of the unit of measure of the source document. -
SourceReferenceDocumentLineId: integer
(int64)
Value that uniquely identifies the reference source document line.
-
SupplierItem: string
Title:
Supplier Item
Read Only:true
Maximum Length:300
Indicates the supplier's identification number or code for the goods ordered on the source document order line.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
- fiscalDocumentSchedules
-
Parameters:
- DocumentId:
$request.path.DocumentId
- fiscalDocumentLinesUniqID:
$request.path.fiscalDocumentLinesUniqID
The Fiscal Document Schedules resource gets the schedule information of the fiscal document. - DocumentId:
Examples
This example describes how to update a line.
Example 1 cURL Command
Use the following cURL command to submit a request on the REST resource to update the deliviered quantity for a fiscal document line.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849"
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "PhysicalReceiptQuantity":"1002" }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "DocumentId": 300100123926847, "LineId": 300100123926849, "LineNumber": 1, "LineSourceDocumentTypeCode": "PURCHASE_ORDER", "LineSourceDocumentType": "Purchase order", "SourceDocumentBUId": 300100052386093, "SourceDocumentBUName": "Vision Brazil", "InventoryItemId": 300100068025065, "InventoryItemNumber": "BR03", "InventoryItemDescription": "Brazil Purchased Item 03", "TypeCode": "GOODS", "Type": "Goods", "Quantity": 1, "PhysicalReceiptQuantity": 1002, "PhysicalReceiptDate": "2017-09-25", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 100, "ChargesAmount": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] }
Example 2 cURL Command
Use the following cURL command to submit a request on the REST resource to update the delivered quantity for multiple fiscal document lines at a time as a batch.
curl -X POST -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version"
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{ "parts":[ { "id": "part1", "path": "/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849", "operation": "update", "payload": {"PhysicalReceiptQuantity" : 1004} }, { "id": "part2", "path": "/inboundFiscalDocuments/300100170578288/child/fiscalDocumentLines/300100170578290", "operation": "update", "payload": {"PhysicalReceiptQuantity" : "5"} } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "parts": [ { "id": "part1", "path": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849", "operation": "update", "payload": { "DocumentId": 300100123926847, "LineId": 300100123926849, "LineNumber": 1, "LineSourceDocumentTypeCode": "PURCHASE_ORDER", "LineSourceDocumentType": "Purchase order", "SourceDocumentBUId": 300100052386093, "SourceDocumentBUName": "Vision Brazil", "InventoryItemId": 300100068025065, "InventoryItemNumber": "BR03", "InventoryItemDescription": "Brazil Purchased Item 03", "TypeCode": "GOODS", "Type": "Goods", "Quantity": 1, "PhysicalReceiptQuantity": 1004, "PhysicalReceiptDate": "2017-09-25", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 100, "ChargesAmount": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100123926847/child/fiscalDocumentLines/300100123926849/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } }, { "id": "part2", "path": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100170578288/child/fiscalDocumentLines/300100170578290", "operation": "update", "payload": { "DocumentId": 300100170578288, "LineId": 300100170578290, "LineNumber": 1, "LineSourceDocumentTypeCode": "PURCHASE_ORDER", "LineSourceDocumentType": "Purchase order", "SourceDocumentBUId": 300100052386093, "SourceDocumentBUName": "Vision Brazil", "InventoryItemId": 300100068025061, "InventoryItemNumber": "BR01", "InventoryItemDescription": "Brazil Cement", "TypeCode": "GOODS", "Type": "Goods", "Quantity": 1, "PhysicalReceiptQuantity": 5, "PhysicalReceiptDate": "2018-10-03", "UOMCode": "BOX", "UOMName": "BOX", "Price": 100, "Amount": 100, "ChargesAmount": 17, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100170578288/child/fiscalDocumentLines/300100170578290", "name": "fiscalDocumentLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100170578288/child/fiscalDocumentLines/300100170578290", "name": "fiscalDocumentLines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100170578288", "name": "inboundFiscalDocuments", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/inboundFiscalDocuments/300100170578288/child/fiscalDocumentLines/300100170578290/child/fiscalDocumentSchedules", "name": "fiscalDocumentSchedules", "kind": "collection" } ] } } ] }