Jump to

• Request
• Response
• Examples

Update one line

patch

/fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/child/fiscalDocumentLines/{fiscalDocumentLinesUniqID}

Request

Path Parameters

• DocumentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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.

Header Parameters

• Metadata-Context: string
  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: string
  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

• fiscalDocumentSchedules: array fiscalDocumentSchedules
• PhysicalReceiptQuantity: number
  Title: Delivered Quantity
• SecondaryQuantity: number
  Title: Secondary Quantity
• Status: string
  Title: Status

  Maximum Length: 30

{
    "type":"object",
    "properties":{
        "PhysicalReceiptQuantity":{
            "title":"Delivered Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PhysicalReceiptQuantity"
                ]
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "fiscalDocumentSchedules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-patch-request"
            }
        }
    }
}

Nested Schema : fiscalDocumentSchedules

Type: array

Show Source

• Array of: object inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-patch-request"
    }
}

Nested Schema : inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-patch-request

Type: object

Show Source

• AllocatedQuantity: number
  Title: Allocated Quantity
• AllocatedQuantityInFiscalDocumentLineUOM: number
  Title: Allocated Quantity
• AllocatedQuantityInSecondaryUOM: number
  Title: Secondary Quantity
• ASNLineNumber: string
  Title: ASN Line Number

  Maximum Length: 80
• ConsumptionAdviceLine: string
  Title: Consumption Advice Line Number

  Maximum Length: 80
• DocumentId: integer (int64)
  Title: Document ID
• LineId: integer (int64)
  Title: Document Line ID
• ReceiptLineNumber: integer
  Title: Receipt Line
• ReceiptNumber: string
  Title: Receipt Number

  Maximum Length: 30
• SalesReturnOrderLine: string
  Title: Sales Return Order Line

  Maximum Length: 30
• SalesReturnOrderNumber: string
  Title: Sales Return Order Number

  Maximum Length: 30
• SalesReturnOrderSchedule: string
  Title: Sales Return Order Schedule

  Maximum Length: 30
• ScheduleId: integer (int64)
  Title: Schedule ID
• ScheduleNumber: number
  Title: Schedule Number
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 30
• ShipmentLine: string
  Title: Shipment Line

  Maximum Length: 30
• ShipmentNumber: string
  Title: Shipment Number

  Maximum Length: 30
• SourceDocumentCurrencyCode: string
  Title: Source Document Currency Code

  Maximum Length: 30
• SourceDocumentId: integer (int64)
  Title: Source Document ID
• SourceDocumentLineId: integer (int64)
  Title: Source Document Line ID
• SourceDocumentPrice: number
  Title: Source Document Price
• SourceDocumentScheduleId: integer (int64)
  Title: Source Document Schedule ID
• SourceDocumentTypeCode: string
  Title: Source Document Type Code

  Maximum Length: 30

  Default Value: PURCHASE_ORDER
• SourceDocumentUOMCode: string
  Title: Source Document UOM Code

  Maximum Length: 30
• SourceReferenceDocumentLineId: integer (int64)

