Get one batch line
get
/fscmRestApi/resources/11.13.18.05/channelIndirectSalesBatches/{IndirectSalesBatchId}/child/batchLines/{IndirectSalesBatchLineId}
Request
Path Parameters
-
IndirectSalesBatchId(required): integer(int64)
Value that uniquely identifies the indirect sales batch.
-
IndirectSalesBatchLineId(required): integer(int64)
Value that uniquely identifies the indirect sales batch. It???s a primary key generated by the application when the indirect sales batch is created.
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: 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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : channelIndirectSalesBatches-batchLines-item-response
Type:
Show Source
object
-
AcceptanceMode: string
Read Only:
true
Maximum Length:255
Acceptance mode for the batch line. -
AcceptanceModeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the acceptance mode for the batch line. A list of values is defined in the lookup type ORA_SPA_BATCH_LINE_ACCEPT_MODE. -
AcceptedAmount: number
Read Only:
true
Accepted amount for the batch line. -
AllowedQuantity: number
Read Only:
true
Allowed quantity for the batch line. -
AttributeCategory: string
Read Only:
true
Maximum Length:30
Attribute Category segment for the transaction header descriptive flexfield. -
AttributeCharacter1: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter10: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter11: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter12: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter13: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter14: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter15: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter16: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter17: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter18: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter19: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter2: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter20: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter3: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter4: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter5: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter6: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter7: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter8: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeCharacter9: string
Read Only:
true
Maximum Length:150
Character segment for the transaction header's descriptive flexfield. -
AttributeDate1: string
(date)
Read Only:
true
Date segment for the transaction header descriptive flexfield. -
AttributeDate2: string
(date)
Read Only:
true
Date segment for the transaction header descriptive flexfield. -
AttributeDate3: string
(date)
Read Only:
true
Date segment for the transaction header descriptive flexfield. -
AttributeDate4: string
(date)
Read Only:
true
Date segment for the transaction header descriptive flexfield. -
AttributeDate5: string
(date)
Read Only:
true
Date segment for the transaction header descriptive flexfield. -
AttributeNumber1: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber10: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber2: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber3: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber4: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber5: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber6: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber7: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber8: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
AttributeNumber9: number
Read Only:
true
Number segment for the transaction header descriptive flexfield. -
BillToCustomer: string
Read Only:
true
Maximum Length:360
Name of the bill-to customer on the sales order. -
BillToCustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the bill-to customer. -
BillToCustomerRegistryId: string
Read Only:
true
Maximum Length:30
Unique identifier for the bill-to-customer. -
CalculatedAmount: number
Read Only:
true
Allowable amount for the batch line, as calculated by the system. -
ClaimedQuantity: number
Read Only:
true
Quantity that's claimed by the distributor. -
Comments: string
Read Only:
true
Maximum Length:4000
Comments that the user enters on the sales order. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DisputedAmount: number
Read Only:
true
Disputed amount for the batch line. -
disputes: array
Disputes
Title:
Disputes
Error messages generated while validating the distributor's sales orders against their special price agreement. -
DistributorClaimedAmount: number
Read Only:
true
Calculated claim amount requested by the distributor for the batch line. -
DistributorClaimNumber: string
Read Only:
true
Maximum Length:30
Number assigned by the distributor that uniquely identifies the claim. -
IndirectSalesBatchId: integer
(int64)
Read Only:
true
Value that uniquely identifies the indirect sales batch line. It???s a primary key generated by the application when the indirect sales batch line is created. -
IndirectSalesBatchLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the indirect sales batch. It???s a primary key generated by the application when the indirect sales batch is created. -
Item: string
Read Only:
true
Maximum Length:300
Name of the item. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item. -
ItemId: number
Read Only:
true
Value that uniquely identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user last updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the record. -
LineAttributeCategory: string
Read Only:
true
Maximum Length:30
Attribute Category segment for the transaction line descriptive flexfield. -
LineAttributeCharacter1: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter10: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter11: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter12: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter13: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter14: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter15: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter16: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter17: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter18: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter19: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter2: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter20: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter3: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter4: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter5: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter6: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter7: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter8: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeCharacter9: string
Read Only:
true
Maximum Length:150
Character segment for the transaction line's descriptive flexfield. -
LineAttributeDate1: string
(date)
Date segment for the transaction line descriptive flexfield.
-
LineAttributeDate2: string
(date)
Read Only:
true
Date segment for the transaction line descriptive flexfield. -
LineAttributeDate3: string
(date)
Read Only:
true
Date segment for the transaction line descriptive flexfield. -
LineAttributeDate4: string
(date)
Read Only:
true
Date segment for the transaction line descriptive flexfield. -
LineAttributeDate5: string
(date)
Read Only:
true
Date segment for the transaction line descriptive flexfield. -
LineAttributeNumber1: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber10: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber2: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber3: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber4: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber5: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber6: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber7: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber8: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineAttributeNumber9: number
Read Only:
true
Number segment for the transaction line descriptive flexfield. -
LineComments: string
Read Only:
true
Maximum Length:4000
Comments that the user enters on the sales order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalSystemLineReference: string
Read Only:
true
Maximum Length:240
Value that identifies the original document reference for the transaction line in the external system. -
OriginalSystemReference: string
Read Only:
true
Maximum Length:240
Value that identifies the original document reference for the transaction in the external system. -
OriginalSystemSource: string
Read Only:
true
Maximum Length:240
Name of the system source. -
PaymentAmount: number
Read Only:
true
Claim amount linked to the batch line. -
RejectReason: string
Read Only:
true
Maximum Length:255
Reason for rejecting the batch line. -
RejectReasonCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the reason for rejecting the batch line. A list of values is defined in the lookup type ORA_SPA_BATCH_LINE_REJECT_REASON. -
RequestedShipDate: string
(date)
Read Only:
true
Date when the customer requested to ship the item. -
SalesOrderDate: string
(date)
Read Only:
true
Date when the order was placed. -
SalesOrderLineNumber: number
Read Only:
true
Number that identifies the sales order line. -
SalesOrderNumber: string
Read Only:
true
Maximum Length:50
Number that identifies the sales order. -
ShippedDate: string
(date)
Read Only:
true
Date the shipment was actually sent. -
ShippedQuantity: number
Read Only:
true
Indicates the quantity of goods or services shipped by the supplier. -
ShippedUOM: string
Read Only:
true
Maximum Length:255
Unit of measure for the shipped quantity. UOM stands for Unit of Measure. -
ShippedUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the shipped quantity. -
ShipToCustomer: string
Read Only:
true
Maximum Length:360
Name of the ship-to customer on the sales order. -
ShipToCustomerId: number
Read Only:
true
Value that uniquely identifies the ship-to customer. -
ShipToCustomerRegistryId: string
Read Only:
true
Maximum Length:30
Unique identifier for the ship-to customer. -
SpecialPriceAgreementId: integer
(int64)
Read Only:
true
Value that uniquely identifies the special price agreement. -
SpecialPriceAgreementName: string
Read Only:
true
Maximum Length:240
Name of the special price agreement. -
SpecialPriceAgreementNumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the special price agreement. -
Status: string
Read Only:
true
Maximum Length:255
Status of the batch line. -
StatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the status of the batch line. A list of values is defined in the lookup type ORA_CJM_SPA_BATCH_LINE_STATUS. -
UnitAllowedAmount: number
Read Only:
true
Allowable amount per unit calculated by the system for the batch line. -
UnitClaimedAmount: number
Read Only:
true
Amount per unit that's claimed by the distributor. -
UnitPurchasePrice: number
Read Only:
true
Price per unit that a distributor paid for an item. -
UnitSellingPrice: number
Read Only:
true
Price per unit that a buyer paid for an item. -
WaybillNumber: string
Read Only:
true
Maximum Length:30
Waybill or airbill number for the shipment.
Nested Schema : Disputes
Type:
array
Title:
Disputes
Error messages generated while validating the distributor's sales orders against their special price agreement.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : channelIndirectSalesBatches-batchLines-disputes-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
DisputeDescription: string
Read Only:
true
Maximum Length:255
Description of the dispute. -
DisputeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the dispute for the indirect sales batch line. It's a primary key that the application generates when it creates the dispute. -
DisputeName: string
Read Only:
true
Maximum Length:30
Value that uniquely identifies the dispute. -
DisputeType: string
Read Only:
true
Maximum Length:255
Identifies the type of the dispute. -
DisputeTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the dispute type. A list of values is defined in the lookup type ORA_BATCH_LINE_DISPUTE_TYPE. -
IndirectSalesBatchLineId: integer
(int64)
Value that uniquely identifies the indirect sales batch line. It's a primary key that the application generates when it creates the indirect sales batch line.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- disputes
-
Parameters:
- IndirectSalesBatchId:
$request.path.IndirectSalesBatchId
- IndirectSalesBatchLineId:
$request.path.IndirectSalesBatchLineId
Error messages generated while validating the distributor's sales orders against their special price agreement. - IndirectSalesBatchId: