NQD developers
Introduction
  • Introduction
  • Pagination and filtering
  • Errors
  • Limits
Finance
  • Assets
    • GET List assets
    • GET Retrieve asset
    • POST Create assets
    • PUT Upsert asset
    • PUT Upsert assets in a batch
    • GET List applied entries for an asset
    • POST Add applied entry to an asset
    • PATCH Partially update applied entry on an asset
    • DELETE Remove applied entry from an asset
    • PUT Reorder applied entries for an asset
    • GET List applied modifiers for an asset
    • POST Add applied modifier to an asset
    • PATCH Partially update applied modifier on an asset
    • DELETE Remove applied modifier from an asset
    • PUT Reorder applied modifiers for an asset
    • GET List transactions
    • POST Record a payment
  • Clients
    • GET List clients
    • GET Retrieve client
    • POST Create clients
    • PUT Upsert client
    • DELETE Delete client
    • PUT Upsert clients in a batch
    • GET List client contacts
    • POST Add a contact to a client
    • DELETE Remove a contact from a client
  • Contacts
    • GET List contacts
    • GET Retrieve contact
    • POST Create contacts
    • PUT Upsert contact
    • DELETE Delete contact
    • PUT Upsert contacts in a batch
  • Currencies
    • GET List currencies
    • GET Retrieve currency
    • POST Create currencies
    • PUT Upsert currency
    • DELETE Archive currency
    • PUT Upsert currencies in a batch
    • PUT Set the default currency
  • Entries
    • GET List catalog entries
    • GET Retrieve catalog entry
    • POST Create catalog entries
    • PUT Upsert catalog entry
    • DELETE Archive catalog entry
    • PUT Upsert catalog entries in a batch
  • Expenses
    • GET List expenses
    • GET Retrieve expense
    • POST Create expenses
    • PUT Upsert expense
    • DELETE Delete expense
    • PUT Upsert expenses in a batch
    • GET List applied entries for an expense
    • POST Add applied entry to an expense
    • PATCH Partially update applied entry on an expense
    • DELETE Remove applied entry from an expense
    • PUT Reorder applied entries for an expense
    • GET List applied modifiers for an expense
    • POST Add applied modifier to an expense
    • PATCH Partially update applied modifier on an expense
    • DELETE Remove applied modifier from an expense
    • PUT Reorder applied modifiers for an expense
    • GET List transactions
    • POST Record a payment
  • Expense Templates
    • GET List expense templates
    • POST Create expense templates
    • PUT Upsert expense template
    • DELETE Delete expense template
    • PUT Upsert expense templates in a batch
    • GET List applied entries for an expense template
    • POST Add applied entry to an expense template
    • PATCH Partially update applied entry on an expense template
    • DELETE Remove applied entry from an expense template
    • PUT Reorder applied entries for an expense template
    • GET List applied modifiers for an expense template
    • POST Add applied modifier to an expense template
    • PATCH Partially update applied modifier on an expense template
    • DELETE Remove applied modifier from an expense template
    • PUT Reorder applied modifiers for an expense template
  • Income
    • GET List income records
    • GET Retrieve income record
    • POST Create income records
    • PUT Upsert income record
    • DELETE Delete income record
    • PUT Upsert income records in a batch
    • GET List applied entries for an income record
    • POST Add applied entry to an income record
    • PATCH Partially update applied entry on an income record
    • DELETE Remove applied entry from an income record
    • PUT Reorder applied entries for an income record
    • GET List applied modifiers for an income record
    • POST Add applied modifier to an income record
    • PATCH Partially update applied modifier on an income record
    • DELETE Remove applied modifier from an income record
    • PUT Reorder applied modifiers for an income record
    • GET List transactions
    • POST Record a payment
  • Invoices
    • GET List invoices
    • GET Retrieve invoice
    • POST Create invoices
    • PUT Upsert invoice
    • DELETE Delete invoice
    • PUT Upsert invoices in a batch
    • GET List applied entries for an invoice
    • POST Add applied entry to an invoice
    • PATCH Partially update applied entry on an invoice
    • DELETE Remove applied entry from an invoice
    • PUT Reorder applied entries for an invoice
    • GET List applied modifiers for an invoice
    • POST Add applied modifier to an invoice
    • PATCH Partially update applied modifier on an invoice
    • DELETE Remove applied modifier from an invoice
    • PUT Reorder applied modifiers for an invoice
    • GET List transactions
    • POST Record a payment
  • Invoice Templates
    • GET List invoice templates
    • POST Create invoice templates
    • PUT Upsert invoice template
    • DELETE Delete invoice template
    • PUT Upsert invoice templates in a batch
    • GET List applied entries for an invoice template
    • POST Add applied entry to an invoice template
    • PATCH Partially update applied entry on an invoice template
    • DELETE Remove applied entry from an invoice template
    • PUT Reorder applied entries for an invoice template
    • GET List applied modifiers for an invoice template
    • POST Add applied modifier to an invoice template
    • PATCH Partially update applied modifier on an invoice template
    • DELETE Remove applied modifier from an invoice template
    • PUT Reorder applied modifiers for an invoice template
  • Modifiers
    • GET List modifiers
    • GET Retrieve modifier
    • POST Create modifiers
    • PUT Upsert modifier
    • DELETE Archive modifier
    • PUT Upsert modifiers in a batch
    • PUT Set the workspace tax modifier
  • Payouts
    • GET List payouts
    • GET Retrieve payout
    • POST Create payouts
    • PUT Upsert payout
    • DELETE Delete payout
    • PUT Upsert payouts in a batch
    • GET List applied entries for a payout
    • POST Add applied entry to a payout
    • PATCH Partially update applied entry on a payout
    • DELETE Remove applied entry from a payout
    • PUT Reorder applied entries for a payout
    • GET List applied modifiers for a payout
    • POST Add applied modifier to a payout
    • PATCH Partially update applied modifier on a payout
    • DELETE Remove applied modifier from a payout
    • PUT Reorder applied modifiers for a payout
    • GET List transactions
    • POST Record a payment
  • Payout Templates
    • GET List payout templates
    • POST Create payout templates
    • PUT Upsert payout template
    • DELETE Delete payout template
    • PUT Upsert payout templates in a batch
    • GET List applied entries for a payout template
    • POST Add applied entry to a payout template
    • PATCH Partially update applied entry on a payout template
    • DELETE Remove applied entry from a payout template
    • PUT Reorder applied entries for a payout template
    • GET List applied modifiers for a payout template
    • POST Add applied modifier to a payout template
    • PATCH Partially update applied modifier on a payout template
    • DELETE Remove applied modifier from a payout template
    • PUT Reorder applied modifiers for a payout template
  • Projects
    • GET List projects
    • GET Retrieve project
    • POST Create projects
    • PUT Upsert project
    • DELETE Delete project
    • PUT Upsert projects in a batch
  • Tags
    • GET List tags
    • GET Retrieve tag
    • POST Create tags
    • PUT Upsert tag
    • DELETE Delete tag
    • PUT Upsert tags in a batch
  • Transactions
    • GET List transactions
    • DELETE Delete a transaction
    • PATCH Update a transaction
  • Units
    • GET List units
    • GET Retrieve unit
    • POST Create units
    • PUT Upsert unit
    • DELETE Archive unit
    • PUT Upsert units in a batch
  • Vendors
    • GET List vendors
    • GET Retrieve vendor
    • POST Create vendors
    • PUT Upsert vendor
    • DELETE Delete vendor
    • PUT Upsert vendors in a batch
    • GET List vendor contacts
    • POST Add a contact to a vendor
    • DELETE Remove a contact from a vendor
