GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Tax

GET /api/taxes/producttaxcategories

200 OK
ProductTaxCategoryCollectionModel

OK

type
ProductTaxCategoryCollectionModel
Response Example (200 OK) 
[
  {
    "ProductTaxCategoryId": "integer",
    "AuditId": "integer",
    "Name": "string",
    "Actions": "string"
  }
]
Tax

POST /api/taxes/producttaxcategory

ProductTaxCategoryAddModel

undefined

Request Example
{
  "Id": "integer",
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string"
}
200 OK
ProductTaxCategoryCollectionModel

OK

Response Example (200 OK) 
{
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Actions": "string"
}
Tax

GET /api/taxes/producttaxcategory/{producttaxcategoryid}

producttaxcategoryid: integer
in path

(no description)

200 OK
ProductTaxCategoryEditModel

OK

Response Example (200 OK) 
{
  "Id": "integer",
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "TaxRegions": "string"
}
Tax

POST /api/taxes/producttaxcategory/{producttaxcategoryid}

ProductTaxCategoryEditModel

undefined

producttaxcategoryid: integer
in path

(no description)

Request Example
{
  "Id": "integer",
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "TaxRegions": "string"
}
200 OK
ProductTaxCategoryCollectionModel

OK

Response Example (200 OK) 
{
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Actions": "string"
}
Tax

DELETE /api/taxes/producttaxcategory/{producttaxcategoryid}/{auditid}

producttaxcategoryid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Tax

GET /api/taxes/producttaxcategory/lookup

200 OK
GenericLookUpChoice<Int32>

OK

type
GenericLookUpChoice<Int32>
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]
Tax

GET /api/taxes/taxitem/{taxitemid}

taxitemid: integer
in path

(no description)

200 OK
TaxItemAddEditModel

OK

Response Example (200 OK) 
{
  "TaxItemId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "Rate": "string",
  "FlatAmount": "string",
  "PayableAccountId": "integer",
  "TaxAgency": "string"
}
Tax

POST /api/taxes/taxitem/{taxitemid}

TaxItemAddEditModel

undefined

taxitemid: integer
in path

(no description)

Request Example
{
  "TaxItemId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "Rate": "string",
  "FlatAmount": "string",
  "PayableAccountId": "integer",
  "TaxAgency": "string"
}
200 OK
TaxItemCollectionItemModel

OK

Response Example (200 OK) 
{
  "TaxItemId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "Rate": "number",
  "FlatAmount": "number",
  "PayableAccountId": "integer",
  "Actions": "string"
}
Tax

DELETE /api/taxes/taxitem/{taxitemid}/{auditid}

taxitemid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Tax

GET /api/taxes/taxitem/lookup

this[]: string
in query

(no description)

length: string
in query

(no description)

200 OK

OK

Tax

GET /api/taxes/taxitems

200 OK
TaxItemCollectionItemModel

OK

type
TaxItemCollectionItemModel
Response Example (200 OK) 
[
  {
    "TaxItemId": "integer",
    "AuditId": "integer",
    "Name": "string",
    "Description": "string",
    "Rate": "number",
    "FlatAmount": "number",
    "PayableAccountId": "integer",
    "Actions": "string"
  }
]
Tax

GET /api/taxes/taxregion/{taxregionid}

taxregionid: integer
in path

(no description)

200 OK
TaxRegionAddEditModel

OK

Response Example (200 OK) 
{
  "TaxRegionId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "ProductTaxCategories": "string"
}
Tax

POST /api/taxes/taxregion/{taxregionid}

TaxRegionAddEditModel

undefined

taxregionid: integer
in path

(no description)

Request Example
{
  "TaxRegionId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "ProductTaxCategories": "string"
}
200 OK
TaxRegionCollectionModel

OK

Response Example (200 OK) 
{
  "TaxRegionId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Actions": "string"
}
Tax

DELETE /api/taxes/taxregion/{taxregionid}/{auditid}

taxregionid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Tax

GET /api/taxes/taxregion/lookup

200 OK
GenericLookUpChoice<Int32>

OK

type
GenericLookUpChoice<Int32>
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "ExtraData": "string",
    "CssColor": "string",
    "IsSelected": "boolean",
    "IsDeleted": "boolean",
    "Order": "integer"
  }
]
Tax

