Package com.chargebee.v4.services

Class CreditNoteService

java.lang.Object

com.chargebee.v4.services.BaseService<CreditNoteService>

com.chargebee.v4.services.CreditNoteService

public final class CreditNoteService
extends BaseService<CreditNoteService>

Field Summary

Fields inherited from class com.chargebee.v4.services.BaseService

client, options

Constructor Summary

Constructors

Constructor	Description
CreditNoteService(ChargebeeClient client)

Method Summary

Modifier and Type	Method	Description
CreditNoteCreateResponse	create(CreditNoteCreateParams params)
CompletableFuture<CreditNoteCreateResponse>	createAsync(CreditNoteCreateParams params)	Async variant of create for creditNote with params.
CreditNotesForCustomerResponse	creditNotesForCustomer(String customerId)
CreditNotesForCustomerResponse	creditNotesForCustomer(String customerId, CreditNotesForCustomerParams params)
CompletableFuture<CreditNotesForCustomerResponse>	creditNotesForCustomerAsync(String customerId)	Async variant of creditNotesForCustomer for creditNote without params.
CompletableFuture<CreditNotesForCustomerResponse>	creditNotesForCustomerAsync(String customerId, CreditNotesForCustomerParams params)	Async variant of creditNotesForCustomer for creditNote with params.
CreditNoteDeleteResponse	delete(String creditNoteId)
CreditNoteDeleteResponse	delete(String creditNoteId, CreditNoteDeleteParams params)
CompletableFuture<CreditNoteDeleteResponse>	deleteAsync(String creditNoteId)	Async variant of delete for creditNote without params.
CompletableFuture<CreditNoteDeleteResponse>	deleteAsync(String creditNoteId, CreditNoteDeleteParams params)	Async variant of delete for creditNote with params.
CreditNoteDownloadEinvoiceResponse	downloadEinvoice(String creditNoteId)
CompletableFuture<CreditNoteDownloadEinvoiceResponse>	downloadEinvoiceAsync(String creditNoteId)	Async variant of downloadEinvoice for creditNote without params.
ImportCreditNoteResponse	importCreditNote(ImportCreditNoteParams params)
CompletableFuture<ImportCreditNoteResponse>	importCreditNoteAsync(ImportCreditNoteParams params)	Async variant of importCreditNote for creditNote with params.
CreditNoteListResponse	list()
CreditNoteListResponse	list(CreditNoteListParams params)
CompletableFuture<CreditNoteListResponse>	listAsync()	Async variant of list for creditNote without params.
CompletableFuture<CreditNoteListResponse>	listAsync(CreditNoteListParams params)	Async variant of list for creditNote with params.
CreditNotePdfResponse	pdf(String creditNoteId)
CreditNotePdfResponse	pdf(String creditNoteId, CreditNotePdfParams params)
CompletableFuture<CreditNotePdfResponse>	pdfAsync(String creditNoteId)	Async variant of pdf for creditNote without params.
CompletableFuture<CreditNotePdfResponse>	pdfAsync(String creditNoteId, CreditNotePdfParams params)	Async variant of pdf for creditNote with params.
CreditNoteRecordRefundResponse	recordRefund(String creditNoteId)
CreditNoteRecordRefundResponse	recordRefund(String creditNoteId, CreditNoteRecordRefundParams params)
CompletableFuture<CreditNoteRecordRefundResponse>	recordRefundAsync(String creditNoteId)	Async variant of recordRefund for creditNote without params.
CompletableFuture<CreditNoteRecordRefundResponse>	recordRefundAsync(String creditNoteId, CreditNoteRecordRefundParams params)	Async variant of recordRefund for creditNote with params.
CreditNoteRefundResponse	refund(String creditNoteId)
CreditNoteRefundResponse	refund(String creditNoteId, CreditNoteRefundParams params)
CompletableFuture<CreditNoteRefundResponse>	refundAsync(String creditNoteId)	Async variant of refund for creditNote without params.
CompletableFuture<CreditNoteRefundResponse>	refundAsync(String creditNoteId, CreditNoteRefundParams params)	Async variant of refund for creditNote with params.
CreditNoteRemoveTaxWithheldRefundResponse	removeTaxWithheldRefund(String creditNoteId)
CreditNoteRemoveTaxWithheldRefundResponse	removeTaxWithheldRefund(String creditNoteId, CreditNoteRemoveTaxWithheldRefundParams params)
CompletableFuture<CreditNoteRemoveTaxWithheldRefundResponse>	removeTaxWithheldRefundAsync(String creditNoteId)	Async variant of removeTaxWithheldRefund for creditNote without params.
CompletableFuture<CreditNoteRemoveTaxWithheldRefundResponse>	removeTaxWithheldRefundAsync(String creditNoteId, CreditNoteRemoveTaxWithheldRefundParams params)	Async variant of removeTaxWithheldRefund for creditNote with params.
CreditNoteResendEinvoiceResponse	resendEinvoice(String creditNoteId)
CompletableFuture<CreditNoteResendEinvoiceResponse>	resendEinvoiceAsync(String creditNoteId)	Async variant of resendEinvoice for creditNote without params.
CreditNoteRetrieveResponse	retrieve(String creditNoteId)
CreditNoteRetrieveResponse	retrieve(String creditNoteId, CreditNoteRetrieveParams params)
CompletableFuture<CreditNoteRetrieveResponse>	retrieveAsync(String creditNoteId)	Async variant of retrieve for creditNote without params.
CompletableFuture<CreditNoteRetrieveResponse>	retrieveAsync(String creditNoteId, CreditNoteRetrieveParams params)	Async variant of retrieve for creditNote with params.
CreditNoteSendEinvoiceResponse	sendEinvoice(String creditNoteId)
CompletableFuture<CreditNoteSendEinvoiceResponse>	sendEinvoiceAsync(String creditNoteId)	Async variant of sendEinvoice for creditNote without params.
VoidCreditNoteResponse	voidCreditNote(String creditNoteId)
VoidCreditNoteResponse	voidCreditNote(String creditNoteId, VoidCreditNoteParams params)
CompletableFuture<VoidCreditNoteResponse>	voidCreditNoteAsync(String creditNoteId)	Async variant of voidCreditNote for creditNote without params.
CompletableFuture<VoidCreditNoteResponse>	voidCreditNoteAsync(String creditNoteId, VoidCreditNoteParams params)	Async variant of voidCreditNote for creditNote with params.
CreditNoteService	withOptions(RequestOptions options)	Apply per-request options for this service instance.

