Accounting

📄️List Transactions (V3 - Paginated)

Returns a paginated list of accounting transactions using the Spatie QueryBuilder. This is the V3 replacement for the legacy DataTable index endpoint.

📄️Get Transaction

Returns a single accounting transaction with full details including lines, nominal codes, tax rates, integration data, and parent/children.

📄️Create Transaction

Creates a new accounting transaction.

📄️Bulk Delete Transactions

Deletes multiple accounting transactions by ID.

📄️Update Transaction

Updates an existing accounting transaction.

📄️Delete Transaction

Deletes an accounting transaction.

📄️Get Transactions Needing Sync

Returns accounting transactions that need to be synced to the configured integration (QBO or Xero). Integration-agnostic: auto-detects the configured accounting system.

📄️Get Transactions Needing Sync Count

Returns the count of accounting transactions that need to be synced. Integration-agnostic.

📄️Get Awaiting Sync Report

Returns a summary report of transactions awaiting sync, grouped by type.

📄️Get Transaction Payments

Returns all payments associated with a specific accounting transaction.

📄️Sync Transactions to External

Forces sync of the specified accounting transaction IDs to the external integration (QBO or Xero). Bypasses timestamp eligibility checks but still respects basic eligibility. Supports both creates and updates.

📄️Sync All Transactions

Dispatches a background job to sync all eligible accounting transactions to the external integration.

📄️Refresh Transactions

Re-syncs accounting transaction data from the source documents (sales orders, purchase orders, etc.) to recalculate totals and lines.

📄️Clear Transaction Errors

Clears sync errors on the specified accounting transactions so they can be retried.

📄️Unlink Transactions from Integration

Unlinks the specified accounting transactions from the external accounting integration (removes the integration reference, allowing them to be re-synced as new).

📄️Bulk Replace Nominal Codes

Replaces the nominal code on all lines of the specified transactions where the old nominal code is used.

📄️Bulk Enable/Disable Sync

Enables or disables sync for the specified accounting transactions.

📄️Delete Integration Payments (Transactions)

Deletes payments from Xero for the specified transaction IDs.

📄️Update Transaction Sync Settings

Updates the is_sync_enabled default setting for accounting transactions of a given type.

📄️Start Export Job

Dispatches a tracked background export job for accounting transactions. Returns a tracked_job_log_id to monitor progress via the job tray. When complete, use the download endpoint to retrieve the file.

📄️Download Export File

Downloads a completed accounting transaction export file from the model-exports disk. Supports both CSV and XLSX files.

📄️List Payments (V3 - Paginated)

Returns a paginated list of accounting payments using the Spatie QueryBuilder. V3 replacement for the legacy DataTable payments endpoint.

📄️Get Payment

Returns a single accounting payment.

📄️Update Payment

Updates an existing accounting payment.

📄️Delete Payment

Deletes an accounting payment.

📄️Create Payment

Creates a new accounting payment.

📄️Get Payments Needing Sync

Returns payments that need to be synced to the configured accounting integration (QBO or Xero).

📄️Get Payment Sync Status

Returns the current sync status for accounting payments.

📄️Sync Payments to External

Syncs specific payments to the configured accounting integration (QBO or Xero).

📄️Sync All Payments

Syncs all pending payments to the configured accounting integration.

📄️Clear Payment Errors

Clears sync errors on accounting payments so they can be retried.

📄️Delete Integration Payments

Deletes specific payments from the external accounting integration.

📄️Get Sync Settings

Returns the accounting sync settings for the configured integration, including per-type sync enable/disable controls and sync start dates.

📄️Update Sync Settings

Updates the accounting sync settings. Unsubmitted types are preserved (partial updates supported).

📄️Get Transaction Types

Returns all available accounting transaction types with their human-readable labels.

📄️Get Batch Transaction

Returns a batch accounting transaction. When metadata_only=true, returns only id, period_type, batch_period, type, and timestamps without loading all batch items.

📄️Get Batch Transaction Items (Paginated)

Returns a paginated list of items within a batch accounting transaction.

📄️Get Accounting Integration

Returns the currently configured accounting integration instance (QBO or Xero).