Package ch.aaap.harvestclient.api
Interface InvoicePaymentsApi
- All Known Implementing Classes:
InvoicePaymentsApiImpl
public interface InvoicePaymentsApi
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(Reference<Invoice> invoiceReference, InvoicePayment creationInfo) Create a new InvoicePaymentvoid
delete
(Reference<Invoice> invoiceReference, Reference<InvoicePayment> invoicePaymentReference) Delete an existing InvoicePayment.
-
Method Details
-
list
- 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 paymentspage
- the page numberperPage
- 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
Create a new InvoicePayment- Parameters:
invoiceReference
- the invoice that will contain the paymentcreationInfo
- creation information- Returns:
- the created InvoicePayment
-
delete
Delete an existing InvoicePayment.- Parameters:
invoiceReference
- the invoice that contains the paymentinvoicePaymentReference
- An existing InvoicePayment to be deleted
-