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/memberships/{membershipid}
membershipid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"AuditId": "integer",
"MembershipStatusTypeId": "string",
"Name": "string",
"Actions": "string"
}
GET /api/memberships/{membershipid}/financial
membershipid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"ShowProcessAch": "boolean",
"OptionalPaymentTypes": "string",
"AllowAutoRecalcRenewalBilling": "boolean",
"ContactBalance": "string",
"Balance": "number",
"BillingNotes": "string",
"MembershipsBilling": "string",
"ScheduledBilling": "string",
"PaymentProfile": "string",
"BillingHistory": "string",
"MembershipId": "integer",
"Purchases": "string",
"Invoices": "string"
}
GET /api/memberships/{membershipid}/general
membershipid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"MembershipType": "string",
"MembershipStatusType": "string",
"MembershipCategory": "string",
"Number": "string",
"MembershipOwner": "string",
"OwnerContactId": "integer",
"PrimaryContact": "string",
"PrimaryContactId": "integer",
"ChapterName": "string",
"ReferralContact": "string",
"BillFrequencyType": "string",
"Members": "string",
"Activations": "string",
"ReferredByContactId": "string"
}
GET /api/memberships/{membershipid}/info
membershipid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ModelType": "string",
"Items": "string",
"TotalRecordAvailable": "string"
}
GET /api/memberships/activation/{membershipactivationid}
membershipactivationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipActivationId": "integer",
"MembershipId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"BillFrequencyTypeId": "string",
"MembershipPurchaseTypeId": "string",
"Notes": "string",
"StartDate": "string",
"EndDate": "string",
"ExpirationDate": "string",
"RenewalDate": "string",
"GracePeriodExpirationDate": "string",
"ParentRenewalIsNotification": "boolean",
"ParentEndTypeIsDurationExpires": "boolean",
"SalesContactId": "string",
"JoinReasonId": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string"
}
GET /api/memberships/activation/linkedinvoices/{membershipactivationid}
membershipactivationid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipActivationId": "integer",
"ContactId": "integer",
"Type": "string",
"StartDate": "string",
"StartDateString": "string",
"ExpirationDate": "string",
"ExpirationDateString": "string",
"MembershipEndTypeId": "string",
"ParentRenewalIsNotification": "boolean",
"ParentEndTypeIsDurationExpires": "boolean",
"GraceExpirationDate": "string",
"GraceExpirationDateString": "string",
"Invoices": "string"
}
GET /api/memberships/activation/linktoinvoice/{membershipactivationid}/{contactid}
membershipactivationid:
integer
in path
(no description)
contactid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipActivationId": "integer",
"ContactId": "integer",
"SaleableItemTypeId": "string",
"Invoices": "string"
}
GET /api/memberships/add/{contactid}
contactid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"ContactName": "string",
"MembershipTypeId": "string",
"ProratePartialYears": "boolean",
"PreviousMembershipTypeId": "string",
"MembershipLevelId": "string",
"DurationMonths": "string",
"ChapterId": "string",
"RoundToNearestOnes": "boolean",
"Number": "string",
"IsCourtesy": "boolean",
"SalesContactId": "string",
"MembershipJoinReasonId": "string",
"ReferredByContact": "string",
"ReferredByContactId": "string",
"RenewalPriceCalculationTypeIdOverride": "string",
"MembershipStatus": "string",
"Fields": "string",
"Yesterday": "string",
"ContactId": "integer",
"PrimaryContactId": "string",
"SystemContactTypeId": "string",
"PricingTypeId": "string",
"ProratedWarningMessage": "string",
"PlanOrFrequencyId": "string",
"BillingStartDate": "string",
"StartDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"JoinDate": "string",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"NextBillingDate": "string",
"SoftwareCustomerKey": "string",
"FixedAnnualRenewalMonth": "string",
"PaymentProfileId": "string",
"ShowNextBillDate": "boolean",
"HasLevels": "boolean",
"IsTaxExempt": "boolean",
"TaxRegionId": "string",
"ContactTaxSetRate": "number",
"ContactTaxSetFloatAmount": "number",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"PaymentInfo": "string",
"DisableDateEditing": "boolean",
"SendStaffNotifications": "boolean"
}
GET /api/memberships/adjustment/{membershipid}
membershipid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"forceSave": "boolean",
"ContactId": "integer",
"SalesContactId": "string",
"MembershipJoinReasonId": "string",
"NoAdjustment": "string",
"ChangeType": "string",
"Change": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"MembershipType": "string",
"ChapterId": "string",
"DurationMonths": "string",
"Notes": "string",
"OriginalBillFrequencyTypeId": "integer",
"Instructions": "string",
"PlanOrFrequencyId": "integer",
"NextBillingDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"OldFeeItems": "string",
"ShowNextBillDate": "boolean",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"StartDate": "string",
"BillingStartDate": "string",
"SameNextBillDates": "boolean",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"Yesterday": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string",
"SendStaffNotifications": "boolean"
}
GET /api/memberships/adjustment/contact/{contactid}
contactid:
integer
in path
(no description)
OK
Response Example (200 OK)
[
{
"MembershipId": "integer",
"forceSave": "boolean",
"ContactId": "integer",
"SalesContactId": "string",
"MembershipJoinReasonId": "string",
"NoAdjustment": "string",
"ChangeType": "string",
"Change": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"MembershipType": "string",
"ChapterId": "string",
"DurationMonths": "string",
"Notes": "string",
"OriginalBillFrequencyTypeId": "integer",
"Instructions": "string",
"PlanOrFrequencyId": "integer",
"NextBillingDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"OldFeeItems": "string",
"ShowNextBillDate": "boolean",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"StartDate": "string",
"BillingStartDate": "string",
"SameNextBillDates": "boolean",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"Yesterday": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string",
"SendStaffNotifications": "boolean"
}
]
Lookup of all memberships with paging.
Uses OData object to page and order memberships. Example Request: /api/memberships/all?skip=0&take=1&OrderBy=MembershipId
options:
string
in query
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/memberships/all
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/memberships/appforms
queryoptions:
string
in query
(no description)
Response Example (200 OK)
[
{
"MembershipApplicationFormId": "integer",
"Name": "string",
"Description": "string",
"Url": "string",
"Actions": "string"
}
]
GET /api/memberships/appforms/{membershipapplicationformid}
membershipapplicationformid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipApplicationFormId": "integer",
"AuditId": "integer",
"Name": "string",
"Description": "string",
"AllowChapterSelection": "boolean",
"ShowMemTypeDesc": "string",
"CollectDonations": "boolean",
"AutoApproveApps": "string",
"OrderLowestToHighest": "string",
"CollectEmailSignupLists": "string",
"HidePricingOnMembershipSelection": "boolean",
"ShowOrganizationTypeAhead": "boolean",
"ForceOrganizationSelection": "boolean",
"ShowAdditionalConfirmation": "boolean",
"CapturePaymentProfileAndChargeOnApproval": "boolean",
"HideProratedTotal": "boolean",
"MembershipTypeId": "string",
"TemplateId": "string",
"ReceiptTemplateId": "string",
"FundraisingCampaignIds": "string",
"Addons": "string",
"CustomRedirectUrl": "string",
"RedirectToHub": "string",
"SubmitButtonText": "string",
"Url": "string",
"RequirePrivacyAcceptance": "boolean",
"PrivacyTermsOfUseId": "string",
"Instructions": "string",
"CompletionMessage": "string",
"AdditionalConfirmationMessage": "string",
"PaymentGatewayTypeId": "integer",
"MemberApplicationVersion": "string"
}
GET /api/memberships/appforms/list/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/memberships/benefititem/{benefititemid}
benefititemid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"BenefitItemId": "integer",
"TenantId": "integer",
"Name": "string",
"Description": "string",
"BenefitAreaId": "string",
"Amount": "string",
"DiscountId": "string",
"CategoryItems": "string",
"BenefitUsageSharingTypeId": "string",
"IsActive": "boolean",
"forceSave": "boolean"
}
DELETE /api/memberships/benefititem/{benefititemid}
benefititemid:
integer
in path
(no description)
200 OK
OK
GET /api/memberships/benefits/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"Name": "string",
"Directories": "string",
"DisplayDirectoryCategories": "boolean",
"CategoryLists": "string",
"AuditInfo": "string"
}
GET /api/memberships/billing/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"IsRealtorEdition": "boolean",
"MembershipTypeId": "integer",
"Name": "string",
"HasLevelPricing": "boolean",
"HasFees": "boolean",
"HasChapterPricing": "boolean",
"DefaultFrequencyTypeOption": "string",
"LevelSelectionCustomFieldId": "string",
"IncludeTopLevelSelection": "boolean",
"ChapterSelectionTypeId": "string",
"HasChapterSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"DurationMonths": "string",
"MembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"DefaultGatewayTypeId": "string",
"GatewayTypeId": "string",
"SelectedGatewayAllowStoredProfiles": "boolean",
"PaymentGatewayId": "string",
"DocumentationGenerationTemplateId": "string",
"TermId": "string",
"TermsOfUseId": "string",
"PricingTypeId": "string",
"FormulaBasedPricing": "boolean",
"ShouldMarkNewInvoiceIsRestricted": "boolean",
"ProratePartialYears": "boolean",
"PlusNextBillCycle": "boolean",
"MaxAllowableTermsToPurchase": "string",
"ChangeEffectivePrice": "boolean",
"EffectiveDate": "string",
"Tommorow": "string",
"CanHaveEffectivePrice": "boolean",
"EffectiveDateText": "string",
"FeesList": "string",
"OneTimeOptionsParagraph": "string",
"AllowBillMe": "boolean",
"AllowOnlinePayment": "boolean",
"SetupFeesList": "string",
"PriceOptionsJson": "string",
"Discounts": "string",
"RoundToNearestOnes": "boolean",
"PaymentOptions": "string",
"BillSchedulePricingJson": "string",
"MultiTermDiscounts": "string",
"FixedAnnualRenewalMonth": "string",
"RenewalPriceCalculationTypeId": "string"
}
GET /api/memberships/billingsettings/{membershipid}
membershipid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"ContactId": "integer",
"ScheduledBillingItems": "string"
}
GET /api/memberships/brokers
options:
string
in query
(no description)
OK
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/memberships/brokers
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"BrokerContactId": "string",
"BrokerOfficeContactId": "string",
"MembershipTypes": "string",
"MembershipLevelId": "string",
"MembershipStatus": "string",
"Tags": "string",
"InvoiceDate": "string",
"OpenBalance": "boolean",
"Criteria": "string",
"HasOpenInvoices": "boolean"
}
OK
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/memberships/bulkedit/{membershipid}/{membershipactivationid}
membershipid:
integer
in path
(no description)
membershipactivationid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipActivationId": "integer",
"MembershipId": "integer",
"LoadedMembershipExpirationDate": "string",
"MembershipExpirationChanged": "boolean",
"MembershipExpirationDate": "string",
"GraceExpirationDate": "string",
"MembershipBalance": "string",
"MembershipActivationExpirationDate": "string",
"OwnerContactName": "string",
"MembershipName": "string",
"MembershipNumber": "string",
"ContactId": "integer",
"OwnerAccountNumber": "string",
"MembershipStartDate": "string",
"MembershipStartDateString": "string",
"MembershipStatusTypeId": "string",
"MembershipStatusTypeString": "string",
"NextBillDate": "string",
"NextBillDateString": "string",
"PurchaseId": "string",
"LastInvoiceNumber": "string",
"BlankLastInvoiceNumber": "string",
"LastInvoiceDueDate": "string",
"LastInvoiceDueDateString": "string",
"LastInvoiceBalance": "string",
"ContactBalance": "number",
"ScheduledBillings": "string",
"Modified": "boolean",
"AggregatedMembershipEndTypeId": "string",
"GracePeriodDays": "integer",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string"
}
GET /api/memberships/bulkeditexpirationdates
200 OK
OK
Response Example (200 OK)
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"HelpParagraph": "string",
"MembershipTypes": "string",
"MembershipTypeIds": "string",
"MembershipStatus": "string",
"XDays": "integer",
"GraceXDays": "string",
"SetDatesEndOfMonth": "boolean",
"LoadButton": "string",
"Items": "string"
}
Get list of memberships containing specific change event
membershipid:
integer
in path
The ID of the membership to return the fields from.
changetype:
string
in path
The ID of the contact to return the fields from.
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"ContactId": "integer",
"SystemContactTypeId": "string",
"MembershipJoinReasonId": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"ChangeType": "string",
"Change": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"DurationMonths": "string",
"ChapterId": "string",
"SalesContactId": "string",
"Notes": "string",
"Fields": "string",
"Instructions": "string",
"PlanOrFrequencyId": "string",
"NextBillingDate": "string",
"StartDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"OldFeeItems": "string",
"MembershipTypeDurationMonths": "string",
"MembershipTypeFixedAnnualRenewalMonth": "string",
"FixedAnnualRenewalMonth": "string",
"Name": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"BillingStartDate": "string",
"SameNextBillDates": "boolean",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"Yesterday": "string",
"PricingTypeId": "string",
"RoundToNearestOnes": "boolean",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"HasLevels": "boolean",
"GracePeriodDays": "integer",
"InitialExpirationDate": "string",
"DisableDateEditing": "boolean",
"SendStaffNotifications": "boolean"
}
POST /api/memberships/change/{membershipid}/{changetype}
undefined
membershipid:
integer
in path
(no description)
changetype:
string
in path
(no description)
Request Example
{
"MembershipId": "integer",
"ContactId": "integer",
"SystemContactTypeId": "string",
"MembershipJoinReasonId": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"ChangeType": "string",
"Change": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"DurationMonths": "string",
"ChapterId": "string",
"SalesContactId": "string",
"Notes": "string",
"Fields": "string",
"Instructions": "string",
"PlanOrFrequencyId": "string",
"NextBillingDate": "string",
"StartDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"OldFeeItems": "string",
"MembershipTypeDurationMonths": "string",
"MembershipTypeFixedAnnualRenewalMonth": "string",
"FixedAnnualRenewalMonth": "string",
"Name": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"BillingStartDate": "string",
"SameNextBillDates": "boolean",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"Yesterday": "string",
"PricingTypeId": "string",
"RoundToNearestOnes": "boolean",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"HasLevels": "boolean",
"GracePeriodDays": "integer",
"InitialExpirationDate": "string",
"DisableDateEditing": "boolean",
"SendStaffNotifications": "boolean"
}
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"ContactId": "integer",
"SystemContactTypeId": "string",
"MembershipJoinReasonId": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"ChangeType": "string",
"Change": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"DurationMonths": "string",
"ChapterId": "string",
"SalesContactId": "string",
"Notes": "string",
"Fields": "string",
"Instructions": "string",
"PlanOrFrequencyId": "string",
"NextBillingDate": "string",
"StartDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"OldFeeItems": "string",
"MembershipTypeDurationMonths": "string",
"MembershipTypeFixedAnnualRenewalMonth": "string",
"FixedAnnualRenewalMonth": "string",
"Name": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"BillingStartDate": "string",
"SameNextBillDates": "boolean",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"Yesterday": "string",
"PricingTypeId": "string",
"RoundToNearestOnes": "boolean",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"HasLevels": "boolean",
"GracePeriodDays": "integer",
"InitialExpirationDate": "string",
"DisableDateEditing": "boolean",
"SendStaffNotifications": "boolean"
}
GET /api/memberships/chapters/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"Name": "string",
"IncludeTopLevelSelection": "boolean",
"DefaultChaptersFees": "string",
"ChaptersFees": "string"
}
GET /api/memberships/chapters/fees/{membershiptypeid}/{chapterid}
membershiptypeid:
integer
in path
(no description)
chapterid:
integer
in path
(no description)
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"Name": "string",
"ChapterId": "integer",
"DurationMonths": "integer",
"HasVariableDues": "boolean",
"Note": "string",
"BillFrequencyTypeId": "string",
"FeesList": "string",
"SetupFeesList": "string"
}
GET /api/memberships/converttypestolevels
OK
Response Example (200 OK)
{
"TypesToConvert": "string"
}
GET /api/memberships/customformulaeditor/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"PriceFormulaEnabled": "boolean",
"Fields": "string",
"Instructions": "string",
"CustomFormulaScript": "string",
"TestScript": "string",
"Results": "string"
}
GET /api/memberships/details/{membershipid}/{contactid}
membershipid:
integer
in path
(no description)
contactid:
string
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"MembershipActivationId": "integer",
"AuditId": "integer",
"ContactId": "integer",
"MembershipContactId": "string",
"MembershipName": "string",
"MembershipStatusType": "string",
"MembershipStatusTypeId": "string",
"MembershipCategory": "string",
"MembershipNumber": "string",
"ChapterId": "string",
"StartDate": "string",
"ExpirationDate": "string",
"ExpirationDateString": "string",
"GraceExpirationDate": "string",
"GraceExpirationDateString": "string",
"RenewsIn": "string",
"RenewalMonth": "string",
"IsCourtesy": "boolean",
"IsPrimaryMembership": "boolean",
"ReferredByContactId": "string",
"MembershipDropReasonId": "string",
"DropNotes": "string",
"AnyActivationsAutomatic": "boolean",
"ContactHelpText": "string",
"OwnerContactName": "string",
"OwnerContactEmail": "string",
"ReferredByContact": "string",
"PrimaryContactId": "string",
"PrimaryContactEmail": "string",
"BillingContactId": "string",
"BillingContactEmail": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"MembershipTypeOptionId": "string",
"ActivationList": "string",
"MsiId": "string",
"Fields": "string",
"CalculatedEndType": "string",
"MembershipTypeMembershipRenewalTypeId": "string",
"MembershipTypeMembershipEndTypeId": "string",
"ShouldShowMembershipOverride": "boolean",
"MembershipTypeMembershipRenewalTypeIdString": "string",
"MembershipRenewalTypeId": "string",
"MembershipTypeMembershipEndTypeIdString": "string",
"MembershipEndTypeId": "string",
"MembershipTypeRenewalPriceCalculationTypeString": "string",
"RenewalPriceCalculationTypeIdOverride": "string",
"MembershipTypeRenewalPriceCalculationTypeId": "string",
"ShowRenewalPricing": "boolean",
"AnyAutomaticMembership": "boolean",
"ContactIds": "string",
"forceSave": "boolean",
"AuditInfo": "string",
"DisablePrimaryMembership": "boolean"
}
GET /api/memberships/discount/type/promo/{membershiptypediscountid}/{membershiptypeid}
membershiptypediscountid:
integer
in path
(no description)
membershiptypeid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipTypeDiscountId": "integer",
"MembershipDiscountAuditId": "integer",
"DiscountId": "integer",
"DiscountAuditId": "integer",
"MembershipTypeId": "string",
"Name": "string",
"StartDate": "string",
"EndDate": "string",
"PromoCode": "string",
"DiscountTypeId": "integer",
"SystemDiscountTypeId": "string",
"Pricing": "string"
}
GET /api/memberships/discounts/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"DiscountId": "integer",
"Name": "string",
"PromoCode": "string",
"StartDate": "string",
"EndDate": "string"
}
]
GET /api/memberships/drop/{membershipid}
membershipid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"OwnerContactId": "integer",
"SystemContactType": "string",
"MembershipContactContactId": "integer",
"Today": "string",
"MemberShipName": "string",
"OwnerContactName": "string",
"ActionType": "string",
"EndDate": "string",
"MembershipDropReasonId": "string",
"MemberRoleId": "string",
"DropCommunicationBody": "string",
"RemoveAllDirectoryListings": "boolean",
"RemoveFromList": "boolean",
"InvoiceProcedure": "string",
"OpenInvoices": "string",
"DropCommunicationId": "string",
"RoleId": "string",
"AssociatedStaff": "string",
"AssociatedStaffCount": "integer",
"forceSave": "boolean"
}
GET /api/memberships/dropreasons
Response Example (200 OK)
[
{
"DropReasonId": "integer",
"Id": "integer",
"Name": "string",
"Description": "string",
"StandardDropReasonId": "string",
"StandardDropReason": "string",
"IsPublic": "string",
"Actions": "string"
}
]
GET /api/memberships/dropreasons/{dropreasonid}
dropreasonid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"DropReasonId": "integer",
"Reason": "string",
"Description": "string",
"StandardDropReasonId": "string",
"IsPublic": "boolean"
}
GET /api/memberships/dropreasons/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/memberships/edit/{membershipid}
membershipid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"AuditId": "integer",
"MembershipTypeId": "integer",
"Price": "number",
"StartDate": "string",
"EndDate": "string",
"BillFrequencyTypeId": "string",
"SalesStaffContactId": "string"
}
GET /api/memberships/emaildesigner/newmembers
joindatefrom:
string
in query
(no description)
joindatethrough:
string
in query
(no description)
membershiptype:
integer
in query
(no description)
200 OK
OK
Response Example (200 OK)
[
{
"Name": "string",
"MembershipType": "string",
"MemberWebsite": "string",
"DirectoryUrl": "string",
"JoinDate": "string",
"PrimaryContactName": "string"
}
]
GET /api/memberships/fields/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"Name": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"MembershipTypeFields": "string",
"MembershipAppFields": "string",
"Fields": "string",
"FieldOptionsJson": "string"
}
GET /api/memberships/fieldsbymembership/{membershipid}
membershipid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"MembershipId": "integer",
"Fields": "string"
}
POST /api/memberships/getmembershiprenewalbulkrenew
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean",
"StartDateBetween": "string",
"Tags": "string",
"Frequency": "string",
"PaymentPlanIsFinished": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"Note": "string",
"Today": "string",
"Tomorrow": "string",
"MembershipIds": "string",
"MembershipCount": "integer",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"PlanOrFrequencyId": "string",
"InvoiceDate": "string",
"BestPracticesIsEnabled": "boolean",
"AutoSetNextBillDate": "boolean",
"ManualNextBillDate": "string"
}
GET /api/memberships/joinreasons
Response Example (200 OK)
[
{
"JoinReasonId": "integer",
"Id": "integer",
"Name": "string",
"Description": "string",
"StandardJoinReasonId": "string",
"StandardJoinReason": "string",
"Actions": "string"
}
]
GET /api/memberships/joinreasons/{joinreasonid}
joinreasonid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"JoinReasonId": "integer",
"Reason": "string",
"Description": "string",
"StandardJoinReasonId": "string"
}
GET /api/memberships/joinreasons/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/memberships/levels/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"FormulaBasedPricing": "boolean",
"ProratePartialYears": "boolean",
"FixedAnnualRenewalMonth": "string",
"PricingTypeId": "string",
"RenewalPriceCalculationTypeId": "string",
"CanHaveEffectivePrice": "boolean",
"EffectiveDate": "string",
"EffectiveDateText": "string",
"Name": "string",
"DurationMonths": "integer",
"BillSchedulePricingJson": "string",
"BaseFees": "string",
"PriceOptionsJson": "string",
"RoundToNearestOnes": "boolean",
"PaymentOptions": "string",
"LevelSelectionCustomFieldId": "string",
"BaseFeesDescription": "string",
"IsUsedInSync": "boolean",
"HasBenefitTrackingModule": "boolean",
"Levels": "string"
}
GET /api/memberships/levels/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/memberships/levels/saleableitems/{membershiptypeid}/{membershiplevelid}
membershiptypeid:
integer
in path
(no description)
membershiplevelid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipLevelId": "integer",
"MembershipTypeId": "integer",
"FormulaBasedPricing": "boolean",
"ProratePartialYears": "boolean",
"Name": "string",
"Description": "string",
"MinUnits": "string",
"MaxUnits": "string",
"DurationMonths": "integer",
"EffectiveDateText": "string",
"RenewalPriceCalculationTypeId": "string",
"CanHaveEffectivePrice": "boolean",
"PricingTypeId": "string",
"FeesList": "string",
"SetupFeesList": "string",
"RoundToNearestOnes": "boolean",
"PaymentOptions": "string",
"FixedAnnualRenewalMonth": "string"
}
GET /api/memberships/lookup/{contactid}
contactid:
string
in path
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/memberships/lookup/{contactid}/{scheduledbillingid}/activeandpendingapprovel
contactid:
string
in path
(no description)
scheduledbillingid:
string
in path
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/memberships/lookup/available
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/memberships/lookup/billfrequencyoptions/{originalmembershipbillfrequencytypeid}
originalmembershipbillfrequencytypeid:
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/memberships/lookup/customstatus
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
GET /api/memberships/lookup/proratefrequency
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
GET /api/memberships/lookup/purchasetype
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
GET /api/memberships/lookup/retentionreport/status
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
Get list of membership statuses for populating dropdown.
Used for dynamically populating dropdown based on up to date membership statuses.
defaultmembershipstatus:
string
in path
Value to be selected by default
200 OK
OK
type
Response Example (200 OK)
[
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
]
GET /api/memberships/lookup/tenant
this[]:
string
in query
(no description)
length:
string
in query
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
]
GET /api/memberships/lookupownermembership/{contactid}
contactid:
integer
in path
(no description)
200 OK
OK
GET /api/memberships/matchcontact/{membershipid}
membershipid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"AuditId": "integer",
"MembershipHash": "string",
"ViewApplication": "string",
"Name": "string",
"OrganizationName": "string",
"Email": "string",
"MembershipOwnerName": "string",
"HideOrgName": "boolean",
"NotEnoughOrganizationData": "boolean",
"ReferredByContactId": "string",
"OrganizationContactId": "string",
"OriginOrganizationContactId": "string",
"IndivIsNotMatched": "boolean",
"OrgIsNotMatched": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"Invoices": "string",
"NarWarningMessage": "string",
"CapturePaymentProfileAndChargeOnApproval": "boolean",
"PaymentOption": "string"
}
GET /api/memberships/mebershiptypebenefitpackages/{membershiptypeid}/{membershiplevelid}
membershiptypeid:
integer
in path
(no description)
membershiplevelid:
string
in path
(no description)
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"MembershipLevelId": "string",
"DisplayName": "string",
"BenefitPackages": "string"
}
GET /api/memberships/membershipbase
200 OK
OK
Response Example (200 OK)
{
"SubmittedAppsCount": "integer",
"ShowBenefitsTab": "boolean",
"ShowBatchTracking": "boolean",
"ShowRenewalsTab": "boolean",
"Actions": "string"
}
GET /api/memberships/membershiptype/scheduledbillingupdate/history
Response Example (200 OK)
{
"HistoryItems": "string"
}
POST /api/memberships/membershiptype/scheduledbillingupdate/items
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"StatusTypeOptions": "string",
"DateRange": "string",
"NextBillDate": "string",
"Criteria": "string"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/memberships/office/find/employeememberships/{contactid}
contactid:
integer
in path
(no description)
Response Example (200 OK)
{
"ContactId": "integer",
"Message": "string",
"OfficesCount": "integer",
"TotalAgentsCount": "integer"
}
GET /api/memberships/options/lookup
OK
Response Example (200 OK)
[
{
"Id": "integer",
"MembershipTypeOptionId": "integer",
"MembershipTypeOptionName": "string",
"AllowChapterSelection": "boolean",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean"
}
]
GET /api/memberships/reactivate/suspended/{membershipid}
membershipid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"BodyText": "string",
"Name": "string"
}
GET /api/memberships/renew/{membershipid}
membershipid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipId": "integer",
"MembershipTypeId": "integer",
"Price": "number",
"StartDate": "string",
"SalesContactId": "string",
"MembershipJoinReasonId": "string",
"CreateInvoice": "boolean",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"MembershipRenewDecision": "string",
"SelectedDropReason": "string",
"PaymentInfo": "string",
"OwnerContactId": "integer",
"OwnerContactName": "string",
"MembershipTypeName": "string",
"TenantId": "integer",
"SendNotifications": "boolean",
"IsForFreeMembership": "boolean",
"MembershipLevelId": "string",
"Levels": "string",
"FeeItems": "string",
"CustomFields": "string",
"HasOutstandingBillingItems": "boolean",
"CanChargeCustomer": "boolean",
"ForceSetupAutomaticPaymentUse": "boolean",
"FrequencyPaymentOptions": "string",
"PaymentPlanOptions": "string",
"RoundToNearestOnes": "boolean",
"BillFrequencyTypeId": "string",
"TermsUrl": "string",
"PaymentPlanId": "string",
"SendStaffNotifications": "boolean"
}
GET /api/memberships/renewal/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"Name": "string",
"MembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"GracePeriodDays": "integer",
"RenewalNoticeDays": "string",
"ActiveWhenPaid": "boolean",
"FixedAnnualRenewalMonth": "string",
"ProratePartialYears": "boolean",
"ActivationsBeforeUpgrading": "string",
"UpgradeMembershipTypeId": "string"
}
GET /api/memberships/renewals
options:
string
in query
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/memberships/renewals
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean",
"StartDateBetween": "string",
"Tags": "string",
"Frequency": "string",
"PaymentPlanIsFinished": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/memberships/renewals/export
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean",
"StartDateBetween": "string",
"Tags": "string",
"Frequency": "string",
"PaymentPlanIsFinished": "boolean"
}
200 OK
OK
Response Example (200 OK)
{
"Version": "string",
"Content": "string",
"StatusCode": "string",
"ReasonPhrase": "string",
"Headers": "string",
"RequestMessage": "string",
"IsSuccessStatusCode": "boolean"
}
GET /api/memberships/reviewnextbilldates
200 OK
OK
Response Example (200 OK)
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"CurrentDate": "string",
"RollBack": "boolean",
"HelpParagraph": "string",
"ContactStatus": "string",
"MembershipTypeId": "string",
"NextBillDateRange": "string",
"DisableDateEditing": "boolean",
"LoadButton": "string",
"Items": "string",
"Count": "integer"
}
POST /api/memberships/reviewnextbilldates/download
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"CurrentDate": "string",
"RollBack": "boolean",
"HelpParagraph": "string",
"ContactStatus": "string",
"MembershipTypeId": "string",
"NextBillDateRange": "string",
"DisableDateEditing": "boolean",
"LoadButton": "string",
"Items": "string",
"Count": "integer"
}
200 OK
OK
Response Example (200 OK)
{
"JobType": "string",
"Message": "string",
"Result": "string",
"BackgroundJobEstimatedSeconds": "integer",
"JobId": "string",
"PendingDownloadFileId": "integer"
}
POST /api/memberships/reviewnextbilldates/reload
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"CurrentDate": "string",
"RollBack": "boolean",
"HelpParagraph": "string",
"ContactStatus": "string",
"MembershipTypeId": "string",
"NextBillDateRange": "string",
"DisableDateEditing": "boolean",
"LoadButton": "string",
"Items": "string",
"Count": "integer"
}
200 OK
OK
Response Example (200 OK)
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"CurrentDate": "string",
"RollBack": "boolean",
"HelpParagraph": "string",
"ContactStatus": "string",
"MembershipTypeId": "string",
"NextBillDateRange": "string",
"DisableDateEditing": "boolean",
"LoadButton": "string",
"Items": "string",
"Count": "integer"
}
POST /api/memberships/savereviewnextbilldates
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"CurrentDate": "string",
"RollBack": "boolean",
"HelpParagraph": "string",
"ContactStatus": "string",
"MembershipTypeId": "string",
"NextBillDateRange": "string",
"DisableDateEditing": "boolean",
"LoadButton": "string",
"Items": "string",
"Count": "integer"
}
200 OK
OK
GET /api/memberships/searchfororg
search:
string
in query
(no description)
200 OK
OK
type
Response Example (200 OK)
[
{
"Name": "string",
"AccountNumber": "string",
"OrganizationContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string",
"TypeAheadData": "string",
"TypeAheadItemDisplay": "string",
"TypeAheadItemTitle": "string"
}
]
GET /api/memberships/submittedapps
options:
string
in query
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/memberships/submittedapps
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"ShowPending": "boolean",
"ShowApproved": "boolean",
"ShowAll": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/memberships/typeoptions
Response Example (200 OK)
[
{
"Id": "integer",
"MembershipTypeOptionId": "integer",
"MembershipTypeOptionName": "string",
"MembershipTypesUsedBy": "string",
"Actions": "string"
}
]
GET /api/memberships/typeoptions/{membershiptypeoptionid}
membershiptypeoptionid:
integer
in path
(no description)
OK
Response Example (200 OK)
{
"MembershipTypeOptionId": "integer",
"Name": "string",
"AllowOnlinePayment": "boolean",
"AllowBillMe": "boolean",
"HasChapterModule": "boolean",
"ChapterSelection": "string",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"ContactTitles": "string",
"InOutFields": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"Fields": "string",
"DisplayDirectoryCategories": "boolean",
"MembershipTypeOptionCategoryLists": "string",
"MembershipTypeOptionFields": "string",
"FieldOptionsJson": "string"
}
Returns list of membership types with paging parameters
Uses OData object to page and order member types. Example Request: /api/membership/types?skip=0&take=1&orderBy=MembershipTypeId
options:
string
in query
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/memberships/types
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"ShowActive": "boolean",
"ShowInActive": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
GET /api/memberships/types/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"AuditId": "integer",
"Name": "string",
"MembershipEndTypeId": "string",
"IsActive": "boolean",
"DurationMonths": "string",
"OwnerType": "string",
"MembershipRenewalTypeId": "string",
"GracePeriodDays": "integer",
"RenewalNoticeDays": "string",
"ActiveWhenPaid": "boolean",
"UsingBillhighway": "boolean",
"Description": "string",
"BenefitPackageId": "string",
"FeesList": "string",
"SetupFeesList": "string",
"MembershipTypeOptionId": "string",
"DocumentationGenerationTemplateId": "string",
"TermId": "string",
"TermsOfUseId": "string",
"Directories": "string",
"OrganizationLimit": "string",
"FamilyLimit": "string",
"PeopleLimit": "string",
"BillDescription": "string",
"FixedAnnualRenewalMonth": "string",
"ProratePartialYears": "boolean",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"DisplayColor": "string",
"CustomPriceForumula": "string",
"ActivationsBeforeUpgrading": "string",
"UpgradeMembershipTypeId": "string",
"IsOrganizationRequired": "boolean",
"IsFamilyRequired": "boolean",
"FamilyContactsEnabled": "boolean",
"ContactTitles": "string",
"ContactTypesList": "string",
"AddressTypesList": "string",
"PhoneTypesList": "string",
"WebAddressTypesList": "string",
"FamilyDisabled": "boolean",
"AllowChapterSelection": "boolean",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ActiveMembershipCount": "integer",
"IsDeletable": "boolean",
"Fields": "string",
"AllowBillMe": "boolean"
}
GET /api/memberships/types/{membershiptypeid}/frequencies/lookup
membershiptypeid:
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/memberships/types/{membershiptypeid}/frequencies/withoutonceperterm/lookup
membershiptypeid:
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/memberships/types/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"MembershipTypeId": "integer",
"Name": "string",
"DefaultPrice": "number",
"TermId": "string",
"IsFamilyRequired": "boolean",
"IsOrganizationRequired": "boolean",
"DurationMonths": "string",
"DocumentationGenerationTemplateId": "string",
"MembershipEndTypeId": "string",
"ExtraData": "string",
"FeeItems": "string",
"RequireChapterSelection": "boolean",
"IncludeTopLevelSelection": "boolean",
"PaymentGatewayId": "string",
"NewMembersProjectTemplateId": "string",
"CreateNewMemberProject": "boolean",
"BillSchedulePricingJson": "string",
"ProratePartialYears": "boolean",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string",
"MembershipInheritanceTypeId": "string"
}
]
GET /api/memberships/types/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/memberships/types/lookup/activewithlevels
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/memberships/types/multiselect/lookup
200 OK
OK
Response Example (200 OK)
[
{
"Id": "integer",
"Name": "string",
"ExtraData": "string",
"CssColor": "string",
"IsSelected": "boolean",
"IsDeleted": "boolean",
"Order": "integer"
}
]
GET /api/memberships/types/renewaltype/{renewaltypeid}/lookup
renewaltypeid:
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/memberships/types/save
model:
string
in query
(no description)
200 OK
OK
GET /api/memberships/types/upgradelookup/{membershiptypeid}
membershiptypeid:
integer
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/memberships/types/v2/{membershiptypeid}
membershiptypeid:
integer
in path
(no description)
200 OK
OK
Response Example (200 OK)
{
"MembershipTypeId": "integer",
"IsOrganizationRequired": "boolean",
"IsFamilyRequired": "boolean",
"AuditId": "integer",
"PreventEditMessage": "string",
"IsUsedInSync": "boolean",
"Name": "string",
"MembershipInheritanceTypeId": "string",
"DurationMonths": "string",
"OwnerType": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"ShowRenewalPricing": "boolean",
"RenewalPriceCalculationTypeId": "string",
"MembershipEndTypeId": "string",
"OldMembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"GracePeriodDays": "integer",
"RenewalNoticeDays": "string",
"FixedAnnualRenewalMonth": "string",
"StartMembershipDate": "string",
"MembershipExpirationDate": "string",
"ChapterSelection": "string",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"NewMembersProjectTemplateId": "string",
"RenewMembersProjectTemplateId": "string",
"GroupIds": "string",
"GroupSubscriptions": "string",
"Description": "string",
"ActivationsBeforeUpgrading": "string",
"UpgradeMembershipTypeId": "string",
"HasEffectivePrice": "boolean",
"IsFamilyDisabled": "boolean"
}
GET /api/memberships/unpaid
options:
string
in query
(no description)
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
POST /api/memberships/unpaid
undefined
Request Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"PastDue": "string",
"MembershipTypes": "string",
"MembershipLevelId": "string",
"MembershipStatus": "string",
"Tags": "string",
"IsExpired": "boolean",
"InvoiceDate": "string",
"MembershipId": "string",
"PurchaseId": "string",
"Criteria": "string",
"InvoiceAmountGreater": "string",
"InvoiceAmountLess": "string",
"DropAllMembershipsForOwners": "boolean",
"IsSaving": "boolean"
}
Response Example (200 OK)
{
"Criteria": "string",
"CriteriaItems": "string",
"TotalRecordAvailable": "string",
"ModelItems": "string",
"Results": "string"
}
Schema Definitions
ListViewReturnModel<MembershipRenewalCollectionItemModel>: 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"
}
MembershipRenewalsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- EndDateBetween: string
- MembershipTypeId: string
- MembershipLevelId: string
- RenewalMonth: string
- Criteria: string
- MembershipStatus: string
- IsDuplicateEmail: boolean
- StartDateBetween: string
- Tags: string
- Frequency: string
- PaymentPlanIsFinished: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean",
"StartDateBetween": "string",
"Tags": "string",
"Frequency": "string",
"PaymentPlanIsFinished": "boolean"
}
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"
}
BulkMembershipRenewalModel: object
- Note: string
- Today: string
- Tomorrow: string
- MembershipIds: string
- MembershipCount: integer
- MembershipTypeId: string
- MembershipLevelId: string
- PlanOrFrequencyId: string
- InvoiceDate: string
- BestPracticesIsEnabled: boolean
- AutoSetNextBillDate: boolean
- ManualNextBillDate: string
Example
{
"Note": "string",
"Today": "string",
"Tomorrow": "string",
"MembershipIds": "string",
"MembershipCount": "integer",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"PlanOrFrequencyId": "string",
"InvoiceDate": "string",
"BestPracticesIsEnabled": "boolean",
"AutoSetNextBillDate": "boolean",
"ManualNextBillDate": "string"
}
ListViewReturnModel<MembershipCollectionItemModel>: 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"
}
MembershipAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- EndDateBetween: string
- MembershipTypeId: string
- MembershipLevelId: string
- RenewalMonth: string
- Criteria: string
- MembershipStatus: string
- IsDuplicateEmail: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"EndDateBetween": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"RenewalMonth": "string",
"Criteria": "string",
"MembershipStatus": "string",
"IsDuplicateEmail": "boolean"
}
MembershipBaseViewModel: object
- MembershipId: integer
- AuditId: integer
- MembershipStatusTypeId: string
- Name: string
- Actions: string
Example
{
"MembershipId": "integer",
"AuditId": "integer",
"MembershipStatusTypeId": "string",
"Name": "string",
"Actions": "string"
}
MembershipSearchKeyValueData: object
- ModelType: string
- Items: string
- TotalRecordAvailable: string
Example
{
"ModelType": "string",
"Items": "string",
"TotalRecordAvailable": "string"
}
MembershipGeneralInfoViewModel: object
- MembershipId: integer
- MembershipType: string
- MembershipStatusType: string
- MembershipCategory: string
- Number: string
- MembershipOwner: string
- OwnerContactId: integer
- PrimaryContact: string
- PrimaryContactId: integer
- ChapterName: string
- ReferralContact: string
- BillFrequencyType: string
- Members: string
- Activations: string
- ReferredByContactId: string
Example
{
"MembershipId": "integer",
"MembershipType": "string",
"MembershipStatusType": "string",
"MembershipCategory": "string",
"Number": "string",
"MembershipOwner": "string",
"OwnerContactId": "integer",
"PrimaryContact": "string",
"PrimaryContactId": "integer",
"ChapterName": "string",
"ReferralContact": "string",
"BillFrequencyType": "string",
"Members": "string",
"Activations": "string",
"ReferredByContactId": "string"
}
MembershipFinancialViewModel: object
- ContactId: integer
- SystemContactTypeId: string
- ShowProcessAch: boolean
- OptionalPaymentTypes: string
- AllowAutoRecalcRenewalBilling: boolean
- ContactBalance: string
- Balance: number
- BillingNotes: string
- MembershipsBilling: string
- ScheduledBilling: string
- PaymentProfile: string
- BillingHistory: string
- MembershipId: integer
- Purchases: string
- Invoices: string
Example
{
"ContactId": "integer",
"SystemContactTypeId": "string",
"ShowProcessAch": "boolean",
"OptionalPaymentTypes": "string",
"AllowAutoRecalcRenewalBilling": "boolean",
"ContactBalance": "string",
"Balance": "number",
"BillingNotes": "string",
"MembershipsBilling": "string",
"ScheduledBilling": "string",
"PaymentProfile": "string",
"BillingHistory": "string",
"MembershipId": "integer",
"Purchases": "string",
"Invoices": "string"
}
AddMembershipViewModel: object
- ContactName: string
- MembershipTypeId: string
- ProratePartialYears: boolean
- PreviousMembershipTypeId: string
- MembershipLevelId: string
- DurationMonths: string
- ChapterId: string
- RoundToNearestOnes: boolean
- Number: string
- IsCourtesy: boolean
- SalesContactId: string
- MembershipJoinReasonId: string
- ReferredByContact: string
- ReferredByContactId: string
- RenewalPriceCalculationTypeIdOverride: string
- MembershipStatus: string
- Fields: string
- Yesterday: string
- ContactId: integer
- PrimaryContactId: string
- SystemContactTypeId: string
- PricingTypeId: string
- ProratedWarningMessage: string
- PlanOrFrequencyId: string
- BillingStartDate: string
- StartDate: string
- FeeItems: string
- OncePerTermFeeItems: string
- OneTimeFeeItems: string
- PrintInvoice: boolean
- EmailInvoice: boolean
- BillingContactId: string
- BillingAddressId: string
- BillingEmailId: string
- TermId: string
- InvoiceMessage: string
- JoinDate: string
- ExpirationDate: string
- MembershipRenewalTypeId: string
- MembershipEndTypeId: string
- GracePeriodExpirationDate: string
- RenewalNotificationDate: string
- SendNewMemberWelcome: boolean
- CreateNewMemberProject: boolean
- ProjectTemplateId: string
- NextBillingDate: string
- SoftwareCustomerKey: string
-
Specific to MicroNet so we can link back to the customer's account
- FixedAnnualRenewalMonth: string
- PaymentProfileId: string
- ShowNextBillDate: boolean
- HasLevels: boolean
- IsTaxExempt: boolean
- TaxRegionId: string
- ContactTaxSetRate: number
- ContactTaxSetFloatAmount: number
- PaymentGatewayId: string
- VoluntaryItems: string
- ChapterIds: string
- PurchaseIds: string
- InvoiceNumber: string
- PaymentInfo: string
- DisableDateEditing: boolean
- SendStaffNotifications: boolean
Example
{
"ContactName": "string",
"MembershipTypeId": "string",
"ProratePartialYears": "boolean",
"PreviousMembershipTypeId": "string",
"MembershipLevelId": "string",
"DurationMonths": "string",
"ChapterId": "string",
"RoundToNearestOnes": "boolean",
"Number": "string",
"IsCourtesy": "boolean",
"SalesContactId": "string",
"MembershipJoinReasonId": "string",
"ReferredByContact": "string",
"ReferredByContactId": "string",
"RenewalPriceCalculationTypeIdOverride": "string",
"MembershipStatus": "string",
"Fields": "string",
"Yesterday": "string",
"ContactId": "integer",
"PrimaryContactId": "string",
"SystemContactTypeId": "string",
"PricingTypeId": "string",
"ProratedWarningMessage": "string",
"PlanOrFrequencyId": "string",
"BillingStartDate": "string",
"StartDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"JoinDate": "string",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"NextBillingDate": "string",
"SoftwareCustomerKey": "string",
"FixedAnnualRenewalMonth": "string",
"PaymentProfileId": "string",
"ShowNextBillDate": "boolean",
"HasLevels": "boolean",
"IsTaxExempt": "boolean",
"TaxRegionId": "string",
"ContactTaxSetRate": "number",
"ContactTaxSetFloatAmount": "number",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"PaymentInfo": "string",
"DisableDateEditing": "boolean",
"SendStaffNotifications": "boolean"
}
EditMembershipModel: object
- MembershipId: integer
- AuditId: integer
- MembershipTypeId: integer
- Price: number
- StartDate: string
- EndDate: string
- BillFrequencyTypeId: string
- SalesStaffContactId: string
Example
{
"MembershipId": "integer",
"AuditId": "integer",
"MembershipTypeId": "integer",
"Price": "number",
"StartDate": "string",
"EndDate": "string",
"BillFrequencyTypeId": "string",
"SalesStaffContactId": "string"
}
UpgradeDowngradeMembershipViewModel: object
- MembershipId: integer
- ContactId: integer
- SystemContactTypeId: string
- MembershipJoinReasonId: string
- SendNewMemberWelcome: boolean
- CreateNewMemberProject: boolean
- ProjectTemplateId: string
- ChangeType: string
- Change: string
- MembershipTypeId: string
- MembershipLevelId: string
- DurationMonths: string
- ChapterId: string
- SalesContactId: string
- Notes: string
- Fields: string
- Instructions: string
- PlanOrFrequencyId: string
- NextBillingDate: string
- StartDate: string
- FeeItems: string
- OncePerTermFeeItems: string
- OneTimeFeeItems: string
- OldFeeItems: string
- MembershipTypeDurationMonths: string
- MembershipTypeFixedAnnualRenewalMonth: string
- FixedAnnualRenewalMonth: string
- Name: string
- PrintInvoice: boolean
- EmailInvoice: boolean
- BillingContactId: string
- BillingAddressId: string
- BillingEmailId: string
- TermId: string
- InvoiceMessage: string
- BillingStartDate: string
- SameNextBillDates: boolean
- ExpirationDate: string
- MembershipRenewalTypeId: string
- MembershipEndTypeId: string
- GracePeriodExpirationDate: string
- RenewalNotificationDate: string
- Yesterday: string
- PricingTypeId: string
- RoundToNearestOnes: boolean
- PaymentGatewayId: string
- VoluntaryItems: string
- ChapterIds: string
- PurchaseIds: string
- InvoiceNumber: string
- HasLevels: boolean
- GracePeriodDays: integer
- InitialExpirationDate: string
- DisableDateEditing: boolean
- SendStaffNotifications: boolean
Example
{
"MembershipId": "integer",
"ContactId": "integer",
"SystemContactTypeId": "string",
"MembershipJoinReasonId": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"ChangeType": "string",
"Change": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"DurationMonths": "string",
"ChapterId": "string",
"SalesContactId": "string",
"Notes": "string",
"Fields": "string",
"Instructions": "string",
"PlanOrFrequencyId": "string",
"NextBillingDate": "string",
"StartDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"OldFeeItems": "string",
"MembershipTypeDurationMonths": "string",
"MembershipTypeFixedAnnualRenewalMonth": "string",
"FixedAnnualRenewalMonth": "string",
"Name": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"BillingStartDate": "string",
"SameNextBillDates": "boolean",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"Yesterday": "string",
"PricingTypeId": "string",
"RoundToNearestOnes": "boolean",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"HasLevels": "boolean",
"GracePeriodDays": "integer",
"InitialExpirationDate": "string",
"DisableDateEditing": "boolean",
"SendStaffNotifications": "boolean"
}
ReactivateSuspendedMembershipModel: object
- MembershipId: integer
- BodyText: string
- Name: string
Example
{
"MembershipId": "integer",
"BodyText": "string",
"Name": "string"
}
AdjustmentMembershipViewModel: object
- MembershipId: integer
- forceSave: boolean
- ContactId: integer
- SalesContactId: string
- MembershipJoinReasonId: string
- NoAdjustment: string
- ChangeType: string
- Change: string
- MembershipTypeId: string
- MembershipLevelId: string
- MembershipType: string
- ChapterId: string
- DurationMonths: string
- Notes: string
- OriginalBillFrequencyTypeId: integer
- Instructions: string
- PlanOrFrequencyId: integer
- NextBillingDate: string
- FeeItems: string
- OncePerTermFeeItems: string
- OneTimeFeeItems: string
- OldFeeItems: string
- ShowNextBillDate: boolean
- PaymentGatewayId: string
- VoluntaryItems: string
- ChapterIds: string
- PurchaseIds: string
- InvoiceNumber: string
- PrintInvoice: boolean
- EmailInvoice: boolean
- BillingContactId: string
- BillingAddressId: string
- BillingEmailId: string
- TermId: string
- InvoiceMessage: string
- StartDate: string
- BillingStartDate: string
- SameNextBillDates: boolean
- ExpirationDate: string
- MembershipRenewalTypeId: string
- MembershipEndTypeId: string
- GracePeriodExpirationDate: string
- RenewalNotificationDate: string
- Yesterday: string
- SendNewMemberWelcome: boolean
- CreateNewMemberProject: boolean
- ProjectTemplateId: string
- DisableDateEditing: boolean
- FixedAnnualRenewalMonth: string
- SendStaffNotifications: boolean
Example
{
"MembershipId": "integer",
"forceSave": "boolean",
"ContactId": "integer",
"SalesContactId": "string",
"MembershipJoinReasonId": "string",
"NoAdjustment": "string",
"ChangeType": "string",
"Change": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"MembershipType": "string",
"ChapterId": "string",
"DurationMonths": "string",
"Notes": "string",
"OriginalBillFrequencyTypeId": "integer",
"Instructions": "string",
"PlanOrFrequencyId": "integer",
"NextBillingDate": "string",
"FeeItems": "string",
"OncePerTermFeeItems": "string",
"OneTimeFeeItems": "string",
"OldFeeItems": "string",
"ShowNextBillDate": "boolean",
"PaymentGatewayId": "string",
"VoluntaryItems": "string",
"ChapterIds": "string",
"PurchaseIds": "string",
"InvoiceNumber": "string",
"PrintInvoice": "boolean",
"EmailInvoice": "boolean",
"BillingContactId": "string",
"BillingAddressId": "string",
"BillingEmailId": "string",
"TermId": "string",
"InvoiceMessage": "string",
"StartDate": "string",
"BillingStartDate": "string",
"SameNextBillDates": "boolean",
"ExpirationDate": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"GracePeriodExpirationDate": "string",
"RenewalNotificationDate": "string",
"Yesterday": "string",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string",
"SendStaffNotifications": "boolean"
}
MembershipDetailsViewModel: object
- MembershipId: integer
- MembershipActivationId: integer
- AuditId: integer
- ContactId: integer
-
This seems used as mebership owner contact
- MembershipContactId: string
-
This ContactId is used for memebrship of a contact
- MembershipName: string
- MembershipStatusType: string
- MembershipStatusTypeId: string
- MembershipCategory: string
- MembershipNumber: string
- ChapterId: string
- StartDate: string
- ExpirationDate: string
- ExpirationDateString: string
- GraceExpirationDate: string
- GraceExpirationDateString: string
- RenewsIn: string
- RenewalMonth: string
- IsCourtesy: boolean
- IsPrimaryMembership: boolean
- ReferredByContactId: string
- MembershipDropReasonId: string
- DropNotes: string
- AnyActivationsAutomatic: boolean
- ContactHelpText: string
- OwnerContactName: string
- OwnerContactEmail: string
- ReferredByContact: string
- PrimaryContactId: string
- PrimaryContactEmail: string
- BillingContactId: string
- BillingContactEmail: string
- ObjectTypeId: string
- SearchObjectTypeId: string
- MembershipTypeOptionId: string
- ActivationList: string
- MsiId: string
- Fields: string
- CalculatedEndType: string
- MembershipTypeMembershipRenewalTypeId: string
- MembershipTypeMembershipEndTypeId: string
- ShouldShowMembershipOverride: boolean
- MembershipTypeMembershipRenewalTypeIdString: string
- MembershipRenewalTypeId: string
- MembershipTypeMembershipEndTypeIdString: string
- MembershipEndTypeId: string
- MembershipTypeRenewalPriceCalculationTypeString: string
- RenewalPriceCalculationTypeIdOverride: string
- MembershipTypeRenewalPriceCalculationTypeId: string
- ShowRenewalPricing: boolean
- AnyAutomaticMembership: boolean
- ContactIds: string
- forceSave: boolean
- AuditInfo: string
- DisablePrimaryMembership: boolean
Example
{
"MembershipId": "integer",
"MembershipActivationId": "integer",
"AuditId": "integer",
"ContactId": "integer",
"MembershipContactId": "string",
"MembershipName": "string",
"MembershipStatusType": "string",
"MembershipStatusTypeId": "string",
"MembershipCategory": "string",
"MembershipNumber": "string",
"ChapterId": "string",
"StartDate": "string",
"ExpirationDate": "string",
"ExpirationDateString": "string",
"GraceExpirationDate": "string",
"GraceExpirationDateString": "string",
"RenewsIn": "string",
"RenewalMonth": "string",
"IsCourtesy": "boolean",
"IsPrimaryMembership": "boolean",
"ReferredByContactId": "string",
"MembershipDropReasonId": "string",
"DropNotes": "string",
"AnyActivationsAutomatic": "boolean",
"ContactHelpText": "string",
"OwnerContactName": "string",
"OwnerContactEmail": "string",
"ReferredByContact": "string",
"PrimaryContactId": "string",
"PrimaryContactEmail": "string",
"BillingContactId": "string",
"BillingContactEmail": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"MembershipTypeOptionId": "string",
"ActivationList": "string",
"MsiId": "string",
"Fields": "string",
"CalculatedEndType": "string",
"MembershipTypeMembershipRenewalTypeId": "string",
"MembershipTypeMembershipEndTypeId": "string",
"ShouldShowMembershipOverride": "boolean",
"MembershipTypeMembershipRenewalTypeIdString": "string",
"MembershipRenewalTypeId": "string",
"MembershipTypeMembershipEndTypeIdString": "string",
"MembershipEndTypeId": "string",
"MembershipTypeRenewalPriceCalculationTypeString": "string",
"RenewalPriceCalculationTypeIdOverride": "string",
"MembershipTypeRenewalPriceCalculationTypeId": "string",
"ShowRenewalPricing": "boolean",
"AnyAutomaticMembership": "boolean",
"ContactIds": "string",
"forceSave": "boolean",
"AuditInfo": "string",
"DisablePrimaryMembership": "boolean"
}
MembershipRelatedContactsViewModel: object
- MembershipId: integer
- OwnerContactId: integer
- MembershipTypeIndividualLimit: integer
- RelatedContacts: string
Example
{
"MembershipId": "integer",
"OwnerContactId": "integer",
"MembershipTypeIndividualLimit": "integer",
"RelatedContacts": "string"
}
RenewMembershipModel: object
- MembershipId: integer
- MembershipTypeId: integer
- Price: number
- StartDate: string
- SalesContactId: string
- MembershipJoinReasonId: string
- CreateInvoice: boolean
- SendNewMemberWelcome: boolean
- CreateNewMemberProject: boolean
- ProjectTemplateId: string
- MembershipRenewDecision: string
- SelectedDropReason: string
- PaymentInfo: string
- OwnerContactId: integer
- OwnerContactName: string
- MembershipTypeName: string
- TenantId: integer
- SendNotifications: boolean
- IsForFreeMembership: boolean
- MembershipLevelId: string
- Levels: string
- FeeItems: string
- CustomFields: string
- HasOutstandingBillingItems: boolean
- CanChargeCustomer: boolean
- ForceSetupAutomaticPaymentUse: boolean
- FrequencyPaymentOptions: string
- PaymentPlanOptions: string
- RoundToNearestOnes: boolean
- BillFrequencyTypeId: string
- TermsUrl: string
- PaymentPlanId: string
- SendStaffNotifications: boolean
Example
{
"MembershipId": "integer",
"MembershipTypeId": "integer",
"Price": "number",
"StartDate": "string",
"SalesContactId": "string",
"MembershipJoinReasonId": "string",
"CreateInvoice": "boolean",
"SendNewMemberWelcome": "boolean",
"CreateNewMemberProject": "boolean",
"ProjectTemplateId": "string",
"MembershipRenewDecision": "string",
"SelectedDropReason": "string",
"PaymentInfo": "string",
"OwnerContactId": "integer",
"OwnerContactName": "string",
"MembershipTypeName": "string",
"TenantId": "integer",
"SendNotifications": "boolean",
"IsForFreeMembership": "boolean",
"MembershipLevelId": "string",
"Levels": "string",
"FeeItems": "string",
"CustomFields": "string",
"HasOutstandingBillingItems": "boolean",
"CanChargeCustomer": "boolean",
"ForceSetupAutomaticPaymentUse": "boolean",
"FrequencyPaymentOptions": "string",
"PaymentPlanOptions": "string",
"RoundToNearestOnes": "boolean",
"BillFrequencyTypeId": "string",
"TermsUrl": "string",
"PaymentPlanId": "string",
"SendStaffNotifications": "boolean"
}
DropMembershipModel: object
- MembershipId: integer
- OwnerContactId: integer
- SystemContactType: string
- MembershipContactContactId: integer
- Today: string
- MemberShipName: string
- OwnerContactName: string
- ActionType: string
- EndDate: string
- MembershipDropReasonId: string
- MemberRoleId: string
- DropCommunicationBody: string
- RemoveAllDirectoryListings: boolean
- RemoveFromList: boolean
- InvoiceProcedure: string
- OpenInvoices: string
- DropCommunicationId: string
- RoleId: string
- AssociatedStaff: string
- AssociatedStaffCount: integer
- forceSave: boolean
Example
{
"MembershipId": "integer",
"OwnerContactId": "integer",
"SystemContactType": "string",
"MembershipContactContactId": "integer",
"Today": "string",
"MemberShipName": "string",
"OwnerContactName": "string",
"ActionType": "string",
"EndDate": "string",
"MembershipDropReasonId": "string",
"MemberRoleId": "string",
"DropCommunicationBody": "string",
"RemoveAllDirectoryListings": "boolean",
"RemoveFromList": "boolean",
"InvoiceProcedure": "string",
"OpenInvoices": "string",
"DropCommunicationId": "string",
"RoleId": "string",
"AssociatedStaff": "string",
"AssociatedStaffCount": "integer",
"forceSave": "boolean"
}
IQueryable: object
- Expression: string
- ElementType: string
- Provider: string
Example
{
"Expression": "string",
"ElementType": "string",
"Provider": "string"
}
ListViewReturnModel<MembershipTypeCollectionItemModel>: 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"
}
MembershipTypeAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- Criteria: string
- ShowActive: boolean
- ShowInActive: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"ShowActive": "boolean",
"ShowInActive": "boolean"
}
MembershipTypeAddEditModel: object
- MembershipTypeId: integer
- AuditId: integer
- Name: string
- MembershipEndTypeId: string
- IsActive: boolean
- DurationMonths: string
- OwnerType: string
- MembershipRenewalTypeId: string
- GracePeriodDays: integer
- RenewalNoticeDays: string
- ActiveWhenPaid: boolean
- UsingBillhighway: boolean
- Description: string
- BenefitPackageId: string
- FeesList: string
- SetupFeesList: string
- MembershipTypeOptionId: string
- DocumentationGenerationTemplateId: string
- TermId: string
- TermsOfUseId: string
- Directories: string
- OrganizationLimit: string
- FamilyLimit: string
- PeopleLimit: string
- BillDescription: string
- FixedAnnualRenewalMonth: string
- ProratePartialYears: boolean
- CategoryTypeId: string
- CategoryItemId: string
- DisplayColor: string
- CustomPriceForumula: string
- ActivationsBeforeUpgrading: string
- UpgradeMembershipTypeId: string
- IsOrganizationRequired: boolean
- IsFamilyRequired: boolean
- FamilyContactsEnabled: boolean
- ContactTitles: string
- ContactTypesList: string
- AddressTypesList: string
- PhoneTypesList: string
- WebAddressTypesList: string
- FamilyDisabled: boolean
- AllowChapterSelection: boolean
- IncludeTopLevelSelection: boolean
- RequireTopLevelMembership: boolean
- ObjectTypeId: string
- SearchObjectTypeId: string
- ActiveMembershipCount: integer
- IsDeletable: boolean
- Fields: string
- AllowBillMe: boolean
Example
{
"MembershipTypeId": "integer",
"AuditId": "integer",
"Name": "string",
"MembershipEndTypeId": "string",
"IsActive": "boolean",
"DurationMonths": "string",
"OwnerType": "string",
"MembershipRenewalTypeId": "string",
"GracePeriodDays": "integer",
"RenewalNoticeDays": "string",
"ActiveWhenPaid": "boolean",
"UsingBillhighway": "boolean",
"Description": "string",
"BenefitPackageId": "string",
"FeesList": "string",
"SetupFeesList": "string",
"MembershipTypeOptionId": "string",
"DocumentationGenerationTemplateId": "string",
"TermId": "string",
"TermsOfUseId": "string",
"Directories": "string",
"OrganizationLimit": "string",
"FamilyLimit": "string",
"PeopleLimit": "string",
"BillDescription": "string",
"FixedAnnualRenewalMonth": "string",
"ProratePartialYears": "boolean",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"DisplayColor": "string",
"CustomPriceForumula": "string",
"ActivationsBeforeUpgrading": "string",
"UpgradeMembershipTypeId": "string",
"IsOrganizationRequired": "boolean",
"IsFamilyRequired": "boolean",
"FamilyContactsEnabled": "boolean",
"ContactTitles": "string",
"ContactTypesList": "string",
"AddressTypesList": "string",
"PhoneTypesList": "string",
"WebAddressTypesList": "string",
"FamilyDisabled": "boolean",
"AllowChapterSelection": "boolean",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ActiveMembershipCount": "integer",
"IsDeletable": "boolean",
"Fields": "string",
"AllowBillMe": "boolean"
}
MembershipTypeSelectModel: object
- Id: integer
- MembershipTypeId: integer
- Name: string
- DefaultPrice: number
- TermId: string
- IsFamilyRequired: boolean
- IsOrganizationRequired: boolean
- DurationMonths: string
- DocumentationGenerationTemplateId: string
- MembershipEndTypeId: string
- ExtraData: string
- FeeItems: string
- RequireChapterSelection: boolean
- IncludeTopLevelSelection: boolean
- PaymentGatewayId: string
- NewMembersProjectTemplateId: string
- CreateNewMemberProject: boolean
- BillSchedulePricingJson: string
- ProratePartialYears: boolean
- DisableDateEditing: boolean
- FixedAnnualRenewalMonth: string
- MembershipInheritanceTypeId: string
Example
{
"Id": "integer",
"MembershipTypeId": "integer",
"Name": "string",
"DefaultPrice": "number",
"TermId": "string",
"IsFamilyRequired": "boolean",
"IsOrganizationRequired": "boolean",
"DurationMonths": "string",
"DocumentationGenerationTemplateId": "string",
"MembershipEndTypeId": "string",
"ExtraData": "string",
"FeeItems": "string",
"RequireChapterSelection": "boolean",
"IncludeTopLevelSelection": "boolean",
"PaymentGatewayId": "string",
"NewMembersProjectTemplateId": "string",
"CreateNewMemberProject": "boolean",
"BillSchedulePricingJson": "string",
"ProratePartialYears": "boolean",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string",
"MembershipInheritanceTypeId": "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"
}
MembershipTypeOptionSelectModel: object
- Id: integer
- MembershipTypeOptionId: integer
- MembershipTypeOptionName: string
- AllowChapterSelection: boolean
- IncludeTopLevelSelection: boolean
- RequireTopLevelMembership: boolean
Example
{
"Id": "integer",
"MembershipTypeOptionId": "integer",
"MembershipTypeOptionName": "string",
"AllowChapterSelection": "boolean",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean"
}
MembershipTypeOptionCollectionItemModel: object
- Id: integer
- MembershipTypeOptionId: integer
- MembershipTypeOptionName: string
- MembershipTypesUsedBy: string
- Actions: string
Example
{
"Id": "integer",
"MembershipTypeOptionId": "integer",
"MembershipTypeOptionName": "string",
"MembershipTypesUsedBy": "string",
"Actions": "string"
}
MembershipTypeOptionAddEditModel: object
- MembershipTypeOptionId: integer
- Name: string
- AllowOnlinePayment: boolean
- AllowBillMe: boolean
- HasChapterModule: boolean
- ChapterSelection: string
- IncludeTopLevelSelection: boolean
- RequireTopLevelMembership: boolean
- ContactTitles: string
- InOutFields: string
- ObjectTypeId: string
- SearchObjectTypeId: string
- Fields: string
- DisplayDirectoryCategories: boolean
- MembershipTypeOptionCategoryLists: string
- MembershipTypeOptionFields: string
- FieldOptionsJson: string
Example
{
"MembershipTypeOptionId": "integer",
"Name": "string",
"AllowOnlinePayment": "boolean",
"AllowBillMe": "boolean",
"HasChapterModule": "boolean",
"ChapterSelection": "string",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"ContactTitles": "string",
"InOutFields": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"Fields": "string",
"DisplayDirectoryCategories": "boolean",
"MembershipTypeOptionCategoryLists": "string",
"MembershipTypeOptionFields": "string",
"FieldOptionsJson": "string"
}
MembershipJoinReasonCollectionItemModel: object
- JoinReasonId: integer
- Id: integer
- Name: string
- Description: string
- StandardJoinReasonId: string
- StandardJoinReason: string
- Actions: string
Example
{
"JoinReasonId": "integer",
"Id": "integer",
"Name": "string",
"Description": "string",
"StandardJoinReasonId": "string",
"StandardJoinReason": "string",
"Actions": "string"
}
MembershipJoinReasonAddEditModel: object
- JoinReasonId: integer
- Reason: string
- Description: string
- StandardJoinReasonId: string
Example
{
"JoinReasonId": "integer",
"Reason": "string",
"Description": "string",
"StandardJoinReasonId": "string"
}
MembershipDropReasonCollectionItemModel: object
- DropReasonId: integer
- Id: integer
- Name: string
- Description: string
- StandardDropReasonId: string
- StandardDropReason: string
- IsPublic: string
- Actions: string
Example
{
"DropReasonId": "integer",
"Id": "integer",
"Name": "string",
"Description": "string",
"StandardDropReasonId": "string",
"StandardDropReason": "string",
"IsPublic": "string",
"Actions": "string"
}
MembershipDropReasonAddEditModel: object
- DropReasonId: integer
- Reason: string
- Description: string
- StandardDropReasonId: string
- IsPublic: boolean
Example
{
"DropReasonId": "integer",
"Reason": "string",
"Description": "string",
"StandardDropReasonId": "string",
"IsPublic": "boolean"
}
MembershipActivationEditViewModel: object
- MembershipActivationId: integer
- MembershipId: integer
- TenantId: integer
- AuditId: integer
- BillFrequencyTypeId: string
- MembershipPurchaseTypeId: string
- Notes: string
- StartDate: string
- EndDate: string
- ExpirationDate: string
- RenewalDate: string
- GracePeriodExpirationDate: string
- ParentRenewalIsNotification: boolean
- ParentEndTypeIsDurationExpires: boolean
- SalesContactId: string
- JoinReasonId: string
- MembershipRenewalTypeId: string
- MembershipEndTypeId: string
- DisableDateEditing: boolean
- FixedAnnualRenewalMonth: string
Example
{
"MembershipActivationId": "integer",
"MembershipId": "integer",
"TenantId": "integer",
"AuditId": "integer",
"BillFrequencyTypeId": "string",
"MembershipPurchaseTypeId": "string",
"Notes": "string",
"StartDate": "string",
"EndDate": "string",
"ExpirationDate": "string",
"RenewalDate": "string",
"GracePeriodExpirationDate": "string",
"ParentRenewalIsNotification": "boolean",
"ParentEndTypeIsDurationExpires": "boolean",
"SalesContactId": "string",
"JoinReasonId": "string",
"MembershipRenewalTypeId": "string",
"MembershipEndTypeId": "string",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string"
}
MembershipActivationLinkedInvoicesModel: object
- MembershipActivationId: integer
- ContactId: integer
- Type: string
- StartDate: string
- StartDateString: string
- ExpirationDate: string
- ExpirationDateString: string
- MembershipEndTypeId: string
- ParentRenewalIsNotification: boolean
- ParentEndTypeIsDurationExpires: boolean
- GraceExpirationDate: string
- GraceExpirationDateString: string
- Invoices: string
Example
{
"MembershipActivationId": "integer",
"ContactId": "integer",
"Type": "string",
"StartDate": "string",
"StartDateString": "string",
"ExpirationDate": "string",
"ExpirationDateString": "string",
"MembershipEndTypeId": "string",
"ParentRenewalIsNotification": "boolean",
"ParentEndTypeIsDurationExpires": "boolean",
"GraceExpirationDate": "string",
"GraceExpirationDateString": "string",
"Invoices": "string"
}
MembershipActivationLinkToInvoiceModel: object
- MembershipActivationId: integer
- ContactId: integer
- SaleableItemTypeId: string
- Invoices: string
Example
{
"MembershipActivationId": "integer",
"ContactId": "integer",
"SaleableItemTypeId": "string",
"Invoices": "string"
}
ItemChoiceModel: object
- IsSelected: boolean
- PreviouslySelected: boolean
- Id: integer
- Name: string
- Order: integer
Example
{
"IsSelected": "boolean",
"PreviouslySelected": "boolean",
"Id": "integer",
"Name": "string",
"Order": "integer"
}
MembershipAppFormCollectionItemModel: object
- MembershipApplicationFormId: integer
- Name: string
- Description: string
- Url: string
- Actions: string
Example
{
"MembershipApplicationFormId": "integer",
"Name": "string",
"Description": "string",
"Url": "string",
"Actions": "string"
}
MembershipAppAddEditViewModel: object
- MembershipApplicationFormId: integer
- AuditId: integer
- Name: string
- Description: string
- AllowChapterSelection: boolean
- ShowMemTypeDesc: string
- CollectDonations: boolean
- AutoApproveApps: string
- OrderLowestToHighest: string
- CollectEmailSignupLists: string
- HidePricingOnMembershipSelection: boolean
- ShowOrganizationTypeAhead: boolean
- ForceOrganizationSelection: boolean
- ShowAdditionalConfirmation: boolean
- CapturePaymentProfileAndChargeOnApproval: boolean
- HideProratedTotal: boolean
- MembershipTypeId: string
- TemplateId: string
- ReceiptTemplateId: string
- FundraisingCampaignIds: string
- Addons: string
- CustomRedirectUrl: string
- RedirectToHub: string
- SubmitButtonText: string
- Url: string
- RequirePrivacyAcceptance: boolean
- PrivacyTermsOfUseId: string
- Instructions: string
- CompletionMessage: string
- AdditionalConfirmationMessage: string
- PaymentGatewayTypeId: integer
- MemberApplicationVersion: string
Example
{
"MembershipApplicationFormId": "integer",
"AuditId": "integer",
"Name": "string",
"Description": "string",
"AllowChapterSelection": "boolean",
"ShowMemTypeDesc": "string",
"CollectDonations": "boolean",
"AutoApproveApps": "string",
"OrderLowestToHighest": "string",
"CollectEmailSignupLists": "string",
"HidePricingOnMembershipSelection": "boolean",
"ShowOrganizationTypeAhead": "boolean",
"ForceOrganizationSelection": "boolean",
"ShowAdditionalConfirmation": "boolean",
"CapturePaymentProfileAndChargeOnApproval": "boolean",
"HideProratedTotal": "boolean",
"MembershipTypeId": "string",
"TemplateId": "string",
"ReceiptTemplateId": "string",
"FundraisingCampaignIds": "string",
"Addons": "string",
"CustomRedirectUrl": "string",
"RedirectToHub": "string",
"SubmitButtonText": "string",
"Url": "string",
"RequirePrivacyAcceptance": "boolean",
"PrivacyTermsOfUseId": "string",
"Instructions": "string",
"CompletionMessage": "string",
"AdditionalConfirmationMessage": "string",
"PaymentGatewayTypeId": "integer",
"MemberApplicationVersion": "string"
}
ManageMembershipCustomFieldsModel: object
- ObjectTypeId: string
- SearchObjectTypeId: string
- ContentListId: string
- DirectoryId: string
- FormId: string
- MembershipTypeOptionId: string
- ProjectTypeId: string
- MembershipTypeId: string
- MembershipId: integer
- Fields: string
Example
{
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"ContentListId": "string",
"DirectoryId": "string",
"FormId": "string",
"MembershipTypeOptionId": "string",
"ProjectTypeId": "string",
"MembershipTypeId": "string",
"MembershipId": "integer",
"Fields": "string"
}
EditMembershipsBillingSettingsModel: object
- MembershipId: integer
- ContactId: integer
- ScheduledBillingItems: string
Example
{
"MembershipId": "integer",
"ContactId": "integer",
"ScheduledBillingItems": "string"
}
AddEditMembershipTypeModel: object
- MembershipTypeId: integer
- IsOrganizationRequired: boolean
- IsFamilyRequired: boolean
- AuditId: integer
- PreventEditMessage: string
- IsUsedInSync: boolean
- Name: string
- MembershipInheritanceTypeId: string
- DurationMonths: string
- OwnerType: string
- CategoryTypeId: string
- CategoryItemId: string
- IsActive: boolean
- ShowRenewalPricing: boolean
- RenewalPriceCalculationTypeId: string
- MembershipEndTypeId: string
- OldMembershipEndTypeId: string
- MembershipRenewalTypeId: string
- GracePeriodDays: integer
- RenewalNoticeDays: string
- FixedAnnualRenewalMonth: string
- StartMembershipDate: string
- MembershipExpirationDate: string
- ChapterSelection: string
- IncludeTopLevelSelection: boolean
- RequireTopLevelMembership: boolean
- NewMembersProjectTemplateId: string
- RenewMembersProjectTemplateId: string
- GroupIds: string
- GroupSubscriptions: string
- Description: string
- ActivationsBeforeUpgrading: string
- UpgradeMembershipTypeId: string
- HasEffectivePrice: boolean
- IsFamilyDisabled: boolean
Example
{
"MembershipTypeId": "integer",
"IsOrganizationRequired": "boolean",
"IsFamilyRequired": "boolean",
"AuditId": "integer",
"PreventEditMessage": "string",
"IsUsedInSync": "boolean",
"Name": "string",
"MembershipInheritanceTypeId": "string",
"DurationMonths": "string",
"OwnerType": "string",
"CategoryTypeId": "string",
"CategoryItemId": "string",
"IsActive": "boolean",
"ShowRenewalPricing": "boolean",
"RenewalPriceCalculationTypeId": "string",
"MembershipEndTypeId": "string",
"OldMembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"GracePeriodDays": "integer",
"RenewalNoticeDays": "string",
"FixedAnnualRenewalMonth": "string",
"StartMembershipDate": "string",
"MembershipExpirationDate": "string",
"ChapterSelection": "string",
"IncludeTopLevelSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"NewMembersProjectTemplateId": "string",
"RenewMembersProjectTemplateId": "string",
"GroupIds": "string",
"GroupSubscriptions": "string",
"Description": "string",
"ActivationsBeforeUpgrading": "string",
"UpgradeMembershipTypeId": "string",
"HasEffectivePrice": "boolean",
"IsFamilyDisabled": "boolean"
}
AddEditMembershipLevelsModel: object
- MembershipTypeId: integer
- FormulaBasedPricing: boolean
- ProratePartialYears: boolean
- FixedAnnualRenewalMonth: string
- PricingTypeId: string
- RenewalPriceCalculationTypeId: string
- CanHaveEffectivePrice: boolean
- EffectiveDate: string
- EffectiveDateText: string
- Name: string
- DurationMonths: integer
- BillSchedulePricingJson: string
- BaseFees: string
- PriceOptionsJson: string
- RoundToNearestOnes: boolean
- PaymentOptions: string
- LevelSelectionCustomFieldId: string
- BaseFeesDescription: string
- IsUsedInSync: boolean
- HasBenefitTrackingModule: boolean
- Levels: string
Example
{
"MembershipTypeId": "integer",
"FormulaBasedPricing": "boolean",
"ProratePartialYears": "boolean",
"FixedAnnualRenewalMonth": "string",
"PricingTypeId": "string",
"RenewalPriceCalculationTypeId": "string",
"CanHaveEffectivePrice": "boolean",
"EffectiveDate": "string",
"EffectiveDateText": "string",
"Name": "string",
"DurationMonths": "integer",
"BillSchedulePricingJson": "string",
"BaseFees": "string",
"PriceOptionsJson": "string",
"RoundToNearestOnes": "boolean",
"PaymentOptions": "string",
"LevelSelectionCustomFieldId": "string",
"BaseFeesDescription": "string",
"IsUsedInSync": "boolean",
"HasBenefitTrackingModule": "boolean",
"Levels": "string"
}
AddEditMembershipFieldsModel: object
- MembershipTypeId: integer
- Name: string
- ObjectTypeId: string
- SearchObjectTypeId: string
- MembershipTypeFields: string
- MembershipAppFields: string
- Fields: string
- FieldOptionsJson: string
Example
{
"MembershipTypeId": "integer",
"Name": "string",
"ObjectTypeId": "string",
"SearchObjectTypeId": "string",
"MembershipTypeFields": "string",
"MembershipAppFields": "string",
"Fields": "string",
"FieldOptionsJson": "string"
}
AddEditMembershipLevelSaleableItemsModel: object
- MembershipLevelId: integer
- MembershipTypeId: integer
- FormulaBasedPricing: boolean
- ProratePartialYears: boolean
- Name: string
- Description: string
- MinUnits: string
- MaxUnits: string
- DurationMonths: integer
- EffectiveDateText: string
- RenewalPriceCalculationTypeId: string
- CanHaveEffectivePrice: boolean
- PricingTypeId: string
- FeesList: string
- SetupFeesList: string
- RoundToNearestOnes: boolean
- PaymentOptions: string
- FixedAnnualRenewalMonth: string
Example
{
"MembershipLevelId": "integer",
"MembershipTypeId": "integer",
"FormulaBasedPricing": "boolean",
"ProratePartialYears": "boolean",
"Name": "string",
"Description": "string",
"MinUnits": "string",
"MaxUnits": "string",
"DurationMonths": "integer",
"EffectiveDateText": "string",
"RenewalPriceCalculationTypeId": "string",
"CanHaveEffectivePrice": "boolean",
"PricingTypeId": "string",
"FeesList": "string",
"SetupFeesList": "string",
"RoundToNearestOnes": "boolean",
"PaymentOptions": "string",
"FixedAnnualRenewalMonth": "string"
}
AddEditMembershipTypeBenefitsModel: object
- MembershipTypeId: integer
- Name: string
- Directories: string
- DisplayDirectoryCategories: boolean
- CategoryLists: string
- AuditInfo: string
Example
{
"MembershipTypeId": "integer",
"Name": "string",
"Directories": "string",
"DisplayDirectoryCategories": "boolean",
"CategoryLists": "string",
"AuditInfo": "string"
}
AddEditMembershipRenewalModel: object
- MembershipTypeId: integer
- Name: string
- MembershipEndTypeId: string
- MembershipRenewalTypeId: string
- GracePeriodDays: integer
- RenewalNoticeDays: string
- ActiveWhenPaid: boolean
- FixedAnnualRenewalMonth: string
- ProratePartialYears: boolean
- ActivationsBeforeUpgrading: string
- UpgradeMembershipTypeId: string
Example
{
"MembershipTypeId": "integer",
"Name": "string",
"MembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"GracePeriodDays": "integer",
"RenewalNoticeDays": "string",
"ActiveWhenPaid": "boolean",
"FixedAnnualRenewalMonth": "string",
"ProratePartialYears": "boolean",
"ActivationsBeforeUpgrading": "string",
"UpgradeMembershipTypeId": "string"
}
AddEditMembershipBillingModel: object
- IsRealtorEdition: boolean
- MembershipTypeId: integer
- Name: string
- HasLevelPricing: boolean
- HasFees: boolean
- HasChapterPricing: boolean
- DefaultFrequencyTypeOption: string
- LevelSelectionCustomFieldId: string
- IncludeTopLevelSelection: boolean
- ChapterSelectionTypeId: string
- HasChapterSelection: boolean
- RequireTopLevelMembership: boolean
- DurationMonths: string
- MembershipEndTypeId: string
- MembershipRenewalTypeId: string
- DefaultGatewayTypeId: string
- GatewayTypeId: string
- SelectedGatewayAllowStoredProfiles: boolean
- PaymentGatewayId: string
- DocumentationGenerationTemplateId: string
- TermId: string
- TermsOfUseId: string
- PricingTypeId: string
- FormulaBasedPricing: boolean
- ShouldMarkNewInvoiceIsRestricted: boolean
- ProratePartialYears: boolean
- PlusNextBillCycle: boolean
- MaxAllowableTermsToPurchase: string
- ChangeEffectivePrice: boolean
- EffectiveDate: string
- Tommorow: string
- CanHaveEffectivePrice: boolean
- EffectiveDateText: string
- FeesList: string
- OneTimeOptionsParagraph: string
- AllowBillMe: boolean
- AllowOnlinePayment: boolean
- SetupFeesList: string
- PriceOptionsJson: string
- Discounts: string
- RoundToNearestOnes: boolean
- PaymentOptions: string
- BillSchedulePricingJson: string
- MultiTermDiscounts: string
- FixedAnnualRenewalMonth: string
- RenewalPriceCalculationTypeId: string
Example
{
"IsRealtorEdition": "boolean",
"MembershipTypeId": "integer",
"Name": "string",
"HasLevelPricing": "boolean",
"HasFees": "boolean",
"HasChapterPricing": "boolean",
"DefaultFrequencyTypeOption": "string",
"LevelSelectionCustomFieldId": "string",
"IncludeTopLevelSelection": "boolean",
"ChapterSelectionTypeId": "string",
"HasChapterSelection": "boolean",
"RequireTopLevelMembership": "boolean",
"DurationMonths": "string",
"MembershipEndTypeId": "string",
"MembershipRenewalTypeId": "string",
"DefaultGatewayTypeId": "string",
"GatewayTypeId": "string",
"SelectedGatewayAllowStoredProfiles": "boolean",
"PaymentGatewayId": "string",
"DocumentationGenerationTemplateId": "string",
"TermId": "string",
"TermsOfUseId": "string",
"PricingTypeId": "string",
"FormulaBasedPricing": "boolean",
"ShouldMarkNewInvoiceIsRestricted": "boolean",
"ProratePartialYears": "boolean",
"PlusNextBillCycle": "boolean",
"MaxAllowableTermsToPurchase": "string",
"ChangeEffectivePrice": "boolean",
"EffectiveDate": "string",
"Tommorow": "string",
"CanHaveEffectivePrice": "boolean",
"EffectiveDateText": "string",
"FeesList": "string",
"OneTimeOptionsParagraph": "string",
"AllowBillMe": "boolean",
"AllowOnlinePayment": "boolean",
"SetupFeesList": "string",
"PriceOptionsJson": "string",
"Discounts": "string",
"RoundToNearestOnes": "boolean",
"PaymentOptions": "string",
"BillSchedulePricingJson": "string",
"MultiTermDiscounts": "string",
"FixedAnnualRenewalMonth": "string",
"RenewalPriceCalculationTypeId": "string"
}
AddEditMembershipChaptersModel: object
- MembershipTypeId: integer
- Name: string
- IncludeTopLevelSelection: boolean
- DefaultChaptersFees: string
- ChaptersFees: string
Example
{
"MembershipTypeId": "integer",
"Name": "string",
"IncludeTopLevelSelection": "boolean",
"DefaultChaptersFees": "string",
"ChaptersFees": "string"
}
AddEditMembershipChapterSaleableItemsModel: object
- MembershipTypeId: integer
- Name: string
- ChapterId: integer
- DurationMonths: integer
- HasVariableDues: boolean
- Note: string
- BillFrequencyTypeId: string
- FeesList: string
- SetupFeesList: string
Example
{
"MembershipTypeId": "integer",
"Name": "string",
"ChapterId": "integer",
"DurationMonths": "integer",
"HasVariableDues": "boolean",
"Note": "string",
"BillFrequencyTypeId": "string",
"FeesList": "string",
"SetupFeesList": "string"
}
MembershipTypeToLevelConversionModel: object
- TypesToConvert: string
Example
{
"TypesToConvert": "string"
}
TestCustomFormulaViewModel: object
- MembershipTypeId: integer
- PriceFormulaEnabled: boolean
- Fields: string
- Instructions: string
- CustomFormulaScript: string
- TestScript: string
- Results: string
Example
{
"MembershipTypeId": "integer",
"PriceFormulaEnabled": "boolean",
"Fields": "string",
"Instructions": "string",
"CustomFormulaScript": "string",
"TestScript": "string",
"Results": "string"
}
OrgTypeAheadItem: object
- Name: string
- AccountNumber: string
- OrganizationContactId: integer
- AuditId: integer
- AdditionalData: string
-
For email line below name
- DestinationContactId: integer
-
For contact merging
- Id: integer
-
For duplicate detection
- Title: string
- StateProvince: string
- City: string
- Address1: string
- Address2: string
- Website: string
- TypeAheadData: string
- TypeAheadItemDisplay: string
- TypeAheadItemTitle: string
Example
{
"Name": "string",
"AccountNumber": "string",
"OrganizationContactId": "integer",
"AuditId": "integer",
"AdditionalData": "string",
"DestinationContactId": "integer",
"Id": "integer",
"Title": "string",
"StateProvince": "string",
"City": "string",
"Address1": "string",
"Address2": "string",
"Website": "string",
"TypeAheadData": "string",
"TypeAheadItemDisplay": "string",
"TypeAheadItemTitle": "string"
}
BulkEditMembershipItem: object
- MembershipActivationId: integer
- MembershipId: integer
- LoadedMembershipExpirationDate: string
- MembershipExpirationChanged: boolean
- MembershipExpirationDate: string
- GraceExpirationDate: string
- MembershipBalance: string
- MembershipActivationExpirationDate: string
- OwnerContactName: string
- MembershipName: string
- MembershipNumber: string
- ContactId: integer
- OwnerAccountNumber: string
- MembershipStartDate: string
- MembershipStartDateString: string
- MembershipStatusTypeId: string
- MembershipStatusTypeString: string
- NextBillDate: string
- NextBillDateString: string
- PurchaseId: string
- LastInvoiceNumber: string
- BlankLastInvoiceNumber: string
- LastInvoiceDueDate: string
- LastInvoiceDueDateString: string
- LastInvoiceBalance: string
- ContactBalance: number
- ScheduledBillings: string
- Modified: boolean
- AggregatedMembershipEndTypeId: string
- GracePeriodDays: integer
- DisableDateEditing: boolean
- FixedAnnualRenewalMonth: string
Example
{
"MembershipActivationId": "integer",
"MembershipId": "integer",
"LoadedMembershipExpirationDate": "string",
"MembershipExpirationChanged": "boolean",
"MembershipExpirationDate": "string",
"GraceExpirationDate": "string",
"MembershipBalance": "string",
"MembershipActivationExpirationDate": "string",
"OwnerContactName": "string",
"MembershipName": "string",
"MembershipNumber": "string",
"ContactId": "integer",
"OwnerAccountNumber": "string",
"MembershipStartDate": "string",
"MembershipStartDateString": "string",
"MembershipStatusTypeId": "string",
"MembershipStatusTypeString": "string",
"NextBillDate": "string",
"NextBillDateString": "string",
"PurchaseId": "string",
"LastInvoiceNumber": "string",
"BlankLastInvoiceNumber": "string",
"LastInvoiceDueDate": "string",
"LastInvoiceDueDateString": "string",
"LastInvoiceBalance": "string",
"ContactBalance": "number",
"ScheduledBillings": "string",
"Modified": "boolean",
"AggregatedMembershipEndTypeId": "string",
"GracePeriodDays": "integer",
"DisableDateEditing": "boolean",
"FixedAnnualRenewalMonth": "string"
}
ListViewReturnModel<SubmittedApplicationCollectionItemModel>: 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"
}
MembershipSubmittedApplicationAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- Criteria: string
- ShowPending: boolean
- ShowApproved: boolean
- ShowAll: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"Criteria": "string",
"ShowPending": "boolean",
"ShowApproved": "boolean",
"ShowAll": "boolean"
}
ListViewReturnModel<MembershipUnpaidListViewModel, TenantEditionViewModel>: 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"
}
MembershipUnpaidAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- PastDue: string
- MembershipTypes: string
- MembershipLevelId: string
- MembershipStatus: string
- Tags: string
- IsExpired: boolean
- InvoiceDate: string
- MembershipId: string
- PurchaseId: string
- Criteria: string
- InvoiceAmountGreater: string
- InvoiceAmountLess: string
- DropAllMembershipsForOwners: boolean
- IsSaving: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"PastDue": "string",
"MembershipTypes": "string",
"MembershipLevelId": "string",
"MembershipStatus": "string",
"Tags": "string",
"IsExpired": "boolean",
"InvoiceDate": "string",
"MembershipId": "string",
"PurchaseId": "string",
"Criteria": "string",
"InvoiceAmountGreater": "string",
"InvoiceAmountLess": "string",
"DropAllMembershipsForOwners": "boolean",
"IsSaving": "boolean"
}
MembershipBaseModel: object
- SubmittedAppsCount: integer
- ShowBenefitsTab: boolean
- ShowBatchTracking: boolean
- ShowRenewalsTab: boolean
- Actions: string
Example
{
"SubmittedAppsCount": "integer",
"ShowBenefitsTab": "boolean",
"ShowBatchTracking": "boolean",
"ShowRenewalsTab": "boolean",
"Actions": "string"
}
SubmittedApplicationReviewModel: object
- MembershipId: integer
- AuditId: integer
- MembershipHash: string
- ViewApplication: string
- Name: string
- OrganizationName: string
- Email: string
- MembershipOwnerName: string
- HideOrgName: boolean
- NotEnoughOrganizationData: boolean
- ReferredByContactId: string
- OrganizationContactId: string
- OriginOrganizationContactId: string
- IndivIsNotMatched: boolean
- OrgIsNotMatched: boolean
- ContactMatchType: string
- PotentialMatches: string
- Contact: string
- OrganizationMatchType: string
- PotentialOrganizations: string
- Organization: string
- Invoices: string
- NarWarningMessage: string
- CapturePaymentProfileAndChargeOnApproval: boolean
- PaymentOption: string
Example
{
"MembershipId": "integer",
"AuditId": "integer",
"MembershipHash": "string",
"ViewApplication": "string",
"Name": "string",
"OrganizationName": "string",
"Email": "string",
"MembershipOwnerName": "string",
"HideOrgName": "boolean",
"NotEnoughOrganizationData": "boolean",
"ReferredByContactId": "string",
"OrganizationContactId": "string",
"OriginOrganizationContactId": "string",
"IndivIsNotMatched": "boolean",
"OrgIsNotMatched": "boolean",
"ContactMatchType": "string",
"PotentialMatches": "string",
"Contact": "string",
"OrganizationMatchType": "string",
"PotentialOrganizations": "string",
"Organization": "string",
"Invoices": "string",
"NarWarningMessage": "string",
"CapturePaymentProfileAndChargeOnApproval": "boolean",
"PaymentOption": "string"
}
BulkEditExpirationDatesModel: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- forceSave: boolean
- HelpParagraph: string
- MembershipTypes: string
- MembershipTypeIds: string
- MembershipStatus: string
- XDays: integer
- GraceXDays: string
- SetDatesEndOfMonth: boolean
- LoadButton: string
- Items: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"HelpParagraph": "string",
"MembershipTypes": "string",
"MembershipTypeIds": "string",
"MembershipStatus": "string",
"XDays": "integer",
"GraceXDays": "string",
"SetDatesEndOfMonth": "boolean",
"LoadButton": "string",
"Items": "string"
}
MembershipTypeDiscountItemBase: object
- Id: integer
- DiscountId: integer
- Name: string
- PromoCode: string
- StartDate: string
- EndDate: string
Example
{
"Id": "integer",
"DiscountId": "integer",
"Name": "string",
"PromoCode": "string",
"StartDate": "string",
"EndDate": "string"
}
MembershipPromoDiscountAddEditModel: object
- MembershipTypeDiscountId: integer
- MembershipDiscountAuditId: integer
- DiscountId: integer
- DiscountAuditId: integer
- MembershipTypeId: string
- Name: string
- StartDate: string
- EndDate: string
- PromoCode: string
- DiscountTypeId: integer
- SystemDiscountTypeId: string
- Pricing: string
Example
{
"MembershipTypeDiscountId": "integer",
"MembershipDiscountAuditId": "integer",
"DiscountId": "integer",
"DiscountAuditId": "integer",
"MembershipTypeId": "string",
"Name": "string",
"StartDate": "string",
"EndDate": "string",
"PromoCode": "string",
"DiscountTypeId": "integer",
"SystemDiscountTypeId": "string",
"Pricing": "string"
}
NewMembersResponseModel: object
- Name: string
- MembershipType: string
- MemberWebsite: string
- DirectoryUrl: string
- JoinDate: string
- PrimaryContactName: string
Example
{
"Name": "string",
"MembershipType": "string",
"MemberWebsite": "string",
"DirectoryUrl": "string",
"JoinDate": "string",
"PrimaryContactName": "string"
}
ReviewNextBillDatesModel: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- forceSave: boolean
- CurrentDate: string
- RollBack: boolean
- HelpParagraph: string
- ContactStatus: string
- MembershipTypeId: string
- NextBillDateRange: string
- DisableDateEditing: boolean
- LoadButton: string
- Items: string
- Count: integer
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"forceSave": "boolean",
"CurrentDate": "string",
"RollBack": "boolean",
"HelpParagraph": "string",
"ContactStatus": "string",
"MembershipTypeId": "string",
"NextBillDateRange": "string",
"DisableDateEditing": "boolean",
"LoadButton": "string",
"Items": "string",
"Count": "integer"
}
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"
}
AddEditBenefitItemModel: object
- BenefitItemId: integer
- TenantId: integer
- Name: string
- Description: string
- BenefitAreaId: string
- Amount: string
- DiscountId: string
- CategoryItems: string
- BenefitUsageSharingTypeId: string
- IsActive: boolean
- forceSave: boolean
Example
{
"BenefitItemId": "integer",
"TenantId": "integer",
"Name": "string",
"Description": "string",
"BenefitAreaId": "string",
"Amount": "string",
"DiscountId": "string",
"CategoryItems": "string",
"BenefitUsageSharingTypeId": "string",
"IsActive": "boolean",
"forceSave": "boolean"
}
MembershipTypeAddEditBenefitPackagesModel: object
- MembershipTypeId: integer
- MembershipLevelId: string
- DisplayName: string
- BenefitPackages: string
Example
{
"MembershipTypeId": "integer",
"MembershipLevelId": "string",
"DisplayName": "string",
"BenefitPackages": "string"
}
ListViewReturnModel<MembershipScheduledBillingUpdateItems>: 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"
}
MembershipScheduledBillingUpdateItemsAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- MembershipTypeId: string
- MembershipLevelId: string
- StatusTypeOptions: string
- DateRange: string
- NextBillDate: string
- Criteria: string
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"MembershipTypeId": "string",
"MembershipLevelId": "string",
"StatusTypeOptions": "string",
"DateRange": "string",
"NextBillDate": "string",
"Criteria": "string"
}
MembershipScheduledBillingUpdateHistoryModel: object
- HistoryItems: string
Example
{
"HistoryItems": "string"
}
ReactivateRealEstateOfficeEmployeeMembershipsModel: object
- ContactId: integer
- Message: string
- OfficesCount: integer
- TotalAgentsCount: integer
Example
{
"ContactId": "integer",
"Message": "string",
"OfficesCount": "integer",
"TotalAgentsCount": "integer"
}
ListViewReturnModel<BrokerListViewModel>: 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"
}
BrokerAdvancedFilter: object
- Top: string
- Take: string
- Skip: string
- Filter: string
- OrderBy: string
- CalendarStartDate: string
- CalendarEndDate: string
- TenantId: integer
- BrokerContactId: string
- BrokerOfficeContactId: string
- MembershipTypes: string
- MembershipLevelId: string
- MembershipStatus: string
- Tags: string
- InvoiceDate: string
- OpenBalance: boolean
- Criteria: string
- HasOpenInvoices: boolean
Example
{
"Top": "string",
"Take": "string",
"Skip": "string",
"Filter": "string",
"OrderBy": "string",
"CalendarStartDate": "string",
"CalendarEndDate": "string",
"TenantId": "integer",
"BrokerContactId": "string",
"BrokerOfficeContactId": "string",
"MembershipTypes": "string",
"MembershipLevelId": "string",
"MembershipStatus": "string",
"Tags": "string",
"InvoiceDate": "string",
"OpenBalance": "boolean",
"Criteria": "string",
"HasOpenInvoices": "boolean"
}