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/quickbooksettings/settings/connect/ams

OK

Response Example (200 OK)
{
  "Location": "string",
  "Request": "string"
}

GET /api/quickbooksettings/settings/connect/quickbooksonline

OK

Response Example (200 OK)
{
  "Location": "string",
  "Request": "string"
}

POST /api/quickbooksettings/settings/disonnect/ams

Request Example
{
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean",
  "QboIsConnected": "boolean",
  "AmsIsConnected": "boolean",
  "QboIsEnabled": "boolean",
  "EnableQbo": "boolean",
  "ConnectAms": "string",
  "Spacer": "string",
  "ConnectQbo": "string",
  "AmsConnectionStatus": "string",
  "QboConnectionStatus": "string",
  "QboConnectorId": "string",
  "QboInstallationId": "string",
  "QboConnectorName": "string",
  "AmsConnectorId": "string",
  "AmsInstallationId": "string",
  "AmsConnectorName": "string",
  "MappingLinkBox": "string"
}
200 OK

OK

POST /api/quickbooksettings/settings/disonnect/quickbooksonline

Request Example
{
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean",
  "QboIsConnected": "boolean",
  "AmsIsConnected": "boolean",
  "QboIsEnabled": "boolean",
  "EnableQbo": "boolean",
  "ConnectAms": "string",
  "Spacer": "string",
  "ConnectQbo": "string",
  "AmsConnectionStatus": "string",
  "QboConnectionStatus": "string",
  "QboConnectorId": "string",
  "QboInstallationId": "string",
  "QboConnectorName": "string",
  "AmsConnectorId": "string",
  "AmsInstallationId": "string",
  "AmsConnectorName": "string",
  "MappingLinkBox": "string"
}
200 OK

OK

GET /api/quickbooksettings/settings/quickbooksinstall

Response Example (200 OK)
{
  "Id": "string",
  "ClosedPeriodEnabled": "boolean",
  "DisplayMessage": "string",
  "SetupClosedPeriod": "string"
}

POST /api/quickbooksettings/settings/quickbooksinstall

