ch.aaap.harvestclient.api

Interface InvoiceItemCategoriesApi

All Superinterfaces:

Api.Create<InvoiceItem.Category>, Api.Delete<InvoiceItem.Category>, Api.Get<InvoiceItem.Category>, Api.Simple<InvoiceItem.Category>

All Known Implementing Classes:

InvoiceItemCategoriesApiImpl

public interface InvoiceItemCategoriesApi
extends Api.Simple<InvoiceItem.Category>

See Also:

Invoices API on Harvest

Method Summary

Modifier and Type	Method and Description
InvoiceItem.Category	create(InvoiceItem.Category creationInfo) Create a new InvoiceItemCategory
void	delete(Reference<InvoiceItem.Category> invoiceItemCategoryReference) Delete an existing InvoiceItemCategory.
InvoiceItem.Category	get(Reference<InvoiceItem.Category> invoiceItemCategoryReference) Return an existing InvoiceItemCategory.
List<InvoiceItem.Category>	list(Instant updatedSince)
Pagination<InvoiceItem.Category>	list(Instant updatedSince, int page, int perPage) Return a list of invoiceItemCategories, sorted by creation date, newest first.
InvoiceItem.Category	update(Reference<InvoiceItem.Category> invoiceItemCategoryReference, InvoiceItem.Category toChange) Updates the specific invoiceItemCategory by setting the values of the parameters passed.

Method Detail

list

List<InvoiceItem.Category> list(@Nullable
                                Instant updatedSince)

Parameters:

updatedSince - if set, only return categories updated since the given timestamp

Returns:

a list of all InvoiceItemCategories in the account, sorted by creation date, newest first.

list

Pagination<InvoiceItem.Category> list(@Nullable
                                      Instant updatedSince,
                                      int page,
                                      int perPage)

Return a list of invoiceItemCategories, sorted by creation date, newest first. Use the filter object to filter the list. Page and perPage allow controlling how many results to return.

Parameters:

updatedSince - if set, only return categories updated since the given timestamp

page - the page number

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

Returns:

a (filtered) list of InvoiceItemCategory

get

InvoiceItem.Category get(Reference<InvoiceItem.Category> invoiceItemCategoryReference)

Return an existing InvoiceItemCategory.

Specified by:

get in interface Api.Get<InvoiceItem.Category>

Parameters:

invoiceItemCategoryReference - a reference to an existing InvoiceItemCategory

Returns:

the full InvoiceItemCategory object

create

InvoiceItem.Category create(InvoiceItem.Category creationInfo)

Create a new InvoiceItemCategory

Specified by:

create in interface Api.Create<InvoiceItem.Category>

Parameters:

creationInfo - creation information

Returns:

the created InvoiceItemCategory

update

InvoiceItem.Category update(Reference<InvoiceItem.Category> invoiceItemCategoryReference,
                            InvoiceItem.Category toChange)

Updates the specific invoiceItemCategory by setting the values of the parameters passed. Any parameters not provided will be left unchanged

Parameters:

invoiceItemCategoryReference - An existing InvoiceItemCategory to be updated

toChange - the changes to be performed

Returns:

the updated InvoiceItemCategory

delete

void delete(Reference<InvoiceItem.Category> invoiceItemCategoryReference)

Delete an existing InvoiceItemCategory.

Specified by:

delete in interface Api.Delete<InvoiceItem.Category>

Parameters:

invoiceItemCategoryReference - a reference to the InvoiceItemCategory to be deleted