For AI agents: visit https://docs.zenskar.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
ZenskarZenskar
DocumentationAPI Reference
Book a DemoZenskar
API Reference
Book a Demo
DocumentationAPI Reference

GETTING STARTED

  • Authentication
  • DateTime format
  • Idempotent requests

zenskar

  • Accounting
    • Get chart of accountsget
    • Create accountpost
    • Get accountsget
    • Create close datepost
    • Get close dateget
    • Update close datepatch
    • Create journal entrypost
    • Update journal entryput
    • Get journal entryget
    • Get account balance by tagget
    • Get journal entriesget
    • Get journal linesget
    • Get balance sheetget
    • Get income statementget
    • Validate period closepost
    • Close accounting periodpost
    • Get accounting periodsget
    • Get last closed periodget
    • Get accounting periodget
  • Billable Metrics
    • List billable metricsget
    • Create billable metricpost
    • Get aggregate estimates for a periodget
    • Get billable metricget
    • Update aggregatepatch
    • Delete aggregatedel
  • Business Entities
    • List business entitiesget
    • Create business entitypost
    • Get business entityget
    • Update business entitypatch
    • Get business entity configget
    • Set business entity configput
    • Get region configget
    • Upsert region configput
    • Delete region configdel
  • Contacts
    • List contactsget
    • Create contactpost
    • Get contactget
    • Update contactpatch
    • Delete contactdel
  • Contracts
    • List contractsget
    • Create contractpost
    • Get contract by IDget
    • Update contractput
    • Delete contractdel
    • Get contract amendmentsget
    • Create contract phasepost
    • Pause contractpost
    • Update pause contractpatch
    • Resume contractpatch
    • Create contract phase pricingpost
    • Expire contractpatch
  • Credit Notes
    • Get credit note listget
    • Create credit notepost
    • Get credit note by IDget
    • Update credit note by IDpatch
    • Get line items by credit note IDget
  • Custom Attributes
    • Create custom attribute definitionpost
    • List custom attribute definitionsget
    • Get custom attribute definitionget
    • Update custom attribute definitionpatch
  • Customers
    • Create customerpost
    • Update customerpatch
    • Delete customerdel
    • Patch Customer Connector Idpatch
    • Delete third-party connectordel
    • Create customer relationshipspost
    • List customers with filtering and paginationget
    • Get customer by IDget
    • Get customer connector detailsget
    • Create customer or guest sessionpost
    • Attach external payment methodpost
    • List payment methodsget
    • Delete payment methoddel
  • Customer Addresses
    • List customer addressesget
    • Create customer addresspost
    • Get customer addressget
    • Update customer addresspatch
    • Delete customer addressdel
  • Data Sources
    • List data-source connectorsget
    • Create data-source connectorpost
    • Get data-source connectorget
    • Update data-source connectorpatch
  • Entitlements
    • List entitlementsget
    • Create entitlementpost
    • Get entitlementget
    • Update entitlementpatch
    • Delete entitlementdel
    • Create entitlement customerpost
    • List entitlements for customerget
    • Get total customer entitlementsget
    • List customer entitlementsget
    • List unique entitlements for customerget
    • Get entitlement customerget
    • Update customer entitlementpatch
    • Delete customer entitlementdel
    • Get Customer Entitlement by IDget
    • List customer entitlement balances with advanced filteringget
  • Invoices
    • List invoicesget
    • Get invoiceget
    • Get invoice by external Idget
    • Approve invoicepatch
    • Get invoice line itemsget
    • Void invoicepatch
    • Create credit note against invoicepost
    • Generate an invoicepost
  • Jobs
    • List jobsget
    • Get job by IDget
    • Get job outcomes by filtersget
    • Get job outcomes by IDget
    • Get job with sub-jobsget
  • Payments
    • Get invoice paymentsget
    • Get payment by IDget
    • Update paymentpatch
    • Delete manual paymentdel
    • Get paymentsget
    • Create paymentpost
    • Create invoice chargepost
    • Edit manual paymentpatch
    • Refund paymentpost
  • Plans
    • List plansget
    • Create planpost
    • Get plan by Idget
    • Update planput
    • Delete plan by Iddel
    • Create plan phasepost
    • Update plan phaseput
    • Delete plan phasedel
    • Create plan phase pricingpost
    • Update plan phase pricingput
    • Delete plan phase pricing by Iddel
    • Create new versionpost
  • Products
    • List productsget
    • Create productpost
    • Get productget
    • Update productpatch
    • Delete productdel
    • Get product pricingsget
    • Create product pricingpost
    • Get product pricingget
    • Update product pricingpatch
    • Delete product pricingdel
    • Get product bundle pricingget
    • Update product bundle pricingpatch
    • Create product bundle pricingpost
  • Tax
    • List tax categoriesget
    • Create tax categorypost
    • Get tax categoryget
    • Update tax categorypatch
    • List jurisdiction ratesget
    • Create jurisdiction ratepost
    • Get jurisdiction rateget
    • Update jurisdiction ratepatch
    • List tax ratesget
    • Get tax rateget
    • Update tax ratepatch
    • Resolve the applicable tax rate for a destinationpost
  • Tags
    • List tagsget
    • Upsert tagspost
  • Usage Events
    • List usage eventsget
    • Create usage eventpost
    • Get usage event by IDget
    • Update usage eventpatch
    • Get usage event by slugget
  • Customer Portal
Powered by 
  1. zenskar

Customer Portal

Updated over 1 year ago


Get usage event by slug
Did this page help you?

Updated over 1 year ago


Get usage event by slug
Did this page help you?