GET /api/taxes/taxregions

200 OK
TaxRegionCollectionModel

OK

type
TaxRegionCollectionModel
Response Example (200 OK) 
[
  {
    "TaxRegionId": "integer",
    "AuditId": "integer",
    "Name": "string",
    "Actions": "string"
  }
]
Tax

GET /api/taxes/taxrules

options: string
in query

(no description)

200 OK
ListViewReturnModel<TaxRuleCollectionItemModel>

OK

Response Example (200 OK) 
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}
Tax

POST /api/taxes/taxrules

TaxRuleAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "TaxRegionId": "string",
  "ProductTaxCategoryId": "string",
  "Criteria": "string"
}
200 OK
ListViewReturnModel<TaxRuleCollectionItemModel>

OK

Response Example (200 OK) 
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}
Tax

GET /api/taxes/taxrules/{taxregionproducttaxcategoryid}

taxregionproducttaxcategoryid: integer
in path

(no description)

200 OK
TaxRuleAddEditModel

OK

Response Example (200 OK) 
{
  "TaxRegionProductTaxCategoryId": "integer",
  "TaxRegionId": "string",
  "ProductTaxCategoryId": "string"
}
Tax

POST /api/taxes/taxrules/{taxregionproducttaxcategoryid}

TaxRuleAddEditModel

undefined

taxregionproducttaxcategoryid: integer
in path

(no description)

Request Example
{
  "TaxRegionProductTaxCategoryId": "integer",
  "TaxRegionId": "string",
  "ProductTaxCategoryId": "string"
}
200 OK
TaxRuleCollectionItemModel

OK

Response Example (200 OK) 
{
  "TaxRegionProductTaxCategoryId": "integer",
  "TaxRegionId": "integer",
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "RegionName": "string",
  "ProductTaxCategoryName": "string",
  "Actions": "string"
}
Tax

DELETE /api/taxes/taxrules/{taxregionproducttaxcategoryid}/{auditid}

taxregionproducttaxcategoryid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Tax

GET /api/taxes/taxset/{taxsetid}

taxsetid: integer
in path

(no description)

200 OK
TaxSetAddEditModel

OK

Response Example (200 OK) 
{
  "TaxSetId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "TaxRegionId": "string",
  "TaxSetItems": "string"
}
Tax

POST /api/taxes/taxset/{taxsetid}

TaxSetAddEditModel

undefined

taxsetid: integer
in path

(no description)

Request Example
{
  "TaxSetId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "TaxRegionId": "string",
  "TaxSetItems": "string"
}
200 OK
TaxSetCollectionModel

OK

Response Example (200 OK) 
{
  "TaxSetId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "CombinedRate": "number",
  "CombinedFlatAmount": "number",
  "TaxItemCount": "integer",
  "Region": "string",
  "Actions": "string"
}
Tax

DELETE /api/taxes/taxset/{taxsetid}/{auditid}

taxsetid: integer
in path

(no description)

auditid: integer
in path

(no description)

200 OK

OK

Tax

GET /api/taxes/taxset/lookup

200 OK
IQueryable

OK

type
IQueryable
Response Example (200 OK) 
[
  {
    "Expression": "string",
    "ElementType": "string",
    "Provider": "string"
  }
]
Tax

GET /api/taxes/taxsets

options: string
in query

(no description)

200 OK
TaxSetCollectionModel

OK

type
TaxSetCollectionModel
Response Example (200 OK) 
[
  {
    "TaxSetId": "integer",
    "AuditId": "integer",
    "Name": "string",
    "CombinedRate": "number",
    "CombinedFlatAmount": "number",
    "TaxItemCount": "integer",
    "Region": "string",
    "Actions": "string"
  }
]

Schema Definitions

TaxItemCollectionItemModel: object

TaxItemId: integer
AuditId: integer
Name: string
Description: string
Rate: number
FlatAmount: number
PayableAccountId: integer
Actions: string
Example
{
  "TaxItemId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "Rate": "number",
  "FlatAmount": "number",
  "PayableAccountId": "integer",
  "Actions": "string"
}

TaxItemAddEditModel: object

TaxItemId: integer
AuditId: integer
Name: string
Description: string
Rate: string
FlatAmount: string
PayableAccountId: integer
TaxAgency: string
Example
{
  "TaxItemId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Description": "string",
  "Rate": "string",
  "FlatAmount": "string",
  "PayableAccountId": "integer",
  "TaxAgency": "string"
}

Object: object

Example
"object"

IEnumerable: object

Example
"object"

TaxSetCollectionModel: object

TaxSetId: integer
AuditId: integer
Name: string
CombinedRate: number
CombinedFlatAmount: number
TaxItemCount: integer
Region: string
Actions: string
Example
{
  "TaxSetId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "CombinedRate": "number",
  "CombinedFlatAmount": "number",
  "TaxItemCount": "integer",
  "Region": "string",
  "Actions": "string"
}

TaxSetAddEditModel: object

TaxSetId: integer
AuditId: integer
Name: string
TaxRegionId: string
TaxSetItems: string
Example
{
  "TaxSetId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "TaxRegionId": "string",
  "TaxSetItems": "string"
}

IQueryable: object

Expression: string
ElementType: string
Provider: string
Example
{
  "Expression": "string",
  "ElementType": "string",
  "Provider": "string"
}

ListViewReturnModel<TaxRuleCollectionItemModel>: object

Criteria: string
CriteriaItems: string
TotalRecordAvailable: string

We typically only return a subset of what is available on the server, but lets show the user what was available

ModelItems: string
Results: string
Example
{
  "Criteria": "string",
  "CriteriaItems": "string",
  "TotalRecordAvailable": "string",
  "ModelItems": "string",
  "Results": "string"
}

TaxRuleAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
TaxRegionId: string
ProductTaxCategoryId: string
Criteria: string
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "TaxRegionId": "string",
  "ProductTaxCategoryId": "string",
  "Criteria": "string"
}

TaxRuleAddEditModel: object

TaxRegionProductTaxCategoryId: integer
TaxRegionId: string
ProductTaxCategoryId: string
Example
{
  "TaxRegionProductTaxCategoryId": "integer",
  "TaxRegionId": "string",
  "ProductTaxCategoryId": "string"
}

TaxRuleCollectionItemModel: object

TaxRegionProductTaxCategoryId: integer
TaxRegionId: integer
ProductTaxCategoryId: integer
AuditId: integer
RegionName: string
ProductTaxCategoryName: string
Actions: string
Example
{
  "TaxRegionProductTaxCategoryId": "integer",
  "TaxRegionId": "integer",
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "RegionName": "string",
  "ProductTaxCategoryName": "string",
  "Actions": "string"
}

TaxRegionCollectionModel: object

TaxRegionId: integer
AuditId: integer
Name: string
Actions: string
Example
{
  "TaxRegionId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Actions": "string"
}

TaxRegionAddEditModel: object

TaxRegionId: integer
AuditId: integer
Name: string
ProductTaxCategories: string
Example
{
  "TaxRegionId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "ProductTaxCategories": "string"
}

GenericLookUpChoice<Int32>: object

Id: integer
Name: string
ExtraData: string
CssColor: string
IsSelected: boolean
IsDeleted: boolean
Order: integer
Example
{
  "Id": "integer",
  "Name": "string",
  "ExtraData": "string",
  "CssColor": "string",
  "IsSelected": "boolean",
  "IsDeleted": "boolean",
  "Order": "integer"
}

ProductTaxCategoryCollectionModel: object

ProductTaxCategoryId: integer
AuditId: integer
Name: string
Actions: string
Example
{
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "Actions": "string"
}

ProductTaxCategoryEditModel: object

Id: integer
ProductTaxCategoryId: integer
AuditId: integer
Name: string
TaxRegions: string
Example
{
  "Id": "integer",
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string",
  "TaxRegions": "string"
}

ProductTaxCategoryAddModel: object

Id: integer
ProductTaxCategoryId: integer
AuditId: integer
Name: string
Example
{
  "Id": "integer",
  "ProductTaxCategoryId": "integer",
  "AuditId": "integer",
  "Name": "string"
}
Documentation by Spectacle