Methods inherited from class com.chargebee.v4.services.BaseService

buildPathWithParams, clientForBuilders, clientWithOptions, get, getAsync, getMergedHeaders, getWithSubDomain, getWithSubDomainAsync, header, headers, options, parseResponse, post, postAsync, postJson, postJsonAsync, postJsonWithSubDomain, postJsonWithSubDomainAsync, postWithSubDomain, postWithSubDomainAsync

Methods inherited from class java.lang.Object

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

Constructor Details

CreditNoteService

public CreditNoteService(ChargebeeClient client)

Method Details

withOptions

public CreditNoteService withOptions(RequestOptions options)

Apply per-request options for this service instance. Users can chain .withOptions or .options to set headers and other options.

Overrides:

withOptions in class BaseService<CreditNoteService>

recordRefund

public CreditNoteRecordRefundResponse recordRefund(String creditNoteId,
 CreditNoteRecordRefundParams params)
                                            throws ChargebeeException

Throws:

ChargebeeException

recordRefundAsync

public CompletableFuture<CreditNoteRecordRefundResponse> recordRefundAsync(String creditNoteId,
 CreditNoteRecordRefundParams params)

Async variant of recordRefund for creditNote with params.

recordRefund

public CreditNoteRecordRefundResponse recordRefund(String creditNoteId)
                                            throws ChargebeeException

