Customers
A customer object allows you to keep track of all customer related information.
Attribute
attention
,street
, city
, state
,zip
,country
, state_code
and fax
.attention
,street
, city
, state
,zip
,country
, state_code
and fax
.Allowed values for
gst_treatment
: business_gst
, business_none
, consumer
, overseas
business_gst
- For a GST Registered business owner. business_none
- For a GST unregistered business owner. consumer
- For a consumer. overseas
- Customer for whom you export your goods/services.home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
home_country_mexico
(A business that is located within MX)border_region_mexico
(A business that is located in the northern and southern border regions in MX)non_mexico
(A business that is located outside MX).general_legal_person
, legal_entities_non_profit
, resident_abroad
, production_cooperative_societies
, agricultural_livestock
, optional_group_of_companies
, coordinated
, simplified_trust
, wages_salaries_income
, lease
, property_disposal_acquisition
, other_income
, resident_abroad
, divident_income
, individual_business_professional
, interest_income
, income_obtaining_price
, no_tax_obligation
, tax_incorporation
, income_through_technology_platform
, simplified_trust
.active
or inactive
.Create a customer
A new customer can a be created separately as well as at the time of creation of a new subscription.
OAuth Scope : ZohoSubscriptions.customers.CREATE
Arguments
attention
,street
, city
, state
,zip
,country
, state_code
and fax
.attention
,street
, city
, state
,zip
,country
, state_code
and fax
.Allowed values for
gst_treatment
: business_gst
, business_none
, consumer
, overseas
business_gst
- For a GST Registered business owner. business_none
- For a GST unregistered business owner. consumer
- For a consumer. overseas
- Customer for whom you export your goods/services.uk
(A business that is located in the UK.),eu_vat_registered
(A business that is reg for VAT and trade goods between Northern Ireland and EU. This node is available only for organizations enabled for NI protocal in VAT Settings.) andoverseas
(A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
home_country_mexico
(A business that is located within MX)border_region_mexico
(A business that is located in the northern and southern border regions in MX)non_mexico
(A business that is located outside MX).general_legal_person
, legal_entities_non_profit
, resident_abroad
, production_cooperative_societies
, agricultural_livestock
, optional_group_of_companies
, coordinated
, simplified_trust
, wages_salaries_income
, lease
, property_disposal_acquisition
, other_income
, resident_abroad
, divident_income
, individual_business_professional
, interest_income
, income_obtaining_price
, no_tax_obligation
, tax_incorporation
, income_through_technology_platform
, simplified_trust
.is_taxable
is true
.List all customers
List of all customers. You can list customers based on various filter criterias. The allowed values for filter_by
are Status.(All
, Active
, Inactive
, Gapps
, Crm
, NonSubscribers
, PortalEnabled
, PortalDisabled
).
OAuth Scope : ZohoSubscriptions.customers.READ
Update a customer
Update details of an existing customer.
OAuth Scope : ZohoSubscriptions.customers.UPDATE
Arguments
attention
,street
, city
, state
,zip
,country
, state_code
and fax
.attention
,street
, city
, state
,zip
,country
, state_code
and fax
.Allowed values for
gst_treatment
: business_gst
, business_none
, consumer
, overseas
business_gst
- For a GST Registered business owner. business_none
- For a GST unregistered business owner. consumer
- For a consumer. overseas
- Customer for whom you export your goods/services.uk
(A business that is located in the UK.),eu_vat_registered
(A business that is reg for VAT and trade goods between Northern Ireland and EU. This node is available only for organizations enabled for NI protocal in VAT Settings.) andoverseas
(A business that is located outside UK. Pre Brexit, this was split as eu_vat_registered
, eu_vat_not_registered
and non_eu
).is_taxable
is true
.home_country_mexico
, border_region_mexico
, non_mexico
.Consumers generic RFC:
XAXX010101000
, Overseas generic RFC: XEXX010101000
home_country_mexico
(A business that is located within MX)border_region_mexico
(A business that is located in the northern and southern border regions in MX)non_mexico
(A business that is located outside MX).general_legal_person
, legal_entities_non_profit
, resident_abroad
, production_cooperative_societies
, agricultural_livestock
, optional_group_of_companies
, coordinated
, simplified_trust
, wages_salaries_income
, lease
, property_disposal_acquisition
, other_income
, resident_abroad
, divident_income
, individual_business_professional
, interest_income
, income_obtaining_price
, no_tax_obligation
, tax_incorporation
, income_through_technology_platform
, simplified_trust
.Retrieve a customer
Details of an existing customer.
OAuth Scope : ZohoSubscriptions.customers.READ
Delete a customer
Delete an existing customer.
OAuth Scope : ZohoSubscriptions.customers.DELETE
Retrieve a customer Using CRM Reference
Details of an existing customer using CRM Reference ID. reference_id can be CRM Contact ID
(for Contacts only sync) or CRM Account ID
(For accounts only and Accounts and its contacts sync). Query param value of reference_id_type
must be given accoridngly.
OAuth Scope : ZohoSubscriptions.customers.READ
Query Parameters
zcrm_account_id
and zcrm_contact_id
.List of transactions
List of all transactions associated with a particular customer.
OAuth Scope : ZohoSubscriptions.customers.READ
Query Parameters
filter_by
. The allowed values for filter_by are TransactionType.(All
, INVOICE
, PAYMENT
, CREDIT
, REFUND
)customer_id
.Mark as active
Change status of the customer to active.
OAuth Scope : ZohoSubscriptions.customers.CREATE
Mark as inactive
Change status of the customer to inactive. A cutomer can be marked as inactive only if there is no active subscription associated with the customer.
OAuth Scope : ZohoSubscriptions.customers.CREATE