Jump to

• Request
• Response

Get one schedule

get

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

Request

Path Parameters

• DocumentId(required): integer(int64)
  Value that uniquely identifies the inbound fiscal document.
• ScheduleId(required): integer(int64)
  Value that uniquely identifies the fiscal document schedule.
• 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.

Query Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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-fiscalDocumentSchedules-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "PONumber":{
            "title":"PO Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PricingUOMName":{
            "title":"Pricing UOM",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the unit of measure in which the price of the item in the source document is shown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyCode":{
            "title":"Source Document Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the currency of the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentUOMCode":{
            "title":"Source Document UOM Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the unit of measure of the source document.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inbound fiscal document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipmentLine":{
            "title":"Shipment Line",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the line of a shipment.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PromisedDate":{
            "title":"Promised Delivery Date",
            "type":"string",
            "description":"Date when the materials are promised to be delivered.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentPrice":{
            "title":"Source Document Price",
            "type":"number",
            "description":"Price of the item that is taken from the source document.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptLineNumber":{
            "title":"Receipt Line",
            "type":"integer",
            "description":"Line number of the physical receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"PO Schedule Number",
            "type":"number",
            "description":"Number that identifies the schedule of the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AllocatedQuantityInFiscalDocumentLineUOM":{
            "title":"Allocated Quantity",
            "type":"number",
            "description":"Source document quantity allocated on a fiscal document schedule in the fiscal document unit of measure of the item line.",
            "nullable":true,
            "x-queryable":true
        },
        "ConsumptionAdviceLine":{
            "title":"Consumption Advice Line Number",
            "maxLength":80,
            "type":"string",
            "description":"Consumption advice line number associated with the consigned fiscal flow.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentType":{
            "title":"Source Document Type",
            "maxLength":255,
            "type":"string",
            "description":"Type of document for which the fiscal document is captured or created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "title":"Secondary UOM",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the UOM code of the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceDocumentLineId":{
            "title":"Source Document Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source document line of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the purchase order receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentId":{
            "title":"Source Document ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source document of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AllocatedQuantityInSecondaryUOM":{
            "title":"Secondary Quantity",
            "type":"number",
            "description":"Source document quantity allocated on a fiscal document schedule in the secondary unit of measure of the item.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SecondaryUOMCode"
                ]
            },
            "x-queryable":true
        },
        "ScheduleNumber":{
            "title":"Schedule Number",
            "type":"number",
            "description":"Number that identifies the schedule of the fiscal document item line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "title":"Document Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the fiscal document line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ASNLineNumber":{
            "title":"ASN Line Number",
            "maxLength":80,
            "type":"string",
            "description":"Advanced shipment notice line associated with the drop ship seller flow.",
            "nullable":true,
            "x-queryable":true
        },
        "AllocatedQuantity":{
            "title":"Allocated Quantity",
            "type":"number",
            "description":"Allocated quantity on the fiscal document schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "PricingUOMCode":{
            "title":"Pricing UOM",
            "maxLength":3,
            "type":"string",
            "description":"Indicates the UOM code in which the price of the item in the source document is shown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDocumentCurrencyName":{
            "title":"Source Document Currency",
            "maxLength":255,
            "type":"string",
            "description":"Name of the currency of the item that is taken from the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Schedule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the fiscal document schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceReferenceDocumentLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference source document line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceDocumentScheduleId":{
            "title":"Source Document Schedule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source document schedule of the schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SecondaryUOMName":{
            "title":"Secondary UOM",
            "maxLength":25,
            "type":"string",
            "description":"Indicates the alternative unit of measure that's allowed to quantify a dual-UOM-controlled item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "SourceDocumentTypeCode":{
            "title":"Source Document Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the document type that acts as source for the fiscal document that is captured or created.",
            "nullable":false,
            "default":"PURCHASE_ORDER",
            "x-queryable":true
        },
        "SalesReturnOrderLine":{
            "title":"Sales Return Order Line",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the line of a return order.",
            "nullable":true,
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"PO Line Number",
            "type":"number",
            "description":"Number that identifies the line of the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesReturnOrderSchedule":{
            "title":"Sales Return Order Schedule",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the schedule of a return order.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDocumentUOMName":{
            "title":"Source Document UOM",
            "maxLength":255,
            "type":"string",
            "description":"Name of the unit of measure of the source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesReturnOrderNumber":{
            "title":"Sales Return Order Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the return order.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":300,
            "type":"string",
            "description":"Indicates the supplier's identification number or code for the goods ordered on the source document order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top