ch.aaap.harvestclient.api

Interface InvoicePaymentsApi

All Known Implementing Classes:

InvoicePaymentsApiImpl

public interface InvoicePaymentsApi

See Also:

Invoice Payments API on Harvest

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)

Method Detail

list

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

Parameters:

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

invoiceReference - the invoice containing the payments

Returns:

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

list

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

Parameters:

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

invoiceReference - the invoice containing the payments

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

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

Create a new InvoicePayment

Parameters:

invoiceReference - the invoice that will contain the payment

creationInfo - creation information

Returns:

the created InvoicePayment

delete

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

Delete an existing InvoicePayment.

Parameters:

invoiceReference - the invoice that contains the payment

invoicePaymentReference - An existing InvoicePayment to be deleted