Represents a credit request for an invoice. Contains invoice and dispute identifiers, total credit amount, category, and line-level credit details for issuing a credit memo.
Namespace
IssueCreditMemo
CreditRequestInputRepresentations Constructors
The CreditRequestInputRepresentations class includes these constructors.
CreditRequestInputRepresentations(invoiceId, creditAmount, description, disputeId, category, creditLineRequestInputRepresentations)
Creates a credit request with the given invoice, amount, description, dispute, category, and line-level credit details.
CreditRequestInputRepresentations(invoiceId, creditAmount, description, creditLineRequestInputRepresentations)
Creates a credit request with the given invoice, amount, description, and line-level credit details.
CreditRequestInputRepresentations()
Creates an empty credit request.
CreditRequestInputRepresentations(invoiceId, creditAmount, description, disputeId, category, creditLineRequestInputRepresentations)
Creates a credit request with the given invoice, amount, description, dispute, category, and line-level credit details.
Signature
public CreditRequestInputRepresentations(String invoiceId, Double creditAmount, String description, String disputeId, String category, List<IssueCreditMemo.CreditLineRequestInputRepresentations> creditLineRequestInputRepresentations)
Parameters
invoiceId
Type: String
ID of the invoice to credit.
creditAmount
Type: Double
Total credit amount to apply to the invoice.
description
Type: String
Optional description for the credit request.
disputeId
Type: String
ID of the billing dispute associated with this credit request.
category
Type: String
Category of the credit memo.
creditLineRequestInputRepresentations
Type: List<IssueCreditMemo.CreditLineRequestInputRepresentations >
List of line-level credit requests for this invoice.
CreditRequestInputRepresentations(invoiceId, creditAmount, description, creditLineRequestInputRepresentations)
Creates a credit request with the given invoice, amount, description, and line-level credit details.
Signature
public CreditRequestInputRepresentations(String invoiceId, Double creditAmount, String description, List<IssueCreditMemo.CreditLineRequestInputRepresentations> creditLineRequestInputRepresentations)
Parameters
invoiceId
Type: String
ID of the invoice to credit.
creditAmount
Type: Double
Total credit amount to apply to the invoice.
description
Type: String
Optional description for the credit request.
creditLineRequestInputRepresentations
Type: List<IssueCreditMemo.CreditLineRequestInputRepresentations >
List of line-level credit requests for this invoice.
CreditRequestInputRepresentations()
Creates an empty credit request.
Signature
public CreditRequestInputRepresentations()
CreditRequestInputRepresentations Properties
The CreditRequestInputRepresentations class includes these properties.
category
The credit memo category.
Signature
public String category {get; set;}
Property Value
Type: String
creditAmount
The total credit amount to apply to the invoice.
Signature
public Double creditAmount {get; set;}
Property Value
Type: Double
creditLineRequestInputRepresentations
List of line-level credit requests for this invoice.
Signature
public List<IssueCreditMemo.CreditLineRequestInputRepresentations> creditLineRequestInputRepresentations {get; set;}
Property Value
Type: List<IssueCreditMemo.CreditLineRequestInputRepresentations >
description
Optional description for the credit request.
Signature
public String description {get; set;}
Property Value
Type: String
disputeId
The ID of the billing dispute associated with this credit request.
Signature
public String disputeId {get; set;}
Property Value
Type: String
invoiceId
The ID of the invoice to credit.
Signature
public String invoiceId {get; set;}
Property Value
Type: String