Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

A customer in Zenskar represents the business or individual entity that you bill. Every contract, invoice, and payment in Zenskar is tied to a customer record.

Data model

A customer sits at the top of Zenskar’s billing hierarchy. Once created, it connects to all downstream billing objects.

Key fields

FieldDescription
NameThe customer’s display name, used on invoices and in the portal.
External IDThe ID assigned to this customer in your CRM or source system. Used to match records during sync and API calls.
EmailPrimary contact email for invoice delivery and communication.
Business entityYour legal entity (set up under Settings) that issues invoices to this customer. Cannot be changed after creation.
Billing addressUsed for tax calculation and invoice generation. Must match the details in any connected external system.
Tax informationGST/VAT IDs for applicable jurisdictions. Determines how tax is applied on invoices.
Custom dataArbitrary JSON metadata. Can be referenced in custom aggregate queries for usage-based billing.

Relationships

  • Contracts define the pricing terms and billing schedule for a customer.
  • Invoices are generated against a customer based on their active contract.
  • Payments are recorded against invoices and tracked at the customer level.
  • Wallet holds credits from manual top-ups or unrefunded credit note balances, applied against invoice amounts.
  • Secondary contacts receive specific email communications (e.g. invoice copies) separate from the primary contact.
  • Entitlements track feature or usage limits granted to a customer.

Add a customer

Create customers manually, by CSV upload, via API, or through a connector.

Manage contacts

Add secondary contacts and control what communications each contact receives.

Customer wallet

Issue promotional credits and adjust a customer’s wallet balance.

Customer-facing portal

Let customers view invoices, payments, and entitlements self-serve.

API reference

Create and manage customers programmatically via the Zenskar API.