ITaxService
Defines the Vendr Tax service
public interface ITaxService : ICachedEntityService<TaxClassReadOnly>, IServiceInheritance
- interface ICachedEntityService<TEntityType>
- interface IService
Namespace
Methods
DeleteTaxClass (1 of 2)
Deletes a TaxClass
public void DeleteTaxClass(Guid id)Parameters
| Parameter | Description |
|---|---|
id |
The ID of the TaxClass to delete |
DeleteTaxClass (2 of 2)
Deletes a TaxClass
public void DeleteTaxClass(TaxClass entity)Parameters
| Parameter | Description |
|---|---|
entity |
The TaxClass to delete |
GetTaxClass (1 of 2)
Get a TaxClassReadOnly entity by ID
public TaxClassReadOnly GetTaxClass(Guid id)Parameters
| Parameter | Description |
|---|---|
id |
The ID of the TaxClassReadOnly entity to fetch |
Returns
A TaxClassReadOnly entity
GetTaxClass (2 of 2)
Get a TaxClassReadOnly entity by Store and Alias
public TaxClassReadOnly GetTaxClass(Guid storeId, string alias)Parameters
| Parameter | Description |
|---|---|
storeId |
The ID of the Store the TaxClassReadOnly entity belongs to |
alias |
The Alias of the TaxClassReadOnly entity to fetch |
Returns
A TaxClassReadOnly entity
GetTaxClasses
Get a list of all TaxClassReadOnly entities from the given Store
public IEnumerable<TaxClassReadOnly> GetTaxClasses(Guid storeId)Parameters
| Parameter | Description |
|---|---|
storeId |
The ID of the Store the TaxClassReadOnly entities belong to |
Returns
A list of TaxClassReadOnly entities
SaveTaxClass
Saves a TaxClass
public void SaveTaxClass(TaxClass entity)Parameters
| Parameter | Description |
|---|---|
entity |
The TaxClass to save |
SortTaxClasses
Sorts a list of TaxClass entities by ID according to the order of those IDs
public void SortTaxClasses(Guid[] sortedIds)Parameters
| Parameter | Description |
|---|---|
sortedIds |
The IDs of the TaxClass entities to sort, in the order by which to sort them |
TaxClassExists
Check to see if a TaxClassReadOnly exists in the given Store with the given Alias
public bool TaxClassExists(Guid storeId, string alias)Parameters
| Parameter | Description |
|---|---|
storeId |
The ID of the Store the TaxClassReadOnly entity belongs to |
alias |
The Alias of the TaxClassReadOnly entity to check |
Returns
Returns true if the TaxClassReadOnly exists, otherwise returns false.