Invoice Desk
    Invoice Desk
    • Getting Started
    • Static Data
      • List currencies
        GET
      • List countries
        GET
      • List states
        GET
      • List cities
        GET
      • StaticDataController_testError
        GET
    • Company
      • List companies
        GET
      • Add Company
        POST
      • Update Company
        PATCH
      • Fetch details of a company by ID
        GET
      • Delete a company
        DELETE
      • Get all payments for a company
        GET
    • Client
      • List clients
        GET
      • Add client
        POST
      • Update a client
        PATCH
      • Remove client
        DELETE
      • Get client details
        GET
    • Invoice
      • List invoices
        GET
      • Create invoice
        POST
      • Get invoice by ID
        GET
      • Update invoice
        PATCH
      • Delete a specific invoice
        DELETE
      • Import invoices
        POST
      • Export invoice
        GET
      • Send invoice
        POST
    • Invoice Payments
      • Record payment for invoice
      • Get payments for invoice
    • Product
      • List products
      • Add product
      • Update a product
      • Remove a product
    • Account
      • Get account details
      • Update account details
    • Project
      • List projects
      • Create a project
      • Get project by ID
      • Update a project
      • Remove a project
    • Company Settings
      • Create a new tax
      • Get company invoice settings
    • Timesheet
      • Get time entries for a project
      • Create a timesheet
      • Update
      • Delete
    • Role
      • List roles
    • User Profile
      • Fetch auth user profile
      • Update user profile

    Client

    The Clients resource represents the customers or businesses you work with under each company. Clients are at the core of your billing workflow—every invoice, project, and timesheet is linked to a client, allowing you to organize your work and get paid faster.
    Each client record belongs to a single company and contains essential details like contact information, billing address, and more. You can manage multiple clients across multiple companies without any data overlap.
    Key Capabilities
    Create, update, and delete client records scoped to a specific company.
    Associate clients with projects, timesheets, and invoices.
    Store important metadata such as tax identification numbers, billing notes, or custom fields.
    For Frontend Developers
    Use the clients API to:
    Populate dropdowns when creating new invoices or assigning projects.
    Display client contact details in dashboards and invoice previews.
    Allow users to search, filter, and manage client lists per company.
    Client forms typically include fields like name, email, phone, billing address, and default currency. All operations should include or infer the current company_id context.
    For Backend Developers
    Clients are a central entity in the domain model. Use client IDs when creating invoices, associating timesheets, or generating client-specific reports. Enforce company_id scoping to ensure data integrity.
    Common tasks:
    Validating client ownership within the active company.
    Creating default clients for new company setups.
    Automating reminders or reports grouped by client activity.
    Modified at 2025-05-14 07:34:40
    Previous
    Get all payments for a company
    Next
    List clients
    Built with