Workspace
  • Bank Accounts
    • GET List bank accounts
    • POST Create bank accounts
    • PUT Upsert bank account
    • DELETE Archive bank account
    • PUT Upsert bank accounts in a batch
    • PUT Update bank accounts defaults
  • Invitations
    • POST Create workspace participant
    • DELETE Revoke workspace participant
    • POST Resend a workspace invitation
    • POST Accept pending workspace invitations
    • GET List pending workspace invitations
  • Participants
    • GET List workspace participants
    • DELETE Delete workspace participant
    • PUT Update a workspace participant role
  • Preferences
    • PUT Save workspace preferences
  • Settings
    • GET Read workspace settings
    • PUT Update workspace settings
    • POST Create a workspace avatar upload
  • Fiscal Year
    • PUT Update the workspace fiscal year
  • Payables
    • GET Read payable settings
    • PUT Save payable settings
Integrations
  • API keys
    • GET List API keys
    • POST Create API keys
    • DELETE Revoke API key
  • Logs
    • GET List integration logs
  • Retention
    • GET Get integration retention
    • PUT Update integration retention
    • GET Preview integration retention
    • POST Prune integration retention
  • Webhooks
    • GET List webhooks
    • POST Create webhooks
    • PUT Update webhooks
    • DELETE Delete webhook
    • GET List webhook deliveries
    • POST Retry a failed webhook delivery
    • POST Pause webhook deliveries
    • POST Resume webhook deliveries
    • POST Rotate webhook signing credentials
    • POST Send a test webhook delivery
    • POST Verify webhook
Reports
  • Reports
    • GET Read the workspace balance sheet
    • GET Read workspace cash flow
    • GET Read the workspace cashbook
    • GET Read the workspace financial center report
    • GET Read the workspace income statement
    • GET List workspace financial movements
    • GET Read the workspace financial overview report
    • GET Read workspace payables aging
    • GET Read the workspace profit and loss statement
    • GET Read workspace receivables aging
    • GET Read workspace financial statements
    • GET Read the workspace financial summary report
    • GET Read workspace tax control
    • GET Read the workspace trial balance
Billing
  • Checkouts
    • POST Create a billing checkout session
  • Plans
    • GET List available billing plans
  • Usage
    • GET Read current billing usage
Account
  • Profile
    • GET Read profile settings
    • POST Create the initial profile
    • PUT Update profile settings
    • POST Create a profile avatar upload
  • Profile Preferences
    • GET Read profile preferences
    • PUT Save profile preferences
  • Workspaces
    • GET List workspaces available to the current identity
    • POST Create a workspace
Authentication
  • Authentication
    • POST Request an email sign-in challenge
    • POST Complete email sign-in and issue a bearer credential
© NQD Machine-readable docs
Documentation Guides API reference For agents OpenAPI Open Dash ↗
API reference/ clients
API reference

Clients

NQD API Clients reference. List clients; Retrieve client; Create clients

OpenAPI JSON ↗
GET /v1/clients
List clients →
GET /v1/clients/{clientId}
Retrieve client →
POST /v1/clients
Create clients →
PUT /v1/clients/{clientId}
Upsert client →
DELETE /v1/clients/{clientId}
Delete client →
PUT /v1/clients
Upsert clients in a batch →
GET /v1/clients/{clientId}/contacts
List client contacts →
POST /v1/clients/{clientId}/contacts/{contactId}
Add a contact to a client →
DELETE /v1/clients/{clientId}/contacts/{contactId}
Remove a contact from a client →
i

Every operation uses the same Core contract as the dashboard. Request and response fields, examples, and code samples are generated from the current API descriptor.