ch.aaap.harvestclient.impl

Class InvoicePaymentsApiImpl

Object

ch.aaap.harvestclient.impl.InvoicePaymentsApiImpl

All Implemented Interfaces:

InvoicePaymentsApi

public class InvoicePaymentsApiImpl
extends Object
implements InvoicePaymentsApi

Constructor Summary

Constructors

Constructor and Description
InvoicePaymentsApiImpl(InvoicePaymentService service)

Method Summary

Modifier and Type	Method and Description
InvoicePayment	create(Reference<Invoice> invoiceReference, InvoicePayment creationInfo) Create a new InvoicePayment
void	delete(Reference<Invoice> invoiceReference, Reference<InvoicePayment> invoicePaymentReference) Delete an existing InvoicePayment.
List<InvoicePayment>	list(Reference<Invoice> invoiceReference, Instant updatedSince)
Pagination<InvoicePayment>	list(Reference<Invoice> invoiceReference, Instant updatedSince, int page, int perPage)

Methods inherited from class Object

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

Constructor Detail

InvoicePaymentsApiImpl

public InvoicePaymentsApiImpl(InvoicePaymentService service)

Method Detail

list

public List<InvoicePayment> list(Reference<Invoice> invoiceReference,
                                 Instant updatedSince)

Specified by:

list in interface InvoicePaymentsApi

Parameters:

invoiceReference - the invoice containing the payments

updatedSince - return only InvoicePayments that have been updated at least 1 second after updatedSince. Set to null to disable filtering.

Returns:

a list of all InvoicePayments in the invoice, sorted by creation date, newest first.

list

public Pagination<InvoicePayment> list(Reference<Invoice> invoiceReference,
                                       Instant updatedSince,
                                       int page,
                                       int perPage)

Specified by:

list in interface InvoicePaymentsApi

Parameters:

invoiceReference - the invoice containing the payments

updatedSince - return only InvoicePayments that have been updated at least 1 second after updatedSince. Set to null to disable filtering.

page - the page number

perPage - how many results to return for one page. Max 100

Returns:

a list of all InvoicePayments in the invoice, sorted by creation date, newest first.

create

public InvoicePayment create(Reference<Invoice> invoiceReference,
                             InvoicePayment creationInfo)

Description copied from interface: InvoicePaymentsApi

Create a new InvoicePayment

Specified by:

create in interface InvoicePaymentsApi

Parameters:

invoiceReference - the invoice that will contain the payment

creationInfo - creation information

Returns:

the created InvoicePayment

delete

public void delete(Reference<Invoice> invoiceReference,
                   Reference<InvoicePayment> invoicePaymentReference)

Description copied from interface: InvoicePaymentsApi

Delete an existing InvoicePayment.

Specified by:

delete in interface InvoicePaymentsApi

Parameters:

invoiceReference - the invoice that contains the payment

invoicePaymentReference - An existing InvoicePayment to be deleted