GrowthZone REST API API Reference
undefined
API Endpoint
https://app.memberzone.orgRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0
Paths
GET /api/account/{accountid}
accountid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"AccountId": "integer",
"AuditId": "integer",
"AccountName": "string",
"AccountNumber": "string",
"AccountDescription": "string",
"IsActive": "boolean",
"SystemAccountTypeId": "string",
"ChapterContactId": "string"
}
POST /api/account/{accountid}
undefined
accountid:
integer
in path
(no description)
Request Example
{
"AccountId": "integer",
"AuditId": "integer",
"AccountName": "string",
"AccountNumber": "string",
"AccountDescription": "string",
"IsActive": "boolean",
"SystemAccountTypeId": "string",
"ChapterContactId": "string"
}
200 OK
OK
Response Example (200 OK)
{
"AccountId": "integer",
"AuditId": "integer",
"AccountNumber": "string",
"AccountName": "string",
"Description": "string",
"SystemAccountTypeId": "string",
"AccountType": "string",
"IsActive": "boolean",
"Name": "string",
"Actions": "string",
"TotalRecordAvailable": "integer"
}
DELETE /api/account/{accountid}
accountid:
integer
in path
(no description)
200 OK
OK
POST /api/account/accounting/export/load
undefined
Request Example
{
"SelectedIds": "string",
"CurrentAdvancedFilter": "string",
"ConnectionId": "string",
"RecordsToExport": "integer",
"ExportType": "string",
"IsSummaryMode": "boolean",
"SummaryTxnDate": "string",
"ARAccounts": "string",
"UseAccountNumbers": "boolean",
"MarkRecordsExported": "boolean",
"BatchName": "string",
"BaseDownloadUrl": "string"
}
OK
Response Example (200 OK)
{
"SelectedIds": "string",
"CurrentAdvancedFilter": "string",
"ConnectionId": "string",
"RecordsToExport": "integer",
"ExportType": "string",
"IsSummaryMode": "boolean",
"SummaryTxnDate": "string",
"ARAccounts": "string",
"UseAccountNumbers": "boolean",
"MarkRecordsExported": "boolean",
"BatchName": "string",
"BaseDownloadUrl": "string"
}
POST /api/account/accounting/export/performexport
undefined
Request Example
{
"SelectedIds": "string",
"CurrentAdvancedFilter": "string",
"ConnectionId": "string",
"RecordsToExport": "integer",
"ExportType": "string",
"IsSummaryMode": "boolean",
"SummaryTxnDate": "string",
"ARAccounts": "string",
"UseAccountNumbers": "boolean",
"MarkRecordsExported": "boolean",
"BatchName": "string",
"BaseDownloadUrl": "string"
}
200 OK
OK
Response Example (200 OK)
{
"JobType": "string",
"Message": "string",
"Result": "string",
"BackgroundJobEstimatedSeconds": "integer",
"JobId": "string",
"PendingDownloadFileId": "integer"
}
POST /api/account/accounting/export/transactions
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"AccountId": "string",
"TenantId": "integer",
"DateRange": "string",
"ExcludeRefundTransactions": "boolean",
"TransactionType": "string",
"PaymentType": "string",
"GoodsAndServiceTypes": "string",
"AccountType": "string",
"DepositId": "string",
"ExcludePreviouslyExportedTransactions": "boolean",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/account/accounting/export/types/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/accountingtype/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/availablemodules
200 OK
OK
Response Example (200 OK)
{
"EditionId": "integer",
"Modules": "string",
"Message": "string"
}
POST /api/account/availablemodules
undefined
Request Example
{
"EditionId": "integer",
"Modules": "string",
"Message": "string"
}
200 OK
OK
Response Example (200 OK)
{
"EditionId": "integer",
"Modules": "string",
"Message": "string"
}
GET /api/account/deferreddiscountaccount/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/deferredincomeaccount/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/depositaccount/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/discountaccount/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/editions/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
DELETE /api/account/export/deletebatch/{transactionexportbatchid}
transactionexportbatchid:
integer
in path
(no description)
200 OK
OK
GET /api/account/export/list
OK
Response Example (200 OK)
{
"Items": "string"
}
GET /api/account/incomeaccount/lookup/{incomeaccountid}
incomeaccountid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/incomeaccount/lookup/multi/{incomeaccountid}
incomeaccountid:
string
in path
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
GET /api/account/items
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"SystemAccountTypeId": "string",
"ShowActive": "boolean",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/account/items/export
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"SystemAccountTypeId": "string",
"ShowActive": "boolean",
"Criteria": "string"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/account/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/lookup/active
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/lookup/currentasset
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/periods
200 OK
OK
Response Example (200 OK)
{
"ClosedPeriodId": "integer",
"PeriodBeginDate": "string",
"PeriodEndDate": "string",
"AddedByContactId": "integer",
"CreatedBy": "string",
"CreatedOn": "string",
"CreatedAtOffset": "string",
"ClosedPeriodEntryTypeId": "string",
"ForceSave": "boolean"
}
GET /api/account/periods/{closedperiodid}
closedperiodid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ClosedPeriodId": "integer",
"PeriodBeginDate": "string",
"PeriodEndDate": "string",
"AddedByContactId": "integer",
"CreatedBy": "string",
"CreatedOn": "string",
"CreatedAtOffset": "string",
"ClosedPeriodEntryTypeId": "string",
"ForceSave": "boolean",
"CssClass": "string",
"Accounts": "string"
}
POST /api/account/periods/{closedperiodid}
undefined
closedperiodid:
integer
in path
(no description)
Request Example
{
"ClosedPeriodId": "integer",
"PeriodBeginDate": "string",
"PeriodEndDate": "string",
"AddedByContactId": "integer",
"CreatedBy": "string",
"CreatedOn": "string",
"CreatedAtOffset": "string",
"ClosedPeriodEntryTypeId": "string",
"ForceSave": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"ClosedPeriodId": "integer",
"DisableCreatePeriod": "boolean",
"PeriodBeginDate": "string",
"PeriodEndDate": "string",
"Status": "string",
"CreatedBy": "string",
"ReopenedBy": "string",
"ReopenedByContactId": "string",
"CreatedOn": "string",
"AddedByContactId": "integer",
"CreatedAtOffset": "string",
"ClosedPeriodEntryTypeId": "string",
"AuditId": "integer",
"IsDeleted": "boolean",
"Actions": "string"
}
POST /api/account/periods/list
Request Example
"object"
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/account/receivableaccount/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/account/revenueaccount/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
Schema Definitions
ListViewReturnModel<ChartOfAccountListItemModel>: 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"
}
ChartOfAccountAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- SystemAccountTypeId: string
- ShowActive: boolean
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"SystemAccountTypeId": "string",
"ShowActive": "boolean",
"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"
}
AddEditChartOfAccountsModel: object
- AccountId: integer
- AuditId: integer
- AccountName: string
- AccountNumber: string
- AccountDescription: string
- IsActive: boolean
- SystemAccountTypeId: string
- ChapterContactId: string
Example
{
"AccountId": "integer",
"AuditId": "integer",
"AccountName": "string",
"AccountNumber": "string",
"AccountDescription": "string",
"IsActive": "boolean",
"SystemAccountTypeId": "string",
"ChapterContactId": "string"
}
ChartOfAccountListItemModel: object
- AccountId: integer
- AuditId: integer
- AccountNumber: string
- AccountName: string
- Description: string
- SystemAccountTypeId: string
- AccountType: string
- IsActive: boolean
- Name: string
- Actions: string
- TotalRecordAvailable: integer
Example
{
"AccountId": "integer",
"AuditId": "integer",
"AccountNumber": "string",
"AccountName": "string",
"Description": "string",
"SystemAccountTypeId": "string",
"AccountType": "string",
"IsActive": "boolean",
"Name": "string",
"Actions": "string",
"TotalRecordAvailable": "integer"
}
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"
}
ItemChoiceModel: object
- IsSelected: boolean
- PreviouslySelected: boolean
- Id: integer
- Name: string
- Order: integer
Example
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
UpgradeTrialModulesViewModel: object
- EditionId: integer
- Modules: string
- Message: string
Example
{
"EditionId": "integer",
"Modules": "string",
"Message": "string"
}
ListViewReturnModel<AccountingExportViewModel>: 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"
}
AccountingExportAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- AccountId: string
- TenantId: integer
- DateRange: string
- ExcludeRefundTransactions: boolean
- TransactionType: string
- PaymentType: string
- GoodsAndServiceTypes: string
- AccountType: string
- DepositId: string
- ExcludePreviouslyExportedTransactions: boolean
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"AccountId": "string",
"TenantId": "integer",
"DateRange": "string",
"ExcludeRefundTransactions": "boolean",
"TransactionType": "string",
"PaymentType": "string",
"GoodsAndServiceTypes": "string",
"AccountType": "string",
"DepositId": "string",
"ExcludePreviouslyExportedTransactions": "boolean",
"Criteria": "string"
}
AccountingExportViewModelDialog: object
- SelectedIds: string
- CurrentAdvancedFilter: string
- ConnectionId: string
- RecordsToExport: integer
- ExportType: string
- IsSummaryMode: boolean
- SummaryTxnDate: string
- ARAccounts: string
- UseAccountNumbers: boolean
- MarkRecordsExported: boolean
- BatchName: string
- BaseDownloadUrl: string
Example
{
"SelectedIds": "string",
"CurrentAdvancedFilter": "string",
"ConnectionId": "string",
"RecordsToExport": "integer",
"ExportType": "string",
"IsSummaryMode": "boolean",
"SummaryTxnDate": "string",
"ARAccounts": "string",
"UseAccountNumbers": "boolean",
"MarkRecordsExported": "boolean",
"BatchName": "string",
"BaseDownloadUrl": "string"
}
PendingFileDownloadResult: object
- JobType: string
- Message: string
- Result: string
- BackgroundJobEstimatedSeconds: integer
- JobId: string
- PendingDownloadFileId: integer
Example
{
"JobType": "string",
"Message": "string",
"Result": "string",
"BackgroundJobEstimatedSeconds": "integer",
"JobId": "string",
"PendingDownloadFileId": "integer"
}
ListViewReturnModel<ClosingPeriodListItemModel>: 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"
}
AddClosedPeriodModel: object
- ClosedPeriodId: integer
- PeriodBeginDate: string
- PeriodEndDate: string
- AddedByContactId: integer
- CreatedBy: string
- CreatedOn: string
- CreatedAtOffset: string
- ClosedPeriodEntryTypeId: string
- ForceSave: boolean
Example
{
"ClosedPeriodId": "integer",
"PeriodBeginDate": "string",
"PeriodEndDate": "string",
"AddedByContactId": "integer",
"CreatedBy": "string",
"CreatedOn": "string",
"CreatedAtOffset": "string",
"ClosedPeriodEntryTypeId": "string",
"ForceSave": "boolean"
}
OpenClosedPeriodModel: object
- ClosedPeriodId: integer
- PeriodBeginDate: string
- PeriodEndDate: string
- AddedByContactId: integer
- CreatedBy: string
- CreatedOn: string
- CreatedAtOffset: string
- ClosedPeriodEntryTypeId: string
- ForceSave: boolean
- CssClass: string
- Accounts: string
Example
{
"ClosedPeriodId": "integer",
"PeriodBeginDate": "string",
"PeriodEndDate": "string",
"AddedByContactId": "integer",
"CreatedBy": "string",
"CreatedOn": "string",
"CreatedAtOffset": "string",
"ClosedPeriodEntryTypeId": "string",
"ForceSave": "boolean",
"CssClass": "string",
"Accounts": "string"
}
ClosingPeriodListItemModel: object
- ClosedPeriodId: integer
- DisableCreatePeriod: boolean
- PeriodBeginDate: string
- PeriodEndDate: string
- Status: string
- CreatedBy: string
- ReopenedBy: string
- ReopenedByContactId: string
- CreatedOn: string
- AddedByContactId: integer
- CreatedAtOffset: string
- ClosedPeriodEntryTypeId: string
- AuditId: integer
- IsDeleted: boolean
- Actions: string
Example
{
"ClosedPeriodId": "integer",
"DisableCreatePeriod": "boolean",
"PeriodBeginDate": "string",
"PeriodEndDate": "string",
"Status": "string",
"CreatedBy": "string",
"ReopenedBy": "string",
"ReopenedByContactId": "string",
"CreatedOn": "string",
"AddedByContactId": "integer",
"CreatedAtOffset": "string",
"ClosedPeriodEntryTypeId": "string",
"AuditId": "integer",
"IsDeleted": "boolean",
"Actions": "string"
}