Package 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
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(InvoiceItem.Category creationInfo) Create a new InvoiceItemCategoryvoid
delete
(Reference<InvoiceItem.Category> invoiceItemCategoryReference) Delete an existing InvoiceItemCategory.get
(Reference<InvoiceItem.Category> invoiceItemCategoryReference) Return an existing InvoiceItemCategory.Return a list of invoiceItemCategories, sorted by creation date, newest first.update
(Reference<InvoiceItem.Category> invoiceItemCategoryReference, InvoiceItem.Category toChange) Updates the specific invoiceItemCategory by setting the values of the parameters passed.
-
Method Details
-
list
- 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
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 timestamppage
- the page numberperPage
- how many results to return for one page. Max 100- Returns:
- a (filtered) list of InvoiceItemCategory
-
get
Return an existing InvoiceItemCategory.- Specified by:
get
in interfaceApi.Get<InvoiceItem.Category>
- Parameters:
invoiceItemCategoryReference
- a reference to an existing InvoiceItemCategory- Returns:
- the full InvoiceItemCategory object
-
create
Create a new InvoiceItemCategory- Specified by:
create
in interfaceApi.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 updatedtoChange
- the changes to be performed- Returns:
- the updated InvoiceItemCategory
-
delete
Delete an existing InvoiceItemCategory.- Specified by:
delete
in interfaceApi.Delete<InvoiceItem.Category>
- Parameters:
invoiceItemCategoryReference
- a reference to the InvoiceItemCategory to be deleted
-