Update one indirect sales batch
patch
/fscmRestApi/resources/11.13.18.05/channelIndirectSalesBatches/{IndirectSalesBatchId}
Request
Path Parameters
-
IndirectSalesBatchId(required): integer(int64)
Value that uniquely identifies the indirect sales batch.
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
Root Schema : schema
Type:
Show Source
object
-
batchLines: array
Batch Lines
Title:
Batch Lines
Distributor's sales orders submitted as proof of sale to the manufacturer. -
DistributorContact: string
Name of the distributor's bill-to customer account contact.
-
DistributorContactId: integer
(int64)
Value that uniquely represents the distributor's bill-to customer account contact.
-
DistributorContactNumber: string
Number that identifies the distributor's bill-to customer account contact.
-
payments: array
Payments
Title:
Payments
Payments to the distributor for submitted eligible sales orders in the batch.
Nested Schema : Batch Lines
Type:
array
Title:
Batch Lines
Distributor's sales orders submitted as proof of sale to the manufacturer.
Show Source
Nested Schema : Payments
Type:
array
Title:
Payments
Payments to the distributor for submitted eligible sales orders in the batch.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
disputes: array
Disputes
Title:
Disputes
Error messages generated while validating the distributor's sales orders against their special price agreement. -
LineAttributeDate1: string
(date)
Date segment for the transaction line descriptive flexfield.
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 : channelIndirectSalesBatches-batchLines-disputes-item-patch-request
Type:
Show Source
object
-
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : channelIndirectSalesBatches-item-response
Type:
Show Source
object
-
AcceptedAmount: number
Read Only:
true
Total accepted amount for the indirect sales batch. -
AcceptedLines: integer
Read Only:
true
Number of accepted lines in the indirect sales batch. -
AmountDisputedLines: integer
Read Only:
true
Number of lines in Amount Disputed status in the indirect sales batch. -
batchLines: array
Batch Lines
Title:
Batch Lines
Distributor's sales orders submitted as proof of sale to the manufacturer. -
BatchProcessingMode: string
Read Only:
true
Maximum Length:255
Processing mode for the indirect sales batches. -
BatchProcessingModeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the processing mode for the indirect sales batch. A list of values is defined in the lookup type ORA_CJM_SPA_BATCH_PROCESS_MODE. -
BatchType: string
Read Only:
true
Batch type of the indirect sales batch. -
BatchTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the batch type of the indirect sales batch. -
BusinessUnit: string
Read Only:
true
Name of the business unit. -
BusinessUnitId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit. -
CalculatedAmount: number
Read Only:
true
Total allowable amount calculated by the system. -
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. -
Currency: string
Read Only:
true
Name of the currency used for the transactions in the batch. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency used for the transactions in the batch. -
DateFiled: string
(date-time)
Read Only:
true
Date and time when the indirect sales batch was created. -
DisputedAmount: number
Read Only:
true
Total disputed amount for the indirect sales batch. -
DisputedLines: integer
Read Only:
true
Number of disputed lines in the indirect sales batch. -
Distributor: string
Read Only:
true
Maximum Length:255
Name of the distributor. -
DistributorBillToAccountAddress: string
Read Only:
true
Maximum Length:4000
Primary bill-to account address of the distributor's bill-to customer account. -
DistributorBillToAccountId: integer
(int64)
Read Only:
true
Value that uniquely identifies the bill-to customer account of the distributor. -
DistributorBillToAccountNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the bill-to customer account of the distributor. -
DistributorClaimedAmount: number
Read Only:
true
Total amount of distributor claims for the indirect sales batch. -
DistributorContact: string
Name of the distributor's bill-to customer account contact.
-
DistributorContactEmail: string
Read Only:
true
Email of the distributor's bill-to customer account contact. -
DistributorContactId: integer
(int64)
Value that uniquely represents the distributor's bill-to customer account contact.
-
DistributorContactNumber: string
Number that identifies the distributor's bill-to customer account contact.
-
DistributorContactPhoneNumber: string
Read Only:
true
Phone number of the distributor's bill-to customer account contact. -
DistributorContactPhoneNumberExtension: string
Read Only:
true
Phone number extension of the distributor's bill-to customer account's contact. -
DuplicateLines: integer
Read Only:
true
Number of lines in Duplicate status in the indirect sales batch. -
EligibilityDisputedLines: integer
Read Only:
true
Number of lines in Eligibility Disputed status in the indirect sales batch. -
IndirectSalesBatchFileName: string
Read Only:
true
Maximum Length:250
Name of the file containing the transactions for the indirect sales batch. -
IndirectSalesBatchId: integer
(int64)
Read Only:
true
Value that uniquely identifies the indirect sales batch. -
IndirectSalesBatchName: string
Read Only:
true
Maximum Length:100
Name of the indirect sales batch. -
IndirectSalesBatchNumber: integer
(int64)
Read Only:
true
Number that uniquely identifies the indirect sales batch. -
InProgressAmount: number
Read Only:
true
Total claim amount of claims linked to this specific batch of accruals that are being settled. -
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. -
Lines: integer
(int64)
Read Only:
true
Number of lines in the indirect sales batch. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManuallyAcceptedLines: integer
Read Only:
true
Number of manually accepted lines in the indirect sales batch. -
NormallyAcceptedLines: integer
Read Only:
true
Number of systematically accepted lines in the indirect sales batch. -
PaidAmount: number
Read Only:
true
Total claim amount of claims linked to this specific batch of accruals that have been settled. -
PaymentAmount: number
Read Only:
true
Total claim amount for claims linked to this specific batch of accruals. -
payments: array
Payments
Title:
Payments
Payments to the distributor for submitted eligible sales orders in the batch. -
RejectedLines: integer
Read Only:
true
Number of lines in Rejected status in the indirect sales batch. -
Status: string
Read Only:
true
Status of the indirect sales batch. -
StatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the status of the indirect sales batch. A list of values is defined in the lookup type ORA_CJM_SPA_BATCH_STATUS.
Nested Schema : Batch Lines
Type:
array
Title:
Batch Lines
Distributor's sales orders submitted as proof of sale to the manufacturer.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Payments
Type:
array
Title:
Payments
Payments to the distributor for submitted eligible sales orders in the batch.
Show Source
Nested 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.
Nested Schema : channelIndirectSalesBatches-payments-item-response
Type:
Show Source
object
-
Amount: number
Read Only:
true
Amount claimed in the claim currency. -
ClaimDate: string
(date)
Read Only:
true
Date when a claim is created. -
ClaimId: integer
(int64)
Read Only:
true
Value that uniquely identifies a claim. -
ClaimNumber: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the claim. -
ClaimStatus: string
Read Only:
true
Maximum Length:50
Status of the channel claim. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency used for the channel claim. -
CurrencyPrecision: integer
(int32)
Read Only:
true
Precision of the currency. -
CustomerReference: string
Read Only:
true
Maximum Length:100
Number assigned by the distributor that uniquely identifies their indirect sales batch or special price agreement within the batch. -
IndirectSalesBatchId: integer
(int64)
Read Only:
true
Value that uniquely identifies the indirect sales batch. The application generates a primary key when the indirect sales batch is created. -
InstrumentDate: string
(date)
Read Only:
true
Date when the settlement instrument was created. -
InstrumentNumber: string
Read Only:
true
Maximum Length:30
Number of the instrument created upon settlement. -
InstrumentPayee: string
Read Only:
true
Maximum Length:360
Supplier or customer to whom the payment is made. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettlementMethod: string
Read Only:
true
Maximum Length:80
Abbreviation that identifies the status of the batch line. A list of values is defined in the lookup type, ORA_CJM_SETTLEMENT_METHOD. -
SettlementMethodCode: string
Read Only:
true
Maximum Length:30
Method of payment used to settle the claim. A list of accepted values is defined in the lookup type, ORA_CJM_SETTLEMENT_METHOD. -
StatusCode: string
Read Only:
true
Maximum Length:30
System status code for the channel claim.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DistributorContactVO
-
Parameters:
- finder:
default%3BbindBillToCustomerId%3D{DistributorBillToAccountId}%2CbindSiteUseCode%3DBILL_TO
The following properties are defined on the LOV link relation:- Source Attribute: DistributorContactId; Target Attribute: ContactId
- Display Attribute: Name, Email, JobTitle
- finder:
- accept
-
Operation: /fscmRestApi/resources/11.13.18.05/channelIndirectSalesBatches/{IndirectSalesBatchId}/action/acceptParameters:
- IndirectSalesBatchId:
$request.path.IndirectSalesBatchId
By accepting, the user agrees to pay the calculated amount if the distributor's claimed amount differs from the calculated amount. - IndirectSalesBatchId:
- batchLines
-
Parameters:
- IndirectSalesBatchId:
$request.path.IndirectSalesBatchId
Distributor's sales orders submitted as proof of sale to the manufacturer. - IndirectSalesBatchId:
- payAndClose
-
Parameters:
- IndirectSalesBatchId:
$request.path.IndirectSalesBatchId
Action to initiate the payment for the accepted lines and close the indirect sales batch. - IndirectSalesBatchId:
- payments
-
Operation: /fscmRestApi/resources/11.13.18.05/channelIndirectSalesBatches/{IndirectSalesBatchId}/child/paymentsParameters:
- IndirectSalesBatchId:
$request.path.IndirectSalesBatchId
Payments to the distributor for submitted eligible sales orders in the batch. - IndirectSalesBatchId:
- reject
-
Operation: /fscmRestApi/resources/11.13.18.05/channelIndirectSalesBatches/{IndirectSalesBatchId}/action/rejectParameters:
- IndirectSalesBatchId:
$request.path.IndirectSalesBatchId
Action to reject either the specified indirect sales batch lines or the entire batch. - IndirectSalesBatchId: