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
GET /api/saleableitems
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"SaleableItemTypeId": "string",
"CategoryItemId": "string",
"AccountId": "string",
"ShowActive": "boolean",
"AccountType": "string",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/saleableitems/{saleableitemid}
(no description)
OK
Response Example (200 OK)
{
"SaleableItemId": "integer",
"AuditId": "integer",
"CanEdit": "boolean",
"Name": "string",
"SaleableItemTypeId": "string",
"CategoryListId": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"Description": "string",
"ProductDescription": "string",
"Price": "number",
"Quantity": "number",
"AccountingTypeId": "string",
"IncomeAccountId": "string",
"DepositAccountId": "string",
"ReceivablesAccountId": "string",
"ProductTaxCategoryId": "string",
"TaxSetId": "string",
"TaxSetName": "string",
"IsRecurring": "boolean",
"IsVoluntary": "boolean",
"RequireConfirmation": "boolean",
"ConfirmationMessage": "string",
"RevenueRecognitionTypeId": "integer",
"ShowDeferredIncomeAccountId": "boolean",
"DeferredIncomeAccountId": "string",
"DefaultRevenueRecognitionMonths": "string",
"DocumentGenerationTemplateId": "string",
"ProductImage": "string",
"UsingBillhighway": "boolean",
"BillhighwayTemplateId": "integer",
"ValidStartDate": "string",
"ValidEndDate": "string",
"ProrationAllowedUntil": "string",
"SubsequentSaleableItemId": "string",
"SplitAssociation": "string",
"AssociationBankId": "string",
"NRDSPaymentType": "string",
"MembershipTypes": "string",
"IsDeletable": "boolean",
"BestPracticesEnabled": "boolean",
"DisableDelete": "boolean",
"DisableDeleteMessage": "string",
"CanEditBillingFields": "boolean",
"AllowProratePlus": "boolean",
"Edition": "string"
}
POST /api/saleableitems/{saleableitemid}
undefined
(no description)
Request Example
{
"SaleableItemId": "integer",
"AuditId": "integer",
"CanEdit": "boolean",
"Name": "string",
"SaleableItemTypeId": "string",
"CategoryListId": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"Description": "string",
"ProductDescription": "string",
"Price": "number",
"Quantity": "number",
"AccountingTypeId": "string",
"IncomeAccountId": "string",
"DepositAccountId": "string",
"ReceivablesAccountId": "string",
"ProductTaxCategoryId": "string",
"TaxSetId": "string",
"TaxSetName": "string",
"IsRecurring": "boolean",
"IsVoluntary": "boolean",
"RequireConfirmation": "boolean",
"ConfirmationMessage": "string",
"RevenueRecognitionTypeId": "integer",
"ShowDeferredIncomeAccountId": "boolean",
"DeferredIncomeAccountId": "string",
"DefaultRevenueRecognitionMonths": "string",
"DocumentGenerationTemplateId": "string",
"ProductImage": "string",
"UsingBillhighway": "boolean",
"BillhighwayTemplateId": "integer",
"ValidStartDate": "string",
"ValidEndDate": "string",
"ProrationAllowedUntil": "string",
"SubsequentSaleableItemId": "string",
"SplitAssociation": "string",
"AssociationBankId": "string",
"NRDSPaymentType": "string",
"MembershipTypes": "string",
"IsDeletable": "boolean",
"BestPracticesEnabled": "boolean",
"DisableDelete": "boolean",
"DisableDeleteMessage": "string",
"CanEditBillingFields": "boolean",
"AllowProratePlus": "boolean",
"Edition": "string"
}
OK
Response Example (200 OK)
{
"SaleableItemId": "integer",
"ItemTypeId": "string",
"ItemType": "string",
"CategoryName": "string",
"Name": "string",
"IncomeAccount": "string",
"AccountingTypeId": "string",
"Price": "number",
"IsActive": "boolean",
"Actions": "string",
"Description": "string",
"Quantity": "number",
"TotalRecordAvailable": "integer"
}
DELETE /api/saleableitems/delete/{saleableitemid}/{auditid}
(no description)
(no description)
OK
GET /api/saleableitems/duplicate/{saleableitemid}
(no description)
OK
Response Example (200 OK)
{
"SaleableItemId": "integer",
"AuditId": "integer",
"CanEdit": "boolean",
"Name": "string",
"SaleableItemTypeId": "string",
"CategoryListId": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"Description": "string",
"ProductDescription": "string",
"Price": "number",
"Quantity": "number",
"AccountingTypeId": "string",
"IncomeAccountId": "string",
"DepositAccountId": "string",
"ReceivablesAccountId": "string",
"ProductTaxCategoryId": "string",
"TaxSetId": "string",
"TaxSetName": "string",
"IsRecurring": "boolean",
"IsVoluntary": "boolean",
"RequireConfirmation": "boolean",
"ConfirmationMessage": "string",
"RevenueRecognitionTypeId": "integer",
"ShowDeferredIncomeAccountId": "boolean",
"DeferredIncomeAccountId": "string",
"DefaultRevenueRecognitionMonths": "string",
"DocumentGenerationTemplateId": "string",
"ProductImage": "string",
"UsingBillhighway": "boolean",
"BillhighwayTemplateId": "integer",
"ValidStartDate": "string",
"ValidEndDate": "string",
"ProrationAllowedUntil": "string",
"SubsequentSaleableItemId": "string",
"SplitAssociation": "string",
"AssociationBankId": "string",
"NRDSPaymentType": "string",
"MembershipTypes": "string",
"IsDeletable": "boolean",
"BestPracticesEnabled": "boolean",
"DisableDelete": "boolean",
"DisableDeleteMessage": "string",
"CanEditBillingFields": "boolean",
"AllowProratePlus": "boolean",
"Edition": "string"
}
GET /api/saleableitems/eventsaleableitems/{saleableitemid}
(no description)
OK
Response Example (200 OK)
{
"SaleableItemId": "integer",
"AuditId": "integer",
"CanEdit": "boolean",
"Name": "string",
"SaleableItemTypeId": "string",
"CategoryListId": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"Description": "string",
"ProductDescription": "string",
"Price": "number",
"Quantity": "number",
"AccountingTypeId": "string",
"IncomeAccountId": "string",
"DepositAccountId": "string",
"ReceivablesAccountId": "string",
"ProductTaxCategoryId": "string",
"TaxSetId": "string",
"TaxSetName": "string",
"IsRecurring": "boolean",
"IsVoluntary": "boolean",
"RequireConfirmation": "boolean",
"ConfirmationMessage": "string",
"RevenueRecognitionTypeId": "integer",
"ShowDeferredIncomeAccountId": "boolean",
"DeferredIncomeAccountId": "string",
"DefaultRevenueRecognitionMonths": "string",
"DocumentGenerationTemplateId": "string",
"ProductImage": "string",
"UsingBillhighway": "boolean",
"BillhighwayTemplateId": "integer",
"ValidStartDate": "string",
"ValidEndDate": "string",
"ProrationAllowedUntil": "string",
"SubsequentSaleableItemId": "string",
"SplitAssociation": "string",
"AssociationBankId": "string",
"NRDSPaymentType": "string",
"MembershipTypes": "string",
"IsDeletable": "boolean",
"BestPracticesEnabled": "boolean",
"DisableDelete": "boolean",
"DisableDeleteMessage": "string",
"CanEditBillingFields": "boolean",
"AllowProratePlus": "boolean",
"Edition": "string"
}
POST /api/saleableitems/eventsaleableitems/{saleableitemid}
undefined
(no description)
Request Example
{
"SaleableItemId": "integer",
"AuditId": "integer",
"CanEdit": "boolean",
"Name": "string",
"SaleableItemTypeId": "string",
"CategoryListId": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"Description": "string",
"ProductDescription": "string",
"Price": "number",
"Quantity": "number",
"AccountingTypeId": "string",
"IncomeAccountId": "string",
"DepositAccountId": "string",
"ReceivablesAccountId": "string",
"ProductTaxCategoryId": "string",
"TaxSetId": "string",
"TaxSetName": "string",
"IsRecurring": "boolean",
"IsVoluntary": "boolean",
"RequireConfirmation": "boolean",
"ConfirmationMessage": "string",
"RevenueRecognitionTypeId": "integer",
"ShowDeferredIncomeAccountId": "boolean",
"DeferredIncomeAccountId": "string",
"DefaultRevenueRecognitionMonths": "string",
"DocumentGenerationTemplateId": "string",
"ProductImage": "string",
"UsingBillhighway": "boolean",
"BillhighwayTemplateId": "integer",
"ValidStartDate": "string",
"ValidEndDate": "string",
"ProrationAllowedUntil": "string",
"SubsequentSaleableItemId": "string",
"SplitAssociation": "string",
"AssociationBankId": "string",
"NRDSPaymentType": "string",
"MembershipTypes": "string",
"IsDeletable": "boolean",
"BestPracticesEnabled": "boolean",
"DisableDelete": "boolean",
"DisableDeleteMessage": "string",
"CanEditBillingFields": "boolean",
"AllowProratePlus": "boolean",
"Edition": "string"
}
OK
Response Example (200 OK)
{
"SaleableItemId": "integer",
"ItemTypeId": "string",
"ItemType": "string",
"CategoryName": "string",
"Name": "string",
"IncomeAccount": "string",
"AccountingTypeId": "string",
"Price": "number",
"IsActive": "boolean",
"Actions": "string",
"Description": "string",
"Quantity": "number",
"TotalRecordAvailable": "integer"
}
POST /api/saleableitems/exporttoexcel
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"SaleableItemTypeId": "string",
"CategoryItemId": "string",
"AccountId": "string",
"ShowActive": "boolean",
"AccountType": "string",
"Criteria": "string"
}
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/saleableitems/getnarfinancialmappingsaleableitems/lookup
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/getnarsplitssaleableitems/lookup
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/{purchaseid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/certification/saleableitems/{saleableitemid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
Returns list of saleable items of type: Event Sponsorship, Event Registration, Miscellanous
Returns list of saleable items of type: Event Sponsorship, Event Registration, Miscellanous
(no description)
OK
Response Example (200 OK)
[
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}
]
Returns list of saleable items of type: Event Sponsorship, Event Registration, Miscellanous
Returns list of saleable items of type: Event Sponsorship, Event Registration, Miscellanous
(no description)
OK
Response Example (200 OK)
[
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}
]
Returns list of saleable items of type: Event No Show
Returns list of saleable items of type: Event No Show
(no description)
OK
Response Example (200 OK)
[
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}
]
GET /api/saleableitems/lookup/getsaleableitemsforreinsert
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/membership/onetimefee
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/membership/prorateplus/recurringfee
OK
Response Example (200 OK)
[
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}
]
GET /api/saleableitems/lookup/membership/recurringfee
OK
Response Example (200 OK)
[
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}
]
GET /api/saleableitems/lookup/nonduessaleableitems
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/nonvoluntary/{purchaseid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/saleableitemtypes
OK
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
GET /api/saleableitems/lookup/salesproposal/allfees
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/salesproposal/onetimefee
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/salesproposal/recurringfee
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/schedulledbillings/{scheduledbillingid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/storesaleableaddonitems
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/lookup/storesaleableitems
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/membershipfee/lookup/{purchaseid}
(no description)
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/saleableitems/saleableitemlatefees/lookup
OK
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
Schema Definitions
ListViewReturnModel<SaleableItemCollectionItemModel>: 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"
}
SaleableItemAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- SaleableItemTypeId: string
- CategoryItemId: string
- AccountId: string
- ShowActive: boolean
- AccountType: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"SaleableItemTypeId": "string",
"CategoryItemId": "string",
"AccountId": "string",
"ShowActive": "boolean",
"AccountType": "string",
"Criteria": "string"
}
HttpResponseMessage: object
- Version: string
- Content: string
- StatusCode: string
- ReasonPhrase: string
- Headers: string
- RequestMessage: string
- IsSuccessStatusCode: boolean
Example
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
SaleableItemAddEditModel: object
- SaleableItemId: integer
- AuditId: integer
- CanEdit: boolean
- Name: string
- SaleableItemTypeId: string
- CategoryListId: string
- CategoryTypeId: string
- CategoryItemId: string
- IsActive: boolean
- Description: string
- ProductDescription: string
- Price: number
- Quantity: number
- AccountingTypeId: string
- IncomeAccountId: string
- DepositAccountId: string
- ReceivablesAccountId: string
- ProductTaxCategoryId: string
- TaxSetId: string
- TaxSetName: string
- IsRecurring: boolean
- IsVoluntary: boolean
- RequireConfirmation: boolean
- ConfirmationMessage: string
- RevenueRecognitionTypeId: integer
- ShowDeferredIncomeAccountId: boolean
- DeferredIncomeAccountId: string
- DefaultRevenueRecognitionMonths: string
- DocumentGenerationTemplateId: string
- ProductImage: string
- UsingBillhighway: boolean
- BillhighwayTemplateId: integer
- ValidStartDate: string
- ValidEndDate: string
- ProrationAllowedUntil: string
- SubsequentSaleableItemId: string
- SplitAssociation: string
- AssociationBankId: string
- NRDSPaymentType: string
- MembershipTypes: string
- IsDeletable: boolean
- BestPracticesEnabled: boolean
- DisableDelete: boolean
- DisableDeleteMessage: string
- CanEditBillingFields: boolean
- AllowProratePlus: boolean
- Edition: string
Example
{
"SaleableItemId": "integer",
"AuditId": "integer",
"CanEdit": "boolean",
"Name": "string",
"SaleableItemTypeId": "string",
"CategoryListId": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"Description": "string",
"ProductDescription": "string",
"Price": "number",
"Quantity": "number",
"AccountingTypeId": "string",
"IncomeAccountId": "string",
"DepositAccountId": "string",
"ReceivablesAccountId": "string",
"ProductTaxCategoryId": "string",
"TaxSetId": "string",
"TaxSetName": "string",
"IsRecurring": "boolean",
"IsVoluntary": "boolean",
"RequireConfirmation": "boolean",
"ConfirmationMessage": "string",
"RevenueRecognitionTypeId": "integer",
"ShowDeferredIncomeAccountId": "boolean",
"DeferredIncomeAccountId": "string",
"DefaultRevenueRecognitionMonths": "string",
"DocumentGenerationTemplateId": "string",
"ProductImage": "string",
"UsingBillhighway": "boolean",
"BillhighwayTemplateId": "integer",
"ValidStartDate": "string",
"ValidEndDate": "string",
"ProrationAllowedUntil": "string",
"SubsequentSaleableItemId": "string",
"SplitAssociation": "string",
"AssociationBankId": "string",
"NRDSPaymentType": "string",
"MembershipTypes": "string",
"IsDeletable": "boolean",
"BestPracticesEnabled": "boolean",
"DisableDelete": "boolean",
"DisableDeleteMessage": "string",
"CanEditBillingFields": "boolean",
"AllowProratePlus": "boolean",
"Edition": "string"
}
SaleableItemCollectionItemModel: object
- SaleableItemId: integer
- ItemTypeId: string
- ItemType: string
- CategoryName: string
- Name: string
- IncomeAccount: string
- AccountingTypeId: string
- Price: number
- IsActive: boolean
- Actions: string
- Description: string
- Quantity: number
- TotalRecordAvailable: integer
Example
{
"SaleableItemId": "integer",
"ItemTypeId": "string",
"ItemType": "string",
"CategoryName": "string",
"Name": "string",
"IncomeAccount": "string",
"AccountingTypeId": "string",
"Price": "number",
"IsActive": "boolean",
"Actions": "string",
"Description": "string",
"Quantity": "number",
"TotalRecordAvailable": "integer"
}
IQueryable: object
- Expression: string
- ElementType: string
- Provider: string
Example
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
ItemChoiceModel: object
- IsSelected: boolean
- PreviouslySelected: boolean
- Id: integer
- Name: string
- Order: integer
Example
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
FeeItemChoiceItemModel: object
- Id: string
- TenantId: integer
- PriceFormulaEnabled: boolean
- Name: string
- Description: string
- Quantity: number
- AmountFrequencyDisplayTypeId: string
- Price: string
- PerBillingAmount: string
- CustomPerBillAmount: string
- Amount: string
- BillFrequencyTypeId: string
- HideOnInvoice: boolean
- IsVoluntary: boolean
- SaleableItemTypeId: string
- ValidStartDate: string
Example
{
"Id": "string",
"TenantId": "integer",
"PriceFormulaEnabled": "boolean",
"Name": "string",
"Description": "string",
"Quantity": "number",
"AmountFrequencyDisplayTypeId": "string",
"Price": "string",
"PerBillingAmount": "string",
"CustomPerBillAmount": "string",
"Amount": "string",
"BillFrequencyTypeId": "string",
"HideOnInvoice": "boolean",
"IsVoluntary": "boolean",
"SaleableItemTypeId": "string",
"ValidStartDate": "string"
}