Create a receivables dispute
post
/fscmRestApi/resources/11.13.18.05/receivablesDisputes
Request
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
-
BillToCustomerNumber: string
The bill-to customer number of the disputed transaction.
-
CustomerComments: string
Maximum Length:
1760
The customer comments stated on a dispute. -
CustomerTransactionId(required): integer
(int64)
The unique identifier of a transaction.
-
DisputeAmount: number
The transaction amount to be disputed.
-
DisputePercentage: string
The percentage of transaction amount to be disputed.
-
DisputeReason: string
The reason for which the dispute is created.
-
DisputeSection: string
The section of a transaction to be disputed. Valid values are Total, Lines Subtotal, Percent, Shipping, Tax, and Specific Invoice Lines.
-
DisputeType: string
The severity of a dispute represented as a color code.
-
InternalComments: string
Maximum Length:
1000
The internal comments stated on a dispute. -
receivablesDisputeLines: array
Receivables Dispute Lines
Title:
Receivables Dispute Lines
The receivables dispute lines resource provides details of disputes created on transaction lines. -
ReverseApplicationsCreditOpenBalance: string
Maximum Length:
1
The option that allows an approved dispute to reverse all applications on the transaction and credit its full open balance. -
TransactionAmount: number
The original amount of the disputed transaction.
-
TransactionCurrencyCode: string
The currency in which the disputed transaction is created.
-
TransactionDate: string
(date)
The date on which the disputed transaction is created.
-
TransactionNumber: string
The identifier of the transaction on which the dispute is created.
Nested Schema : Receivables Dispute Lines
Type:
array
Title:
Receivables Dispute Lines
The receivables dispute lines resource provides details of disputes created on transaction lines.
Show Source
Nested 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-item-response
Type:
Show Source
object
-
BillToCustomerNumber: string
The bill-to customer number of the disputed transaction.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the dispute. -
CreationDate: string
(date-time)
Read Only:
true
The date when the dispute was created. -
CustomerComments: string
Maximum Length:
1760
The customer comments stated on a dispute. -
CustomerTransactionId: integer
(int64)
The unique identifier of a transaction.
-
DisputeAmount: number
The transaction amount to be disputed.
-
DisputePercentage: string
The percentage of transaction amount to be disputed.
-
DisputeReason: string
The reason for which the dispute is created.
-
DisputeSection: string
The section of a transaction to be disputed. Valid values are Total, Lines Subtotal, Percent, Shipping, Tax, and Specific Invoice Lines.
-
DisputeType: string
The severity of a dispute represented as a color code.
-
InternalComments: string
Maximum Length:
1000
The internal comments stated on a dispute. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the dispute was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the dispute. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login identifier of the user who last updated the dispute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
receivablesDisputeLines: array
Receivables Dispute Lines
Title:
Receivables Dispute Lines
The receivables dispute lines resource provides details of disputes created on transaction lines. -
RequestNumber: integer
(int64)
Read Only:
true
The unique identifier of a dispute. -
ReverseApplicationsCreditOpenBalance: string
Maximum Length:
1
The option that allows an approved dispute to reverse all applications on the transaction and credit its full open balance. -
TransactionAmount: number
The original amount of the disputed transaction.
-
TransactionCurrencyCode: string
The currency in which the disputed transaction is created.
-
TransactionDate: string
(date)
The date on which the disputed transaction is created.
-
TransactionNumber: string
The identifier of the transaction on which the dispute is created.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Receivables Dispute Lines
Type:
array
Title:
Receivables Dispute Lines
The receivables dispute lines resource provides details of disputes created on transaction lines.
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 : 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
Links
- receivablesDisputeLines
-
Parameters:
- receivablesDisputesUniqID:
$request.path.receivablesDisputesUniqID
The receivables dispute lines resource provides details of disputes created on transaction lines. - receivablesDisputesUniqID: