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

MicFinance

POST /api/mic/finance/accountmakeapaymentlistview

MakeAPaymentAdvancedFilter

undefined

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "PurchaseId": "string",
  "OrganizationId": "integer",
  "ShowRelatedContacts": "boolean",
  "SplitPurchaseAndPayment": "boolean",
  "TransactiontDateBetween": "string",
  "DueDateBetween": "string",
  "MembershipTypeId": "string",
  "ContactNameId": "string",
  "ScheduledForAutopay": "string",
  "Criteria": "string",
  "MyInvoices": "boolean",
  "RelatedContactsInvoices": "boolean",
  "DueSoon": "boolean",
  "OverdueInvoices": "boolean"
}
200 OK
ListViewReturnModel<MakeAPaymentListViewModel>

OK

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

POST /api/mic/finance/make/a/payment/{purchaseid}

MakeAPaymentAdvancedFilter

undefined

purchaseid: string
in path

(no description)

Request Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "PurchaseId": "string",
  "OrganizationId": "integer",
  "ShowRelatedContacts": "boolean",
  "SplitPurchaseAndPayment": "boolean",
  "TransactiontDateBetween": "string",
  "DueDateBetween": "string",
  "MembershipTypeId": "string",
  "ContactNameId": "string",
  "ScheduledForAutopay": "string",
  "Criteria": "string",
  "MyInvoices": "boolean",
  "RelatedContactsInvoices": "boolean",
  "DueSoon": "boolean",
  "OverdueInvoices": "boolean"
}
200 OK
MakeAPaymentModel

OK

Response Example (200 OK) 
{
  "TenantId": "integer",
  "TenantName": "string",
  "PurchaseId": "string",
  "PaymentGatewayTypeId": "string",
  "PaymentGatewayId": "string",
  "OpenInvoices": "string",
  "MakeAPaymentInvoices": "string",
  "SystemContactTypeId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "ContactName": "string",
  "ContactId": "string",
  "PaymentProfileId": "string",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "GatewayAccountId": "string",
  "ConfigInfoJson": "string",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "PaymentUsesGateway": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "ShowEmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PayByNewCard": "boolean",
  "SourceInfo": "string",
  "GatewayErrorMessage": "string",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PaymentDate": "string",
  "Amount": "number",
  "EmailPaymentReceipt": "boolean",
  "PaymentSourceInfo": "string",
  "HasRequiredLateFee": "boolean"
}
MicFinance

GET /api/mic/finance/membershiptypesforopeninvoices/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"
  }
]
MicFinance

GET /api/mic/finance/mybilling

200 OK

OK

MicFinance

GET /api/mic/finance/relatedcontacts/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"
  }
]
MicFinance

POST /api/mic/finance/save/a/payment

MakeAPaymentModel

undefined

Request Example
{
  "TenantId": "integer",
  "TenantName": "string",
  "PurchaseId": "string",
  "PaymentGatewayTypeId": "string",
  "PaymentGatewayId": "string",
  "OpenInvoices": "string",
  "MakeAPaymentInvoices": "string",
  "SystemContactTypeId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "ContactName": "string",
  "ContactId": "string",
  "PaymentProfileId": "string",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "GatewayAccountId": "string",
  "ConfigInfoJson": "string",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "PaymentUsesGateway": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "ShowEmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PayByNewCard": "boolean",
  "SourceInfo": "string",
  "GatewayErrorMessage": "string",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PaymentDate": "string",
  "Amount": "number",
  "EmailPaymentReceipt": "boolean",
  "PaymentSourceInfo": "string",
  "HasRequiredLateFee": "boolean"
}
200 OK
CreditCardChargeResponseModel

OK

Response Example (200 OK) 
{
  "Success": "boolean",
  "UserMessage": "string",
  "TransactionId": "string",
  "EpaymentTransactionId": "string",
  "PaymentId": "string",
  "PaymentProfileId": "string",
  "EpaymentTransactions": "string"
}

Schema Definitions

MakeAPaymentModel: object

TenantId: integer
TenantName: string
PurchaseId: string
PaymentGatewayTypeId: string
PaymentGatewayId: string
OpenInvoices: string
MakeAPaymentInvoices: string
SystemContactTypeId: string
OrganizationId: string
SaveOnContactId: string
SaveOnOrganizationId: string
ContactName: string
ContactId: string
PaymentProfileId: string
AuthProfilePageToken: string
AuthProfileUrl: string
GatewayAccountId: string
ConfigInfoJson: string
TokenId: string
Capture: string
SimResponse: string
EPaymentTransactionId: integer
DataDescriptor: string
DataValue: string
IsTestCard: boolean
CardType: string
CardLast4: string
CardExpMonth: string
CardExpYear: string
CardCvc: string
VoluntaryAmount: number
Currency: string
GatewayAmounts: string
IsBankCharge: boolean
IsSavingsAccount: boolean
IsTestBank: boolean
CurrencyType: string
Country: string
PayerName: string
PreferredEmailAddress: string
AccountLast4: string
BankName: string
AccountNumber: string
RoutingNumber: string
AccountHolderType: string
Company: string
FirstName: string
LastName: string
Address: string
Address1: string
Address2: string
City: string
StateProvince: string
PostalCode: string
CountryCode: string
Email: string
Phone: string
HttpReferer: string
ClientSideMethod: string
ResponseData: string
FailureReason: string
PaymentUsesGateway: boolean
NarPaymentsBaseUrl: string
NRDSMemberId: string
ContactNRDSMemberId: string
DefaultNRDSMemberId: string
HasNRDSMemberId: string
CardAccountType: string
NarSplitsInfo: string
CanAddPaymentProfile: boolean
SaleableItemAmounts: string
AssociationRequestId: string
AllowPartialPayments: boolean
ShowEmailPaymentReceipt: boolean
PaymentTerms: string
PayByNewCard: boolean
SourceInfo: string
GatewayErrorMessage: string
ManageDpmProfilesAction: string
CreditCardInfo: string
StorePaymentInfoForFuture: boolean
PaymentDate: string
Amount: number
EmailPaymentReceipt: boolean
PaymentSourceInfo: string
HasRequiredLateFee: boolean
Example
{
  "TenantId": "integer",
  "TenantName": "string",
  "PurchaseId": "string",
  "PaymentGatewayTypeId": "string",
  "PaymentGatewayId": "string",
  "OpenInvoices": "string",
  "MakeAPaymentInvoices": "string",
  "SystemContactTypeId": "string",
  "OrganizationId": "string",
  "SaveOnContactId": "string",
  "SaveOnOrganizationId": "string",
  "ContactName": "string",
  "ContactId": "string",
  "PaymentProfileId": "string",
  "AuthProfilePageToken": "string",
  "AuthProfileUrl": "string",
  "GatewayAccountId": "string",
  "ConfigInfoJson": "string",
  "TokenId": "string",
  "Capture": "string",
  "SimResponse": "string",
  "EPaymentTransactionId": "integer",
  "DataDescriptor": "string",
  "DataValue": "string",
  "IsTestCard": "boolean",
  "CardType": "string",
  "CardLast4": "string",
  "CardExpMonth": "string",
  "CardExpYear": "string",
  "CardCvc": "string",
  "VoluntaryAmount": "number",
  "Currency": "string",
  "GatewayAmounts": "string",
  "IsBankCharge": "boolean",
  "IsSavingsAccount": "boolean",
  "IsTestBank": "boolean",
  "CurrencyType": "string",
  "Country": "string",
  "PayerName": "string",
  "PreferredEmailAddress": "string",
  "AccountLast4": "string",
  "BankName": "string",
  "AccountNumber": "string",
  "RoutingNumber": "string",
  "AccountHolderType": "string",
  "Company": "string",
  "FirstName": "string",
  "LastName": "string",
  "Address": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "StateProvince": "string",
  "PostalCode": "string",
  "CountryCode": "string",
  "Email": "string",
  "Phone": "string",
  "HttpReferer": "string",
  "ClientSideMethod": "string",
  "ResponseData": "string",
  "FailureReason": "string",
  "PaymentUsesGateway": "boolean",
  "NarPaymentsBaseUrl": "string",
  "NRDSMemberId": "string",
  "ContactNRDSMemberId": "string",
  "DefaultNRDSMemberId": "string",
  "HasNRDSMemberId": "string",
  "CardAccountType": "string",
  "NarSplitsInfo": "string",
  "CanAddPaymentProfile": "boolean",
  "SaleableItemAmounts": "string",
  "AssociationRequestId": "string",
  "AllowPartialPayments": "boolean",
  "ShowEmailPaymentReceipt": "boolean",
  "PaymentTerms": "string",
  "PayByNewCard": "boolean",
  "SourceInfo": "string",
  "GatewayErrorMessage": "string",
  "ManageDpmProfilesAction": "string",
  "CreditCardInfo": "string",
  "StorePaymentInfoForFuture": "boolean",
  "PaymentDate": "string",
  "Amount": "number",
  "EmailPaymentReceipt": "boolean",
  "PaymentSourceInfo": "string",
  "HasRequiredLateFee": "boolean"
}

MakeAPaymentAdvancedFilter: object

Top: string
Take: string
Skip: string
Filter: string
OrderBy: string
CalendarStartDate: string
CalendarEndDate: string
TenantId: integer
ContactId: integer
PurchaseId: string
OrganizationId: integer
ShowRelatedContacts: boolean
SplitPurchaseAndPayment: boolean
TransactiontDateBetween: string
DueDateBetween: string
MembershipTypeId: string
ContactNameId: string
ScheduledForAutopay: string
Criteria: string
MyInvoices: boolean
RelatedContactsInvoices: boolean
DueSoon: boolean
OverdueInvoices: boolean
Example
{
  "Top": "string",
  "Take": "string",
  "Skip": "string",
  "Filter": "string",
  "OrderBy": "string",
  "CalendarStartDate": "string",
  "CalendarEndDate": "string",
  "TenantId": "integer",
  "ContactId": "integer",
  "PurchaseId": "string",
  "OrganizationId": "integer",
  "ShowRelatedContacts": "boolean",
  "SplitPurchaseAndPayment": "boolean",
  "TransactiontDateBetween": "string",
  "DueDateBetween": "string",
  "MembershipTypeId": "string",
  "ContactNameId": "string",
  "ScheduledForAutopay": "string",
  "Criteria": "string",
  "MyInvoices": "boolean",
  "RelatedContactsInvoices": "boolean",
  "DueSoon": "boolean",
  "OverdueInvoices": "boolean"
}

CreditCardChargeResponseModel: object

Success: boolean
UserMessage: string
TransactionId: string
EpaymentTransactionId: string
PaymentId: string
PaymentProfileId: string
EpaymentTransactions: string
Example
{
  "Success": "boolean",
  "UserMessage": "string",
  "TransactionId": "string",
  "EpaymentTransactionId": "string",
  "PaymentId": "string",
  "PaymentProfileId": "string",
  "EpaymentTransactions": "string"
}

AccountBillingBaseViewModel: object

Example
"object"

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"
}

ListViewReturnModel<MakeAPaymentListViewModel>: 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"
}
Documentation by Spectacle