Request Example
{
  "Id": "string",
  "ClosedPeriodEnabled": "boolean",
  "DisplayMessage": "string",
  "SetupClosedPeriod": "string"
}
Response Example (200 OK)
{
  "Id": "string",
  "ClosedPeriodEnabled": "boolean",
  "DisplayMessage": "string",
  "SetupClosedPeriod": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline

Response Example (200 OK)
{
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean",
  "QboIsConnected": "boolean",
  "AmsIsConnected": "boolean",
  "QboIsEnabled": "boolean",
  "EnableQbo": "boolean",
  "ConnectAms": "string",
  "Spacer": "string",
  "ConnectQbo": "string",
  "AmsConnectionStatus": "string",
  "QboConnectionStatus": "string",
  "QboConnectorId": "string",
  "QboInstallationId": "string",
  "QboConnectorName": "string",
  "AmsConnectorId": "string",
  "AmsInstallationId": "string",
  "AmsConnectorName": "string",
  "MappingLinkBox": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline

Request Example
{
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean",
  "QboIsConnected": "boolean",
  "AmsIsConnected": "boolean",
  "QboIsEnabled": "boolean",
  "EnableQbo": "boolean",
  "ConnectAms": "string",
  "Spacer": "string",
  "ConnectQbo": "string",
  "AmsConnectionStatus": "string",
  "QboConnectionStatus": "string",
  "QboConnectorId": "string",
  "QboInstallationId": "string",
  "QboConnectorName": "string",
  "AmsConnectorId": "string",
  "AmsInstallationId": "string",
  "AmsConnectorName": "string",
  "MappingLinkBox": "string"
}
Response Example (200 OK)
{
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean",
  "QboIsConnected": "boolean",
  "AmsIsConnected": "boolean",
  "QboIsEnabled": "boolean",
  "EnableQbo": "boolean",
  "ConnectAms": "string",
  "Spacer": "string",
  "ConnectQbo": "string",
  "AmsConnectionStatus": "string",
  "QboConnectionStatus": "string",
  "QboConnectorId": "string",
  "QboInstallationId": "string",
  "QboConnectorName": "string",
  "AmsConnectorId": "string",
  "AmsInstallationId": "string",
  "AmsConnectorName": "string",
  "MappingLinkBox": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/accountmapping

Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/accountmapping

Request Example
{
  "InstallationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/accountmapping/amsaccounts

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/accountmapping/qboaccounts

Response Example (200 OK)
[
  {
    "QboAccountId": "string",
    "Name": "string",
    "IsSelected": "boolean"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/amsconnection

Response Example (200 OK)
{
  "Key": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/amsconnection

Request Example
{
  "Key": "string"
}
200 OK

OK

GET /api/quickbooksettings/settings/quickbooksonline/classmapping

Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/classmapping

Request Example
{
  "InstallationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/classmapping/amsclasses

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/classmapping/qboclasses

Response Example (200 OK)
[
  {
    "QboClassId": "string",
    "Name": "string",
    "IsSelected": "boolean"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/discountmapping

Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/discountmapping

Request Example
{
  "InstallationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/discountmapping/amsdiscounts

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/discountmapping/qbodiscounts

Response Example (200 OK)
[
  {
    "QboDiscountId": "string",
    "Name": "string",
    "IsSelected": "boolean"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/feeitemmapping

Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/feeitemmapping

Request Example
{
  "InstallationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/feeitemmapping/amsfeeitems

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/feeitemmapping/qbofeeitems

Response Example (200 OK)
[
  {
    "QboItemId": "string",
    "Name": "string",
    "IsSelected": "boolean"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/paymentgatewaymapping

Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/paymentgatewaymapping

Request Example
{
  "InstallationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/paymentgatewaymapping/amspaymentgateways

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/paymentgatewaymapping/qbopaymentmethods

Response Example (200 OK)
[
  {
    "QboPaymentMethodId": "string",
    "Name": "string",
    "IsSelected": "boolean"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/paymenttypemapping

Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/paymenttypemapping

Request Example
{
  "InstallationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/paymenttypemapping/amspaymenttypes

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/paymenttypemapping/qbopaymentmethodsfortypes

Response Example (200 OK)
[
  {
    "QboPaymentMethodId": "string",
    "Name": "string",
    "IsSelected": "boolean"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/taxmapping

Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/taxmapping

Request Example
{
  "InstallationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "InstallationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonline/taxmapping/amstaxitems

Response Example (200 OK)
[
  {
    "Id": "string",
    "Name": "string"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/taxmapping/qbotaxitems

Response Example (200 OK)
[
  {
    "QboTaxId": "string",
    "Name": "string",
    "IsSelected": "boolean"
  }
]

GET /api/quickbooksettings/settings/quickbooksonline/writeoffaccountmapping

Response Example (200 OK)
{
  "IntegrationId": "string",
  "Mappings": "string"
}

POST /api/quickbooksettings/settings/quickbooksonline/writeoffaccountmapping

Request Example
{
  "IntegrationId": "string",
  "Mappings": "string"
}
Response Example (200 OK)
{
  "IntegrationId": "string",
  "Mappings": "string"
}

GET /api/quickbooksettings/settings/quickbooksonlinebase

Response Example (200 OK)
{
  "LastSync": "string",
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean"
}

Schema Definitions

QuickbooksOnlineSettings: object

QboModuleIsEnabled: boolean
QboIsInstalled: boolean
QboIsConnected: boolean
AmsIsConnected: boolean
QboIsEnabled: boolean
EnableQbo: boolean
ConnectAms: string
Spacer: string
ConnectQbo: string
AmsConnectionStatus: string
QboConnectionStatus: string
QboConnectorId: string
QboInstallationId: string
QboConnectorName: string
AmsConnectorId: string
AmsInstallationId: string
AmsConnectorName: string
MappingLinkBox: string
Example
{
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean",
  "QboIsConnected": "boolean",
  "AmsIsConnected": "boolean",
  "QboIsEnabled": "boolean",
  "EnableQbo": "boolean",
  "ConnectAms": "string",
  "Spacer": "string",
  "ConnectQbo": "string",
  "AmsConnectionStatus": "string",
  "QboConnectionStatus": "string",
  "QboConnectorId": "string",
  "QboInstallationId": "string",
  "QboConnectorName": "string",
  "AmsConnectorId": "string",
  "AmsInstallationId": "string",
  "AmsConnectorName": "string",
  "MappingLinkBox": "string"
}

RedirectResult: object

Location: string
Request: string
Example
{
  "Location": "string",
  "Request": "string"
}

Boolean: object

Example
"object"

QuickbooksOnlineInstall: object

Id: string
ClosedPeriodEnabled: boolean
DisplayMessage: string
SetupClosedPeriod: string
Example
{
  "Id": "string",
  "ClosedPeriodEnabled": "boolean",
  "DisplayMessage": "string",
  "SetupClosedPeriod": "string"
}

QuickbooksOnlineIntegrationFeeItemMappingsScreen: object

InstallationId: string
Mappings: string
Example
{
  "InstallationId": "string",
  "Mappings": "string"
}

AmsFeeItemChoiceItemModel: object

Id: string
Name: string
Example
{
  "Id": "string",
  "Name": "string"
}

QboItemChoiceItemModel: object

QboItemId: string
Name: string
IsSelected: boolean
Example
{
  "QboItemId": "string",
  "Name": "string",
  "IsSelected": "boolean"
}

QuickbooksOnlineIntegrationTransactionClassMappingsScreen: object

InstallationId: string
Mappings: string
Example
{
  "InstallationId": "string",
  "Mappings": "string"
}

AmsClassChoiceClassModel: object

Id: string
Name: string
Example
{
  "Id": "string",
  "Name": "string"
}

QboClassChoiceClassModel: object

QboClassId: string
Name: string
IsSelected: boolean
Example
{
  "QboClassId": "string",
  "Name": "string",
  "IsSelected": "boolean"
}

QuickbooksOnlineIntegrationTaxItemMappingsScreen: object

InstallationId: string
Mappings: string
Example
{
  "InstallationId": "string",
  "Mappings": "string"
}

QBOTaxItemChoiceItemModel: object

QboTaxId: string
Name: string
IsSelected: boolean
Example
{
  "QboTaxId": "string",
  "Name": "string",
  "IsSelected": "boolean"
}

AmsTaxItemChoiceItemModel: object

Id: string
Name: string
Example
{
  "Id": "string",
  "Name": "string"
}

QuickbooksOnlineIntegrationAccountMappingsScreen: object

InstallationId: string
Mappings: string
Example
{
  "InstallationId": "string",
  "Mappings": "string"
}

AmsAccountChoiceAccountModel: object

Id: string
Name: string
Example
{
  "Id": "string",
  "Name": "string"
}

QboAccountChoiceAccountModel: object

QboAccountId: string
Name: string
IsSelected: boolean
Example
{
  "QboAccountId": "string",
  "Name": "string",
  "IsSelected": "boolean"
}

QuickbooksOnlineIntegrationPaymentGatewayMappingsScreen: object

InstallationId: string
Mappings: string
Example
{
  "InstallationId": "string",
  "Mappings": "string"
}

AmsPaymentGatewayChoicePaymentGatewayModel: object

Id: string
Name: string
Example
{
  "Id": "string",
  "Name": "string"
}

QboPaymentGatewayChoicePaymentGatewayModel: object

QboPaymentMethodId: string
Name: string
IsSelected: boolean
Example
{
  "QboPaymentMethodId": "string",
  "Name": "string",
  "IsSelected": "boolean"
}

QuickbooksOnlineBaseScreen: object

LastSync: string
QboModuleIsEnabled: boolean
QboIsInstalled: boolean
Example
{
  "LastSync": "string",
  "QboModuleIsEnabled": "boolean",
  "QboIsInstalled": "boolean"
}

QuickbooksOnlineIntegrationDiscountMappingsScreen: object

InstallationId: string
Mappings: string
Example
{
  "InstallationId": "string",
  "Mappings": "string"
}

AmsDiscountChoiceDiscountModel: object

Id: string
Name: string
Example
{
  "Id": "string",
  "Name": "string"
}

QboDiscountChoiceDiscountModel: object

QboDiscountId: string
Name: string
IsSelected: boolean
Example
{
  "QboDiscountId": "string",
  "Name": "string",
  "IsSelected": "boolean"
}

QuickbooksOnlineIntegrationPaymentTypeMappingsScreen: object

InstallationId: string
Mappings: string
Example
{
  "InstallationId": "string",
  "Mappings": "string"
}

AmsPaymentTypeChoicePaymentTypeModel: object

Id: string
Name: string
Example
{
  "Id": "string",
  "Name": "string"
}

QboPaymentTypeChoicePaymentTypeModel: object

QboPaymentMethodId: string
Name: string
IsSelected: boolean
Example
{
  "QboPaymentMethodId": "string",
  "Name": "string",
  "IsSelected": "boolean"
}

QuickbooksOnlineIntegrationWriteoffMappingsScreen: object

IntegrationId: string
Mappings: string
Example
{
  "IntegrationId": "string",
  "Mappings": "string"
}

IntegrationAmsConnectionScreen: object

Key: string
Example
{
  "Key": "string"
}