ch.aaap.harvestclient.impl

Class InvoiceItemCategoriesApiImpl

Object

ch.aaap.harvestclient.impl.InvoiceItemCategoriesApiImpl

All Implemented Interfaces:

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

public class InvoiceItemCategoriesApiImpl
extends Object
implements InvoiceItemCategoriesApi

Constructor Summary

Constructors

Constructor and Description
InvoiceItemCategoriesApiImpl(InvoiceItemCategoryService service)

Method Summary

Modifier and Type	Method and Description
InvoiceItem.Category	create(InvoiceItem.Category creationInfo) Create a new InvoiceItemCategory
void	delete(Reference<InvoiceItem.Category> categoryReference) Delete an existing InvoiceItemCategory.
InvoiceItem.Category	get(Reference<InvoiceItem.Category> categoryReference) 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> categoryReference, InvoiceItem.Category toChange) Updates the specific invoiceItemCategory by setting the values of the parameters passed.

Methods inherited from class Object

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

Constructor Detail

InvoiceItemCategoriesApiImpl

public InvoiceItemCategoriesApiImpl(InvoiceItemCategoryService service)

Method Detail

list

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

Specified by:

list in interface InvoiceItemCategoriesApi

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

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

Description copied from interface: InvoiceItemCategoriesApi

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.

Specified by:

list in interface InvoiceItemCategoriesApi

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

public InvoiceItem.Category get(Reference<InvoiceItem.Category> categoryReference)

Description copied from interface: InvoiceItemCategoriesApi

Return an existing InvoiceItemCategory.

Specified by:

get in interface Api.Get<InvoiceItem.Category>

Specified by:

get in interface InvoiceItemCategoriesApi

Parameters:

categoryReference - a reference to an existing InvoiceItemCategory

Returns:

the full InvoiceItemCategory object

create

public InvoiceItem.Category create(InvoiceItem.Category creationInfo)

Description copied from interface: InvoiceItemCategoriesApi

Create a new InvoiceItemCategory

Specified by:

create in interface Api.Create<InvoiceItem.Category>

Specified by:

create in interface InvoiceItemCategoriesApi

Parameters:

creationInfo - creation information

Returns:

the created InvoiceItemCategory

update

public InvoiceItem.Category update(Reference<InvoiceItem.Category> categoryReference,
                                   InvoiceItem.Category toChange)

Description copied from interface: InvoiceItemCategoriesApi

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

Specified by:

update in interface InvoiceItemCategoriesApi

Parameters:

categoryReference - An existing InvoiceItemCategory to be updated

toChange - the changes to be performed

Returns:

the updated InvoiceItemCategory

delete

public void delete(Reference<InvoiceItem.Category> categoryReference)

Description copied from interface: InvoiceItemCategoriesApi

Delete an existing InvoiceItemCategory.

Specified by:

delete in interface Api.Delete<InvoiceItem.Category>

Specified by:

delete in interface InvoiceItemCategoriesApi

Parameters:

categoryReference - a reference to the InvoiceItemCategory to be deleted