Throws:

ChargebeeException

recordRefundAsync

public CompletableFuture<CreditNoteRecordRefundResponse> recordRefundAsync(String creditNoteId)

Async variant of recordRefund for creditNote without params.

importCreditNote

public ImportCreditNoteResponse importCreditNote(ImportCreditNoteParams params)
                                          throws ChargebeeException

Throws:

ChargebeeException

importCreditNoteAsync

public CompletableFuture<ImportCreditNoteResponse> importCreditNoteAsync(ImportCreditNoteParams params)

Async variant of importCreditNote for creditNote with params.

delete

public CreditNoteDeleteResponse delete(String creditNoteId,
 CreditNoteDeleteParams params)
                                throws ChargebeeException

Throws:

ChargebeeException

deleteAsync

public CompletableFuture<CreditNoteDeleteResponse> deleteAsync(String creditNoteId,
 CreditNoteDeleteParams params)

Async variant of delete for creditNote with params.

delete

public CreditNoteDeleteResponse delete(String creditNoteId)
                                throws ChargebeeException

Throws:

ChargebeeException

deleteAsync

public CompletableFuture<CreditNoteDeleteResponse> deleteAsync(String creditNoteId)

Async variant of delete for creditNote without params.

creditNotesForCustomer

public CreditNotesForCustomerResponse creditNotesForCustomer(String customerId,
 CreditNotesForCustomerParams params)
                                                      throws ChargebeeException

Throws:

ChargebeeException

creditNotesForCustomer

public CreditNotesForCustomerResponse creditNotesForCustomer(String customerId)
                                                      throws ChargebeeException

Throws:

ChargebeeException

creditNotesForCustomerAsync

public CompletableFuture<CreditNotesForCustomerResponse> creditNotesForCustomerAsync(String customerId,
 CreditNotesForCustomerParams params)

Async variant of creditNotesForCustomer for creditNote with params.

creditNotesForCustomerAsync

public CompletableFuture<CreditNotesForCustomerResponse> creditNotesForCustomerAsync(String customerId)

Async variant of creditNotesForCustomer for creditNote without params.

pdf

public CreditNotePdfResponse pdf(String creditNoteId,
 CreditNotePdfParams params)
                          throws ChargebeeException

Throws:

ChargebeeException

pdfAsync

public CompletableFuture<CreditNotePdfResponse> pdfAsync(String creditNoteId,
 CreditNotePdfParams params)

Async variant of pdf for creditNote with params.

pdf

public CreditNotePdfResponse pdf(String creditNoteId)
                          throws ChargebeeException

Throws:

ChargebeeException

pdfAsync

public CompletableFuture<CreditNotePdfResponse> pdfAsync(String creditNoteId)

Async variant of pdf for creditNote without params.

sendEinvoice

public CreditNoteSendEinvoiceResponse sendEinvoice(String creditNoteId)
                                            throws ChargebeeException

Throws:

ChargebeeException

sendEinvoiceAsync

public CompletableFuture<CreditNoteSendEinvoiceResponse> sendEinvoiceAsync(String creditNoteId)

Async variant of sendEinvoice for creditNote without params.

voidCreditNote

public VoidCreditNoteResponse voidCreditNote(String creditNoteId,
 VoidCreditNoteParams params)
                                      throws ChargebeeException

Throws:

ChargebeeException

voidCreditNoteAsync

public CompletableFuture<VoidCreditNoteResponse> voidCreditNoteAsync(String creditNoteId,
 VoidCreditNoteParams params)

Async variant of voidCreditNote for creditNote with params.

voidCreditNote

public VoidCreditNoteResponse voidCreditNote(String creditNoteId)
                                      throws ChargebeeException

Throws:

ChargebeeException

voidCreditNoteAsync

public CompletableFuture<VoidCreditNoteResponse> voidCreditNoteAsync(String creditNoteId)

Async variant of voidCreditNote for creditNote without params.

refund