{
    "type":"object",
    "properties":{
        "ASNLineNumber":{
            "title":"ASN Line Number",
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "AllocatedQuantity":{
            "title":"Allocated Quantity",
            "type":"number",
            "nullable":false
        },
        "AllocatedQuantityInFiscalDocumentLineUOM":{
            "title":"Allocated Quantity",
            "type":"number",
            "nullable":true
        },
        "AllocatedQuantityInSecondaryUOM":{
            "title":"Secondary Quantity",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondaryUOMCode"
                ]
            }
        },
        "ConsumptionAdviceLine":{
            "title":"Consumption Advice Line Number",
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReceiptLineNumber":{
            "title":"Receipt Line",
            "type":"integer",
            "nullable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "SalesReturnOrderLine":{
            "title":"Sales Return Order Line",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "SalesReturnOrderNumber":{
            "title":"Sales Return Order Number",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "SalesReturnOrderSchedule":{
            "title":"Sales Return Order Schedule",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ScheduleNumber":{
            "title":"Schedule Number",
            "type":"number",
            "nullable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "ShipmentLine":{
            "title":"Shipment Line",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "SourceDocumentCurrencyCode":{
            "title":"Source Document Currency Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceDocumentLineId":{
            "title":"Source Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceDocumentPrice":{
            "title":"Source Document Price",
            "type":"number",
            "nullable":true
        },
        "SourceDocumentScheduleId":{
            "title":"Source Document Schedule ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"PURCHASE_ORDER"
        },
        "SourceDocumentUOMCode":{
            "title":"Source Document UOM Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SourceReferenceDocumentLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "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 : inboundFiscalDocuments-fiscalDocumentLines-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  Read Only: true
• ChargesAmount: number
  Title: Charges

  Read Only: true
• DocumentId: integer (int64)
  Title: Document ID

  Read Only: true
• ExternalItem: string
  Title: External Item

  Read Only: true

  Maximum Length: 300
• ExternalItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 250
• FciControlNumber: string
  Title: FCI Number

  Read Only: true

  Maximum Length: 36
• fiscalDocumentSchedules: array fiscalDocumentSchedules
• InventoryItemDescription: string
  Title: Item Description

  Read Only: true
• InventoryItemId: integer (int64)
  Title: Item ID

  Read Only: true
• InventoryItemNumber: string
  Title: Item Code

  Read Only: true

  Maximum Length: 80
• LineId: integer (int64)
  Title: Document Line ID

  Read Only: true
• LineNumber: number
  Title: Line Number

  Read Only: true
• LineSourceDocumentType: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 255
• LineSourceDocumentTypeCode: string
  Title: Source Document Type Code

  Read Only: true

  Maximum Length: 30
• LineStatus: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: NEW
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhysicalReceiptDate: string (date)
  Title: Physical Receipt Date

  Read Only: true
• PhysicalReceiptQuantity: number
  Title: Delivered Quantity
• Price: number
  Title: Unit Price

  Read Only: true
• Quantity: number
  Title: Quantity

  Read Only: true
• SecondaryQuantity: number
  Title: Secondary Quantity
• SecondaryUOMCode: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 30
• SecondaryUOMName: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 25
• SourceDocumentBUId: integer (int64)
  Title: Source Document BU ID

  Read Only: true
• SourceDocumentBUName: string
  Title: Source Document BU

  Read Only: true

  Maximum Length: 255
• Status: string
  Title: Status

  Maximum Length: 30
• Type: string
  Title: Line Type

  Read Only: true

  Maximum Length: 255
• TypeCode: string
  Title: Type Code

  Read Only: true

  Maximum Length: 30
• UOMCode: string
  Title: UOM Code

  Read Only: true

  Maximum Length: 30
• UOMName: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

{
    "type":"object",
    "properties":{
        "Amount":{
            "title":"Amount",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ChargesAmount":{
            "title":"Charges",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalItem":{
            "title":"External Item",
            "maxLength":300,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalItemDescription":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FciControlNumber":{
            "title":"FCI Number",
            "maxLength":36,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemDescription":{
            "title":"Item Description",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "title":"Item Code",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineSourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineSourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatus":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "default":"NEW",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PhysicalReceiptDate":{
            "title":"Physical Receipt Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PhysicalReceiptQuantity":{
            "title":"Delivered Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":false
        },
        "Price":{
            "title":"Unit Price",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PhysicalReceiptQuantity"
                ]
            }
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SourceDocumentBUId":{
            "title":"Source Document BU ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentBUName":{
            "title":"Source Document BU",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":false
        },
        "Type":{
            "title":"Line Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UOMName":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "fiscalDocumentSchedules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : fiscalDocumentSchedules

Type: array

Show Source

• Array of: object inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-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 : inboundFiscalDocuments-fiscalDocumentLines-fiscalDocumentSchedules-item-response

Type: object

Show Source

• AllocatedQuantity: number
  Title: Allocated Quantity
• AllocatedQuantityInFiscalDocumentLineUOM: number
  Title: Allocated Quantity
• AllocatedQuantityInSecondaryUOM: number
  Title: Secondary Quantity
• ASNLineNumber: string
  Title: ASN Line Number

  Maximum Length: 80
• ConsumptionAdviceLine: string
  Title: Consumption Advice Line Number

  Maximum Length: 80
• DocumentId: integer (int64)
  Title: Document ID
• ItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240
• LineId: integer (int64)
  Title: Document Line ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• POLineNumber: number
  Title: PO Line Number

  Read Only: true
• PONumber: string
  Title: PO Number

  Read Only: true

  Maximum Length: 30
• POScheduleNumber: number
  Title: PO Schedule Number

  Read Only: true
• PricingUOMCode: string
  Title: Pricing UOM

  Read Only: true

  Maximum Length: 3
• PricingUOMName: string
  Title: Pricing UOM

  Read Only: true

  Maximum Length: 255
• PromisedDate: string (date-time)
  Title: Promised Delivery Date

  Read Only: true
• ReceiptLineNumber: integer
  Title: Receipt Line
• ReceiptNumber: string
  Title: Receipt Number

  Maximum Length: 30
• SalesReturnOrderLine: string
  Title: Sales Return Order Line

  Maximum Length: 30
• SalesReturnOrderNumber: string
  Title: Sales Return Order Number

  Maximum Length: 30
• SalesReturnOrderSchedule: string
  Title: Sales Return Order Schedule

  Maximum Length: 30
• ScheduleId: integer (int64)
  Title: Schedule ID
• ScheduleNumber: number
  Title: Schedule Number
• SecondaryUOMCode: string
  Title: Secondary UOM

  Maximum Length: 30
• SecondaryUOMName: string
  Title: Secondary UOM

  Read Only: true

  Maximum Length: 25
• ShipmentLine: string
  Title: Shipment Line

  Maximum Length: 30
• ShipmentNumber: string
  Title: Shipment Number

  Maximum Length: 30
• SourceDocumentCurrencyCode: string
  Title: Source Document Currency Code

  Maximum Length: 30
• SourceDocumentCurrencyName: string
  Title: Source Document Currency

  Read Only: true

  Maximum Length: 255
• SourceDocumentId: integer (int64)
  Title: Source Document ID
• SourceDocumentLineId: integer (int64)
  Title: Source Document Line ID
• SourceDocumentPrice: number
  Title: Source Document Price
• SourceDocumentScheduleId: integer (int64)
  Title: Source Document Schedule ID
• SourceDocumentType: string
  Title: Source Document Type

  Read Only: true

  Maximum Length: 255
• SourceDocumentTypeCode: string
  Title: Source Document Type Code

  Maximum Length: 30

  Default Value: PURCHASE_ORDER
• SourceDocumentUOMCode: string
  Title: Source Document UOM Code

  Maximum Length: 30
• SourceDocumentUOMName: string
  Title: Source Document UOM

  Read Only: true

  Maximum Length: 255
• SourceReferenceDocumentLineId: integer (int64)
• SupplierItem: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 300

{
    "type":"object",
    "properties":{
        "ASNLineNumber":{
            "title":"ASN Line Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "AllocatedQuantity":{
            "title":"Allocated Quantity",
            "type":"number",
            "nullable":false,
            "x-queryable":true
        },
        "AllocatedQuantityInFiscalDocumentLineUOM":{
            "title":"Allocated Quantity",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "AllocatedQuantityInSecondaryUOM":{
            "title":"Secondary Quantity",
            "type":"number",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondaryUOMCode"
                ]
            },
            "x-queryable":true
        },
        "ConsumptionAdviceLine":{
            "title":"Consumption Advice Line Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"PO Line Number",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PONumber":{
            "title":"PO Number",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"PO Schedule Number",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PricingUOMCode":{
            "title":"Pricing UOM",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingUOMName":{
            "title":"Pricing UOM",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedDate":{
            "title":"Promised Delivery Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "title":"Receipt Line",
            "type":"integer",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SalesReturnOrderLine":{
            "title":"Sales Return Order Line",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SalesReturnOrderNumber":{
            "title":"Sales Return Order Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SalesReturnOrderSchedule":{
            "title":"Sales Return Order Schedule",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ScheduleNumber":{
            "title":"Schedule Number",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":25,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "ShipmentLine":{
            "title":"Shipment Line",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyCode":{
            "title":"Source Document Currency Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyName":{
            "title":"Source Document Currency",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentLineId":{
            "title":"Source Document Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentPrice":{
            "title":"Source Document Price",
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentScheduleId":{
            "title":"Source Document Schedule ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "default":"PURCHASE_ORDER",
            "x-queryable":true
        },
        "SourceDocumentUOMCode":{
            "title":"Source Document UOM Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SourceDocumentUOMName":{
            "title":"Source Document UOM",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceReferenceDocumentLineId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":300,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

fiscalDocumentSchedules

Operation: /fscmRestApi/resources/11.13.18.05/inboundFiscalDocuments/{DocumentId}/child/fiscalDocumentLines/{fiscalDocumentLinesUniqID}/child/fiscalDocumentSchedules

Parameters:

• DocumentId: $request.path.DocumentId
• fiscalDocumentLinesUniqID: $request.path.fiscalDocumentLinesUniqID

Back to Top

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"
			}
			]
		}
	}
	]
}

Back to Top