Package com.chargebee.v4.models.creditNote.params

Class CreditNoteCreateParams.CreditNoteCreateBuilder

java.lang.Object

com.chargebee.v4.models.creditNote.params.CreditNoteCreateParams.CreditNoteCreateBuilder

Enclosing class:

CreditNoteCreateParams

public static final class CreditNoteCreateParams.CreditNoteCreateBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
CreditNoteCreateParams	build()
CreditNoteCreateParams.CreditNoteCreateBuilder	comment(String value)
CreditNoteCreateParams.CreditNoteCreateBuilder	createReasonCode(String value)
CreditNoteCreateParams.CreditNoteCreateBuilder	currencyCode(String value)
CreditNoteCreateParams.CreditNoteCreateBuilder	customerId(String value)
CreditNoteCreateParams.CreditNoteCreateBuilder	customerNotes(String value)
CreditNoteCreateParams.CreditNoteCreateBuilder	customField(String fieldName, String value)	Add a custom field to the request.
CreditNoteCreateParams.CreditNoteCreateBuilder	customFields(Map<String,String> customFields)	Add multiple custom fields to the request.
CreditNoteCreateParams.CreditNoteCreateBuilder	date(Timestamp value)
CreditNoteCreateParams.CreditNoteCreateBuilder	lineItems(List<CreditNoteCreateParams.LineItemsParams> value)
CreditNoteCreateParams.CreditNoteCreateBuilder	reasonCode(CreditNoteCreateParams.ReasonCode value)
CreditNoteCreateParams.CreditNoteCreateBuilder	referenceInvoiceId(String value)
CreditNoteCreateParams.CreditNoteCreateBuilder	total(Long value)
CreditNoteCreateParams.CreditNoteCreateBuilder	type(CreditNoteCreateParams.Type value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

referenceInvoiceId

public CreditNoteCreateParams.CreditNoteCreateBuilder referenceInvoiceId(String value)

customerId

public CreditNoteCreateParams.CreditNoteCreateBuilder customerId(String value)

total

public CreditNoteCreateParams.CreditNoteCreateBuilder total(Long value)

type

public CreditNoteCreateParams.CreditNoteCreateBuilder type(CreditNoteCreateParams.Type value)

reasonCode

public CreditNoteCreateParams.CreditNoteCreateBuilder reasonCode(CreditNoteCreateParams.ReasonCode value)

createReasonCode

public CreditNoteCreateParams.CreditNoteCreateBuilder createReasonCode(String value)

date

public CreditNoteCreateParams.CreditNoteCreateBuilder date(Timestamp value)

customerNotes

public CreditNoteCreateParams.CreditNoteCreateBuilder customerNotes(String value)

currencyCode

public CreditNoteCreateParams.CreditNoteCreateBuilder currencyCode(String value)

comment

public CreditNoteCreateParams.CreditNoteCreateBuilder comment(String value)

lineItems

public CreditNoteCreateParams.CreditNoteCreateBuilder lineItems(List<CreditNoteCreateParams.LineItemsParams> value)

customField

public CreditNoteCreateParams.CreditNoteCreateBuilder customField(String fieldName,
 String value)

Add a custom field to the request. Custom fields must start with "cf_".

Parameters:

fieldName - the name of the custom field (e.g., "cf_custom_field_name")

value - the value of the custom field

Returns:

this builder

Throws:

IllegalArgumentException - if fieldName doesn't start with "cf_"

customFields

public CreditNoteCreateParams.CreditNoteCreateBuilder customFields(Map<String,String> customFields)

Add multiple custom fields to the request. All field names must start with "cf_".

Parameters:

customFields - map of custom field names to values

Returns:

this builder

Throws:

IllegalArgumentException - if any field name doesn't start with "cf_"

build

public CreditNoteCreateParams build()