public CreditNoteRefundResponse refund(String creditNoteId,
 CreditNoteRefundParams params)
                                throws ChargebeeException

Throws:

ChargebeeException

refundAsync

public CompletableFuture<CreditNoteRefundResponse> refundAsync(String creditNoteId,
 CreditNoteRefundParams params)

Async variant of refund for creditNote with params.

refund

public CreditNoteRefundResponse refund(String creditNoteId)
                                throws ChargebeeException

Throws:

ChargebeeException

refundAsync

public CompletableFuture<CreditNoteRefundResponse> refundAsync(String creditNoteId)

Async variant of refund for creditNote without params.

list

public CreditNoteListResponse list(CreditNoteListParams params)
                            throws ChargebeeException

Throws:

ChargebeeException

listAsync

public CompletableFuture<CreditNoteListResponse> listAsync(CreditNoteListParams params)

Async variant of list for creditNote with params.

list

public CreditNoteListResponse list()
                            throws ChargebeeException

Throws:

ChargebeeException

listAsync

public CompletableFuture<CreditNoteListResponse> listAsync()

Async variant of list for creditNote without params.

create

public CreditNoteCreateResponse create(CreditNoteCreateParams params)
                                throws ChargebeeException

Throws:

ChargebeeException

createAsync

public CompletableFuture<CreditNoteCreateResponse> createAsync(CreditNoteCreateParams params)

Async variant of create for creditNote with params.

downloadEinvoice

public CreditNoteDownloadEinvoiceResponse downloadEinvoice(String creditNoteId)
                                                    throws ChargebeeException

Throws:

ChargebeeException

downloadEinvoiceAsync

public CompletableFuture<CreditNoteDownloadEinvoiceResponse> downloadEinvoiceAsync(String creditNoteId)

Async variant of downloadEinvoice for creditNote without params.

resendEinvoice

public CreditNoteResendEinvoiceResponse resendEinvoice(String creditNoteId)
                                                throws ChargebeeException

Throws:

ChargebeeException

resendEinvoiceAsync

public CompletableFuture<CreditNoteResendEinvoiceResponse> resendEinvoiceAsync(String creditNoteId)

Async variant of resendEinvoice for creditNote without params.

removeTaxWithheldRefund

public CreditNoteRemoveTaxWithheldRefundResponse removeTaxWithheldRefund(String creditNoteId,
 CreditNoteRemoveTaxWithheldRefundParams params)
                                                                  throws ChargebeeException

Throws:

ChargebeeException

removeTaxWithheldRefundAsync

public CompletableFuture<CreditNoteRemoveTaxWithheldRefundResponse> removeTaxWithheldRefundAsync(String creditNoteId,
 CreditNoteRemoveTaxWithheldRefundParams params)

Async variant of removeTaxWithheldRefund for creditNote with params.

removeTaxWithheldRefund

public CreditNoteRemoveTaxWithheldRefundResponse removeTaxWithheldRefund(String creditNoteId)
                                                                  throws ChargebeeException

Throws:

ChargebeeException

removeTaxWithheldRefundAsync

public CompletableFuture<CreditNoteRemoveTaxWithheldRefundResponse> removeTaxWithheldRefundAsync(String creditNoteId)

Async variant of removeTaxWithheldRefund for creditNote without params.

retrieve

public CreditNoteRetrieveResponse retrieve(String creditNoteId,
 CreditNoteRetrieveParams params)
                                    throws ChargebeeException

Throws:

ChargebeeException

retrieveAsync

public CompletableFuture<CreditNoteRetrieveResponse> retrieveAsync(String creditNoteId,
 CreditNoteRetrieveParams params)

Async variant of retrieve for creditNote with params.

retrieve

public CreditNoteRetrieveResponse retrieve(String creditNoteId)
                                    throws ChargebeeException

Throws:

ChargebeeException

retrieveAsync

public CompletableFuture<CreditNoteRetrieveResponse> retrieveAsync(String creditNoteId)

Async variant of retrieve for creditNote without params.