ZPartner Store CRM Modules

ZPartner Store CRM Modules

Partner Subscriptions

Subscriptions represent an single customer and group of licenses for a single product.

FieldData TypeStore API FieldDescription
NameSingle LineidUnique subscription id
TypePick Listsubscription_typepartner_price or list_price
Subscription IDSingle Linesubscription_idUnique subscription id (same as ID, at least in US)
Subscription StartDatesubscription_start_dateThe original start date of the subscription (not updated on renewal)
Subscription EndDate(next_recurring_date - 1)The day before the subscription renewal is due
StatusPick Liststatusactive or inactive
EmailEmailemail_idEmail address of the customer
AccountLookup N/A
Account Related to Subscription
Company NameSingle Linecustomer_company_nameName of Company
Billing FrequencyPick Listbilling_frequencymonthly, quarterly, half_yearly, or yearly
Next Recurring AmountCurrencynext_recurring_amountHow much the customer will owe when they renew in customer currency
Next Recurring DateDatenext_recurring_dateNext renewal date for the subscription
Next Recurring USDDecimalnext_recurring_amount_usdNext renewal date for the subscription (in USD)
Org IDSingle Lineorg_idUnique ID of the customers Zoho Organization
PayloadMulti Line (Small){All}Full JSON payload of the subscription from the API. Get Add-Ons from here
Plan IDSingle Line
plan_idID of the plan assigned to the Subscription
Plan NameSingle Lineplan_nameName of the plan assigned to the Subscription
Pricing TypePick Listpricing_type list_price or partner_price
Profile IDSingle Lineprofile_id Unique identifier of the Zoho profile tied to the subscription
Service IDSingle Line
service_idUnique identifier of the service related to the subscription.
Service NameSingle Lineservice_name Name of the service related to the subscription


Partner Transactions

Transactions represent actions taken against a particular Subscription. A single Subscription can have many transactions against it.

FieldData TypeStore API FieldDescription
NameSingle LineidUnique Transaction ID
TypeSingle Linetransaction_typesignup,reactivate,cancel,upgrade,downgrade,recurring_failure,recurring,card_change,refund, data_sync,one_time_payment,offline_to_online,past_due,skip_month,scheduled_cancel, subscription_resumed, or one_time_charge
Transaction IDSingle Linetransaction_idUnique Transaction ID (same as ID at least in US)
Transaction TimeDateTimetransaction_dateDate the transaction occurred
AmountCurrencyamountAmount the customer paid in their currency
Amount USDDecimalusd_amountAmount the customer paid in USD
Billing FrequencySingle Linebilling_frequencymonthly, quarterly, half_yearly, or yearly
DescriptionSingle LinedescriptionShort description of the transaction
Pricing TypeSingle Linepricing_typepartner_price or list_price
Plan IDNumberplan_id ID of the plan assigned to the Subscription
Plan NameSingle Lineplan_name Name of the plan assigned to the Subscription
Profile IDSingle Lineprofile_id Unique identifier of the Zoho profile tied to the subscription
Service IDSingle Line
service_id Unique identifier of the service related to the subscription.
Service NameSingle Lineservice_name Name of the service related to the subscription
SubscriptionLookup N/A
 Lookup to related Subscription record
Subscription IDSingle Linesubscription_idUnique id of the Subscription
Subscription TypeSingle Linesubscription_typeonline or offline
Subscription PayloadMulti Line (Small){All Subscription}Full JSON payload of the subscription from the API
PayloadMulti Line (Small){All}Full JSON payload of the transaction from the API


Partner Commissions

For eligible Transactions, Commission records represent the status of a specific Transaction and if it has been paid out or not. Every Commissions is related to a single Transaction, but not every Transaction has a Commission record.

FieldData TypeStore API FieldDescription
NameSingle Linecommission_idUnique id for the commission
TypeSingle Linetypecommission or commission_reversal (may be others)
DateDatedateDate the commission was approved/assigned
Commission
Decimal
commission
Total monetary amount for the commission in customer currency
Commission BalanceDecimalbalance_commissionHow much of the commission is yet to be paid out in customer currency
Commission BaseCurrencybase_commission Commission amount in payout currency
Tax Eligible AmountDecimaleligible_txn_amountAmount eligible for taxation (if applicable) in customer currency
Commission PayoutCurrencypayout_commissionHow much of the mission has been paid out in payout currency
EntitySingle Lineentitycommission billing entity (Zoho US, Zoho Singapore, Zoho Netherlands, Zoho Germany, Zoho Mexico, Zoho Australia, Zoho Canada, Zoho India, Zoho Nigeria)
Invoice IDSingle Lineinvoice_id Id of the invoice (won't be automatically be populated)
Payout IDSingle Linepayout_idUnique ID that represents the batch of commissions paid out
StatusSingle Linestatusopen, requested, or closed
SubscriptionLookup N/A
 Lookup to related Subscription record
Subscription IDSingle Linesubscription.idUnique subscription id
Commission IDSingle Linecommission_idUnique id for the commission
TransactionLookup N/A
 Lookup to related Transaction record
Transaction IDSingle Linetransaction.idUnique Transaction ID
PayloadMulti Line (Small){All}Full JSON payload of the commission from the API
Last Processed TimeDateTimenow()The last time the record was processed by the extension

Partner Alerts

This module is specific to the ZPartner extension and represents events that may or may not generate email alerts to the admin id. You can create your own automation off of these records if you want something more advanced. These records are shown under the "Logs" tab in the settings page.

FieldData TypeStore API FieldDescription
Alert TimeDateTimeN/AThe time the alert was generated
TypePick ListN/AInfo, Warning, or Error
MessageSingle LineN/AShort description of what happened. Used as Email Subject.
BodyMulti Line (Small)N/ADescription of what happened, usually body of email
DetailsMulti Line (Large)N/AFull log payload. Usually contains the info necessary for troubleshooting.
Suppress Alert?BooleanN/APrevent an email from being sent as a result of the alert record being created. (default is true)


    • Related Articles

    • ZPartner Extension Initial Setup

      Step 1 - Authorization After installing the ZPartner for CRM Extension from the Zoho Marketplace, open the web tab "ZPartner Settings". You should see a screen similar to the one below. If you have already authorized the Zoho Partner Store connection ...

    • Frequently Asked Questions (FAQ)

      Who is this extension for? This extension is exclusively for Zoho Partners and not for standard Zoho customers. It leverages the Zoho Partner API to pull all the data from https://store.zoho.com into your CRM so you can build reporting and automation ...