Create a receivables line dispute
post
/fscmRestApi/resources/11.13.18.05/receivablesDisputes/{receivablesDisputesUniqID}/child/receivablesDisputeLines
Request
Path Parameters
-
receivablesDisputesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- RequestNumber and CustomerTransactionId ---for the Receivables Disputes resource and used to uniquely identify an instance of Receivables Disputes. The client should not generate the hash key value. Instead, the client should query on the Receivables Disputes collection resource with a filter on the primary key values in order to navigate to a specific instance of Receivables Disputes.
For example: receivablesDisputes?q=RequestNumber=<value1>;CustomerTransactionId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CustomerTransactionLineId: integer
(int64)
The unique identifier of a transaction line on which the dispute is created.
-
DisputeQuantity: number
The transaction line quantity to be disputed.
-
LineDisputeAmount: number
The transaction line amount to be disputed.
-
LineNumber: string
The line number of the disputed transaction.
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 : receivablesDisputes-receivablesDisputeLines-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the dispute on a transaction line. -
CreationDate: string
(date-time)
Read Only:
true
The date when the dispute was created on a transaction line. -
CustomerTransactionLineId: integer
(int64)
The unique identifier of a transaction line on which the dispute is created.
-
DisputeQuantity: number
The transaction line quantity to be disputed.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the dispute line was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the dispute line. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login identifier of the user who last updated the dispute line. -
LineDisputeAmount: number
The transaction line amount to be disputed.
-
LineNumber: string
The line number of the disputed transaction.
-
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.