📄️ Get Customer Profile Header Information
Retrieves the profile header information for a specific customer.
📄️ Get Services for a Customer
Retrieves a list of services for a given customer.
📄️ Get Service Details
Retrieves service details for a given service and customer. Only includes products for now.
📄️ Get Services and Contracts for a Customer
Retrieves a combined list of services and contracts for a given customer, including recurring contracts (agreements) and services not associated with a recurring contract.
📄️ Get Customer Services Dropdown List
Retrieves a lightweight list of services for a customer, formatted for dropdown/selection UI components.
📄️ Get Customer Services Advanced Dropdown List
Retrieves services for a customer with the extra detail fields.
📄️ Get a list of customers names
Retrieves a list of customers names
📄️ Search Customers
Searches customers by name, identifier, and account number.
📄️ Get Customer Service Summary
Retrieves a paged list of customers with aggregate service counts (total and pending).
📄️ Check Duplicate Customers
Checks for potential duplicate customers based on name, company, and address fields.
📄️ List Customer Addresses
Retrieves a paged list of addresses for a given customer, including primary designation.
📄️ Create Customer Address
Creates a new address associated with a customer.
📄️ Get Customer Address
Retrieves a single address for a customer by address ID.
📄️ Update Customer Address
Updates an existing address for a customer.
📄️ Delete Customer Address
Deletes an address from a customer. Cannot delete the primary address for any address type.
📄️ Get the parent account for a customer
Retrieves the parent account information for the specified customer
📄️ Get child accounts for a customer
Retrieves a paged list of child accounts for the specified customer
📄️ Get sibling accounts for a customer
Retrieves a paged list of sibling accounts for the specified customer
📄️ Get a list of eligible accounts that can be a parent account
Retrieves a list of standard and parent accounts
📄️ Get the current hierarchy status of a customer
Retrieves information about the current account type and its migration options for the specified customer
📄️ Get related accounts for a customer
Retrieves a paged list of non-hierarchical related accounts linked to the specified customer. Returns relationships where the customer appears on either side.
📄️ Create Related Account
Creates a non-hierarchical relationship between two customers. The relationship is bidirectional — it will be returned when fetching related accounts for either customer.
📄️ Get Documents for a Customer
Retrieves a list of documents (file attachments) for a given customer.
📄️ Make Address Primary
Designates an address as the primary address for its address type on a customer.
📄️ Delete Related Account
Removes a non-hierarchical relationship between two customers. The relationshipId must reference a relationship that includes the specified customer on one side.
📄️ Create Customer
Creates a new customer with the specified details.
📄️ Get Pending Services
Returns services that have at least one PENDING product, for a customer and its direct child accounts.
📄️ Activate Pending Services
Activates PENDING products for the customer or its direct child accounts. If ServiceIds is omitted or empty, activates all pending services.
📄️ Get Unposted Transactions
Retrieves unposted transactions for a specific customer.
📄️ Get Unbilled Agreement Usage Summary
Returns the prospective labor and materials transactions, plus pre-tax summary amounts, that would be added by agreement usage billing. The endpoint does not create transactions or mark ledger rows as billed.
📄️ Get Customer Ledger
Retrieves a ledger of transactions for a specific customer.
📄️ Get invoices with unpaid balances for a customer
Returns a list of invoices that have remaining unpaid balances for the customer.
📄️ Get transactions with unpaid balances for a customer
Returns the charges with remaining balance details for the customer and its direct child accounts.
📄️ Get Customer Billing Overview
Retrieves the basic customer billing information for use in the overview tab.
📄️ Get Customer Balances
Retrieves the balance information for a customer including balance, due amounts, and cycle information.
📄️ Get Customer Aging
Retrieves the aging breakdown for a customer showing amounts in each aging bucket (Current, 0-30, 31-60, 61-90, 91-120, 121+ days).
📄️ Get Adjustments for a Customer
Retrieves a list of adjustments for a given customer.
📄️ Get autopay for a customer
Returns automatic payment details for the customer.
📄️ Update autopay for a customer
Sets automatic payment details for a customer.
📄️ Get billing automation opt-out for a customer
Returns which billing automation steps the customer is opted out of.
📄️ Update billing automation opt-out for a customer
Sets which billing automation steps the customer is opted out of. Idempotent set-replace per action.
📄️ Get bill message overrides for a customer
Returns the customer's special, ACH and CC bill message overrides. A null slot inherits the bill profile's message on invoices.
📄️ Update bill message overrides for a customer
Replaces the customer's special, ACH and CC bill message overrides. A missing or blank message clears that slot so the bill profile's message applies.
📄️ Get tax exemptions for a customer
Returns tax exemption details for the customer based on their tax service provider.
📄️ Update tax exemptions for a customer that uses ceretax as a provider
Updates tax exemption details for a ceretax customer.
📄️ Update tax exemptions for a customer that uses suretax as a provider
Updates tax exemption details for a suretax customer.
📄️ Update tax exemptions for a customer that uses csi as a provider
Updates tax exemption details for a csi customer.
📄️ Update tax exemptions for a customer that uses billsoft as a provider
Updates tax exemption details for a billsoft customer.
📄️ Rebill Customer
Rolls back a customer's billing and allows recurring charges to be regenerated.
📄️ Queue invoice for PDF generation
Marks invoice for pickup by the Windows Service for background PDF generation.
📄️ Get Customer
Retrieves a customer by its ID.
📄️ Update Customer
Updates the details of an existing customer by its ID.
📄️ Get Customer Types
Retrieves a paged list of available customer types.
📄️ Get Customer Summaries
Retrieves a paged list of customer summaries with optional filtering by customer properties, including tags.
📄️ Get Customer Custom Field Definitions
Retrieves all customer custom field definitions for the customer type.
📄️ Get service information for a customer
Retrieves the default ticket type, SLA policy, and default primary technician configured for a customer.
📄️ Update service information for a customer
Updates the default ticket type, SLA policy, and default primary technician configured for a customer.
📄️ Get customer sentiment analysis
Retrieves AI-generated sentiment analysis for a specific customer.
📄️ Get a specific journal entry
Retrieves a single journal entry by its ID. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a customer's journal summary
Retrieves a summary of journal entries for a specific customer. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a journal entry
Retrieves a journal entry with optional filtering. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a list of journal entries
Retrieves a paginated list of journal entries with optional filtering. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a customer's addresses
Retrieves all addresses for the specified customer.
📄️ Get a journal action
Retrieves a journal action with optional active status filter. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get all journal actions
Retrieves a list of all journal actions with optional active status filter. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a journal topic
Retrieves a journal topic with optional active status filter. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get all journal topics
Retrieves a list of all journal topics with optional active status filter. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a specific journal entry
Retrieves a single journal entry by its ID. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a specific journal action
Retrieves a single journal action by its ID. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a specific journal action
Retrieves a single journal action by its ID. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a specific journal topic
Retrieves a single journal topic by its ID. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.
📄️ Get a specific journal topic
Retrieves a single journal topic by its ID. Read-only. Journals are being replaced by Notes: existing journal data stays available here for reference and will be migrated to Notes in a future release. Journal create, update, and delete are no longer exposed.