ch.aaap.harvestclient.api

Interface InvoiceMessagesApi

All Known Implementing Classes:

InvoiceMessagesApiImpl

public interface InvoiceMessagesApi

See Also:

Invoice Messages API on Harvest

Method Summary

Modifier and Type	Method and Description
InvoiceMessage	create(Reference<Invoice> invoiceReference, InvoiceMessage creationInfo) Create a new InvoiceMessage
void	delete(Reference<Invoice> invoiceReference, Reference<InvoiceMessage> invoiceMessageReference) Delete an existing InvoiceMessage.
List<InvoiceMessage>	list(Reference<Invoice> invoiceReference, Instant updatedSince)
Pagination<InvoiceMessage>	list(Reference<Invoice> invoiceReference, Instant updatedSince, int page, int perPage)
InvoiceMessage	markAs(Reference<Invoice> invoiceReference, InvoiceMessage.EventType eventType) Change the state of an invoice to the given eventType.

Method Detail

list

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

Parameters:

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

invoiceReference - the invoice containing the messages

Returns:

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

list

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

Parameters:

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

invoiceReference - the invoice containing the messages

page - the page number

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

Returns:

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

create

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

Create a new InvoiceMessage

Parameters:

invoiceReference - the invoice that will contain the message

creationInfo - creation information

Returns:

the created InvoiceMessage

markAs

InvoiceMessage markAs(Reference<Invoice> invoiceReference,
                      InvoiceMessage.EventType eventType)

Change the state of an invoice to the given eventType. Not all transitions are allowed: see the web interface for more information

Parameters:

invoiceReference - the invoice against which to record the event

eventType - the event you want to record for this invoice

Returns:

the InvoiceMessage that was used to do the marking

delete

void delete(Reference<Invoice> invoiceReference,
            Reference<InvoiceMessage> invoiceMessageReference)

Delete an existing InvoiceMessage. Deleting an Accept Message does not change the status of the Invoice.

Parameters:

invoiceReference - the invoice that contains the message

invoiceMessageReference - An existing InvoiceMessage to be deleted