Docs Developers
API reference
Base address
Every copy of SlowBooks Pro runs its own REST API. The desktop app answers at http://127.0.0.1:3001 by default, on this computer only; a Server Edition install answers at the server’s own address. Every path below is under that address. The running app also serves its OpenAPI document at /openapi.json, which describes every operation and every field, and an interactive view of it at /docs.
Amounts are decimal dollars, as the API returns them. Dates are ISO (YYYY-MM-DD). Unknown fields are refused, never dropped. Posted documents are voided (POST …/{id}/void), not deleted.
Authentication
A program signs in with an API token. Send it on every request:
Authorization: Bearer sbp_…
To make one, an administrator signs in to SlowBooks Pro and opens Settings → Users and security → API Tokens, gives the token a label and a role, and copies the secret. It is shown once. Every change made with the token is in the audit log as token:<label>. Revoking a token is final: its requests are then refused with a sentence naming it.
The role strings are readonly, bookkeeper, accountant. A token is never an administrator.
| Role | What a token with it may do |
|---|---|
readonly | Read the books and run reports. Every write is refused, and so are payroll and HR, the audit log, and copying an invoice’s payment link. |
bookkeeper | Read the books and make the daily-books changes: customers, vendors, items, invoices, bills, payments, deposits, banking, journal entries, voids. Not users, tokens, settings, backups, the company file, payment terms, invoice messages, imports or employee records; payroll, tax forms, benefits, deductions and onboarding are neither read nor changed. |
accountant | Read the books, except payroll, HR and employee records, and post journal entries: post and void its own, attach support to them, reclassify lines, and post or void the WIP schedule’s entry. |
An administrator can add permissions to a token: Can make backups (make, list and download this company’s backups, never restore), and on a bookkeeper token only, Can run payroll and Can run imports. No token can manage users or tokens, restore a backup, or change settings or the company file. SlowBooks Pro decides every request as it decides a person’s: the role, the closing date and every rule of the app.
A few routes need no sign-in: the sign-in routes (/api/auth/*), /health, /openapi.json, a customer’s pay page and its checkout, the payment providers’ webhooks, and the employee portal under /portal/.
An assistant connected with Connect to AI assistant uses a bookkeeper token labeled AI assistant (relay); its free-form tools call the operations listed below.
Several companies on one server
A token belongs to the company it was made in. On a Server Edition host serving several companies, name that company on each request:
X-SlowBooks-Company: <file>.db
Without the header, a request goes to the company the server was started for.
Errors
A refusal is an HTTP status with a JSON body whose detail says why, in a sentence meant to be passed on to a person. Do not retry a refusal unchanged.
| Status | Means |
|---|---|
401 | No token, a wrong or revoked token, or a sign-in for another company. |
403 | The role does not allow it, or the date is on or before the closing date. |
404 | No such record. |
405 | A DELETE on a posted document; the answer names its void route. |
409 | A conflict: for example an Idempotency-Key sent again with a different body, or a schedule entered elsewhere first. |
422 | A field is missing, wrong or unknown. detail is a list, one entry per field, each with a plain message. |
Retry-safe payments. Send an Idempotency-Key header on POST /api/payments and POST /api/bill-payments. The same key with the same body books once and answers the first result again (with X-Replayed: true); the same key with another body is a 409.
Endpoint index
All 835 operations of SlowBooks Pro v2.31.14, generated from its OpenAPI document and grouped by area and by the document’s tags. The fields each one takes are in /openapi.json on your own copy, which always matches the version you run. The same list as JSON is at /ai/api-index.json; for working with an agent, see Using SlowBooks with an AI agent.
Books and reports · Sales · Purchases · Banking · Jobs, classes and assets · Construction · Payroll and HR (administrators) · Nonprofit · Import and export · Files · Company, access and audit · Outside /api
Books and reports (185)
| Method | Path | Summary |
|---|---|---|
GET | /api/accounts | List Accounts |
POST | /api/accounts | Create Account |
GET | /api/accounts/detail-types | List Detail Types |
POST | /api/accounts/rebuild-balances | Rebuild Balances |
GET | /api/accounts/unused-seeded | Unused Seeded |
POST | /api/accounts/unused-seeded/remove | Remove Unused Seeded |
GET | /api/accounts/{account_id} | Get Account |
PUT | /api/accounts/{account_id} | Update Account |
DELETE | /api/accounts/{account_id} | Delete Account |
| Method | Path | Summary |
|---|---|---|
GET | /api/analytics/ai-actions | List Ai Actions |
POST | /api/analytics/ai-actions/{action_key} | Run Ai Action |
GET | /api/analytics/ai-config | Get Ai Config |
PUT | /api/analytics/ai-config | Put Ai Config |
POST | /api/analytics/ai-config/test | Test Ai Config |
POST | /api/analytics/ai-insights | Ai Insights |
GET | /api/analytics/ai-models | Get Ai Models |
POST | /api/analytics/ai-models | Post Ai Models |
POST | /api/analytics/ai-query | Ai Query |
GET | /api/analytics/cash-flow | Get Cash Flow |
GET | /api/analytics/dashboard | Get Dashboard |
GET | /api/analytics/expenses | Get Expenses |
GET | /api/analytics/export.csv | Export Csv |
GET | /api/analytics/export.pdf | Export Pdf |
GET | /api/analytics/profitability | Get Profitability |
GET | /api/analytics/revenue | Get Revenue |
| Method | Path | Summary |
|---|---|---|
GET | /api/dashboard/data | Widget Data |
GET | /api/dashboard/widgets | List Widgets |
| Method | Path | Summary |
|---|---|---|
GET | /api/journal | List Journal Entries |
POST | /api/journal | Create Manual Journal Entry |
GET | /api/journal/{entry_id} | Get Journal Entry |
PUT | /api/journal/{entry_id} | Update Journal Entry |
POST | /api/journal/{entry_id}/void | Void Journal Entry |
| Method | Path | Summary |
|---|---|---|
POST | /api/opening-balances | Create Opening Balances |
GET | /api/opening-balances/status | Status |
| Method | Path | Summary |
|---|---|---|
POST | /api/reclassify | Reclassify |
GET | /api/reclassify/lines | Lines |
| Method | Path | Summary |
|---|---|---|
GET | /api/reports/1099-summary | Report 1099 Summary |
GET | /api/reports/account-transactions | Account Transactions |
GET | /api/reports/account-transactions/csv | Account Transactions Csv Route |
GET | /api/reports/account-transactions/pdf | Account Transactions Pdf Route |
GET | /api/reports/account-transactions/print | Account Transactions Pdf Route Print |
GET | /api/reports/accountants-package | Accountants Package |
GET | /api/reports/accountants-package/manifest | Accountants Package Manifest |
GET | /api/reports/adjusting-entries | Adjusting Entries |
GET | /api/reports/adjusting-entries/csv | Adjusting Entries Csv Route |
GET | /api/reports/adjusting-entries/pdf | Adjusting Entries Pdf Route |
GET | /api/reports/adjusting-entries/print | Adjusting Entries Pdf Route Print |
GET | /api/reports/ap-aging | Ap Aging |
GET | /api/reports/ap-aging/csv | Ap Aging Csv Route |
GET | /api/reports/ar-aging | Ar Aging |
GET | /api/reports/ar-aging/csv | Ar Aging Csv Route |
GET | /api/reports/balance-sheet | Balance Sheet |
GET | /api/reports/balance-sheet/csv | Balance Sheet Csv Route |
GET | /api/reports/balance-sheet/pdf | Balance Sheet Pdf |
GET | /api/reports/balance-sheet/print | Balance Sheet Pdf Print |
POST | /api/reports/batch-email-statements | Batch Email Statements |
GET | /api/reports/buyout | Buyout Route |
GET | /api/reports/buyout/csv | Buyout Csv |
GET | /api/reports/buyout/pdf | Buyout Pdf |
GET | /api/reports/buyout/print | Buyout Pdf Print |
GET | /api/reports/cash-flow | Cash Flow |
GET | /api/reports/change-order-log | Change Order Log Route |
GET | /api/reports/change-order-log/csv | Change Order Log Csv |
GET | /api/reports/change-order-log/pdf | Change Order Log Pdf |
GET | /api/reports/change-order-log/print | Change Order Log Pdf Print |
GET | /api/reports/closing-date-exceptions | Closing Date Exceptions Route |
GET | /api/reports/closing-date-exceptions/csv | Closing Date Exceptions Csv Route |
GET | /api/reports/closing-date-exceptions/pdf | Closing Date Exceptions Pdf Route |
GET | /api/reports/closing-date-exceptions/print | Closing Date Exceptions Pdf Route Print |
POST | /api/reports/collection-letters | Collection Letters |
GET | /api/reports/commitment-status | Commitment Status Route |
GET | /api/reports/commitment-status/csv | Commitment Status Csv |
GET | /api/reports/commitment-status/pdf | Commitment Status Pdf |
GET | /api/reports/commitment-status/print | Commitment Status Pdf Print |
GET | /api/reports/compliance | Compliance Route |
GET | /api/reports/compliance/csv | Compliance Csv |
GET | /api/reports/compliance/pdf | Compliance Pdf |
GET | /api/reports/compliance/print | Compliance Pdf Print |
GET | /api/reports/cost-to-complete | Cost To Complete Route |
GET | /api/reports/cost-to-complete-forecast | Cost To Complete Forecast Route |
GET | /api/reports/cost-to-complete-forecast/csv | Cost To Complete Forecast Csv |
GET | /api/reports/cost-to-complete-forecast/pdf | Cost To Complete Forecast Pdf |
GET | /api/reports/cost-to-complete-forecast/print | Cost To Complete Forecast Pdf Print |
GET | /api/reports/cost-to-complete/csv | Cost To Complete Csv |
GET | /api/reports/cost-to-complete/pdf | Cost To Complete Pdf |
GET | /api/reports/cost-to-complete/print | Cost To Complete Pdf Print |
GET | /api/reports/customer-statement/{customer_id}/pdf | Customer Statement Pdf |
GET | /api/reports/customer-statement/{customer_id}/print | Customer Statement Pdf Print |
GET | /api/reports/field-ticket-log | Field Ticket Log Route |
GET | /api/reports/field-ticket-log/csv | Field Ticket Log Csv |
GET | /api/reports/field-ticket-log/pdf | Field Ticket Log Pdf |
GET | /api/reports/field-ticket-log/print | Field Ticket Log Pdf Print |
GET | /api/reports/financial-statements/pdf | Financial Statements Pdf |
GET | /api/reports/financial-statements/print | Financial Statements Pdf Print |
GET | /api/reports/first-date | First Date |
GET | /api/reports/functional-expenses | Functional Expenses |
GET | /api/reports/functional-expenses/csv | Functional Expenses Csv |
GET | /api/reports/functional-expenses/pdf | Functional Expenses Pdf |
GET | /api/reports/functional-expenses/print | Functional Expenses Pdf Print |
GET | /api/reports/fund-balances | Fund Balances |
GET | /api/reports/fund-balances/csv | Fund Balances Csv |
GET | /api/reports/fund-balances/pdf | Fund Balances Pdf |
GET | /api/reports/fund-balances/print | Fund Balances Pdf Print |
GET | /api/reports/general-ledger | General Ledger |
GET | /api/reports/general-ledger/csv | General Ledger Csv Route |
GET | /api/reports/general-ledger/pdf | General Ledger Pdf |
GET | /api/reports/general-ledger/print | General Ledger Pdf Print |
GET | /api/reports/income-by-customer | Income By Customer |
GET | /api/reports/job-budget-vs-actual/csv | Job Budget Vs Actual Csv |
GET | /api/reports/job-budget-vs-actual/pdf | Job Budget Vs Actual Pdf |
GET | /api/reports/job-budget-vs-actual/print | Job Budget Vs Actual Pdf Print |
GET | /api/reports/job-cost-by-vendor | Job Cost By Vendor Route |
GET | /api/reports/job-cost-by-vendor/csv | Job Cost By Vendor Csv |
GET | /api/reports/job-cost-by-vendor/pdf | Job Cost By Vendor Pdf |
GET | /api/reports/job-cost-by-vendor/print | Job Cost By Vendor Pdf Print |
GET | /api/reports/job-profitability | Job Profitability Report |
GET | /api/reports/job-profitability/csv | Job Profitability Csv |
GET | /api/reports/job-profitability/pdf | Job Profitability Pdf |
GET | /api/reports/job-profitability/print | Job Profitability Pdf Print |
GET | /api/reports/pledges | Pledges |
GET | /api/reports/pledges/csv | Pledges Csv |
GET | /api/reports/pledges/pdf | Pledges Pdf |
GET | /api/reports/pledges/print | Pledges Pdf Print |
GET | /api/reports/possible-duplicates | Possible Duplicates Route |
GET | /api/reports/possible-duplicates/csv | Possible Duplicates Csv Route |
POST | /api/reports/possible-duplicates/dismiss | Dismiss Possible Duplicate |
DELETE | /api/reports/possible-duplicates/dismissals/{dismissal_id} | Restore Possible Duplicate |
GET | /api/reports/possible-duplicates/pdf | Possible Duplicates Pdf Route |
GET | /api/reports/possible-duplicates/print | Possible Duplicates Pdf Route Print |
GET | /api/reports/profit-loss | Profit Loss |
GET | /api/reports/profit-loss-by-class | Profit Loss By Class |
GET | /api/reports/profit-loss-by-class/csv | Profit Loss By Class Csv Route |
GET | /api/reports/profit-loss-by-class/pdf | Profit Loss By Class Pdf |
GET | /api/reports/profit-loss-by-class/print | Profit Loss By Class Pdf Print |
GET | /api/reports/profit-loss-by-job | Profit Loss By Job |
GET | /api/reports/profit-loss-by-job/csv | Profit Loss By Job Csv Route |
GET | /api/reports/profit-loss-by-job/pdf | Profit Loss By Job Pdf |
GET | /api/reports/profit-loss-by-job/print | Profit Loss By Job Pdf Print |
GET | /api/reports/profit-loss-detail | Profit Loss Detail |
GET | /api/reports/profit-loss-detail/csv | Profit Loss Detail Csv Route |
GET | /api/reports/profit-loss-detail/pdf | Profit Loss Detail Pdf |
GET | /api/reports/profit-loss-detail/print | Profit Loss Detail Pdf Print |
GET | /api/reports/profit-loss/csv | Profit Loss Csv Route |
GET | /api/reports/profit-loss/pdf | Profit Loss Pdf |
GET | /api/reports/profit-loss/print | Profit Loss Pdf Print |
GET | /api/reports/purchases-by-item | Purchases By Item |
GET | /api/reports/purchases-by-item/csv | Purchases By Item Csv Route |
GET | /api/reports/purchases-by-item/lines | Purchases By Item Lines |
GET | /api/reports/purchases-by-item/pdf | Purchases By Item Pdf |
GET | /api/reports/purchases-by-item/print | Purchases By Item Pdf Print |
GET | /api/reports/retainage | Retainage Route |
GET | /api/reports/retainage/csv | Retainage Csv |
GET | /api/reports/retainage/pdf | Retainage Pdf |
GET | /api/reports/retainage/print | Retainage Pdf Print |
GET | /api/reports/sales-by-item | Sales By Item |
GET | /api/reports/sales-by-item/csv | Sales By Item Csv Route |
GET | /api/reports/sales-by-item/lines | Sales By Item Lines |
GET | /api/reports/sales-by-item/pdf | Sales By Item Pdf |
GET | /api/reports/sales-by-item/print | Sales By Item Pdf Print |
GET | /api/reports/sales-tax | Sales Tax Report |
POST | /api/reports/sales-tax/pay | Pay Sales Tax |
GET | /api/reports/statement-of-activities | Statement Of Activities |
GET | /api/reports/statement-of-activities/csv | Statement Of Activities Csv |
GET | /api/reports/statement-of-activities/pdf | Statement Of Activities Pdf |
GET | /api/reports/statement-of-activities/print | Statement Of Activities Pdf Print |
GET | /api/reports/statement-of-financial-position | Statement Of Financial Position |
GET | /api/reports/statement-of-financial-position/csv | Statement Of Financial Position Csv |
GET | /api/reports/statement-of-financial-position/pdf | Statement Of Financial Position Pdf |
GET | /api/reports/statement-of-financial-position/print | Statement Of Financial Position Pdf Print |
GET | /api/reports/trial-balance | Trial Balance |
GET | /api/reports/trial-balance/csv | Trial Balance Csv Route |
GET | /api/reports/trial-balance/pdf | Trial Balance Pdf |
GET | /api/reports/trial-balance/print | Trial Balance Pdf Print |
GET | /api/reports/wip-schedule | Wip Schedule Route |
GET | /api/reports/wip-schedule/csv | Wip Schedule Csv |
GET | /api/reports/wip-schedule/pdf | Wip Schedule Pdf |
POST | /api/reports/wip-schedule/post | Wip Schedule Post |
GET | /api/reports/wip-schedule/print | Wip Schedule Pdf Print |
POST | /api/reports/wip-schedule/void | Wip Schedule Void |
| Method | Path | Summary |
|---|---|---|
GET | /api/saved-reports | List Saved Reports |
POST | /api/saved-reports | Create Saved Report |
GET | /api/saved-reports/{report_id} | Get Saved Report |
PUT | /api/saved-reports/{report_id} | Update Saved Report |
DELETE | /api/saved-reports/{report_id} | Delete Saved Report |
| Method | Path | Summary |
|---|---|---|
GET | /api/search | Unified Search |
Sales (139)
| Method | Path | Summary |
|---|---|---|
POST | /api/batch-payments | Create Batch Payment |
| Method | Path | Summary |
|---|---|---|
GET | /api/collections/invoices | Collections Invoices |
POST | /api/collections/invoices/{invoice_id}/remind | Remind Invoice |
GET | /api/collections/reminders/due | Reminders Due |
POST | /api/collections/reminders/run | Reminders Run |
POST | /api/collections/reminders/run-if-due | Reminders Run If Due |
GET | /api/collections/rules | List Rules |
POST | /api/collections/rules | Create Rule |
PUT | /api/collections/rules/{rule_id} | Update Rule |
DELETE | /api/collections/rules/{rule_id} | Delete Rule |
GET | /api/collections/statements/due | Statements Due |
POST | /api/collections/statements/run | Statements Run |
| Method | Path | Summary |
|---|---|---|
GET | /api/credit-memos | List Credit Memos |
POST | /api/credit-memos | Create Credit Memo |
GET | /api/credit-memos/{cm_id} | Get Credit Memo |
POST | /api/credit-memos/{cm_id}/apply | Apply Credit |
GET | /api/credit-memos/{cm_id}/pdf | Credit Memo Pdf |
GET | /api/credit-memos/{cm_id}/print-preview | Credit Memo Print Preview |
POST | /api/credit-memos/{cm_id}/replace | Replace Credit Memo |
POST | /api/credit-memos/{cm_id}/void | Void Credit Memo |
| Method | Path | Summary |
|---|---|---|
GET | /api/customers | List Customers |
POST | /api/customers | Create Customer |
GET | /api/customers/check-duplicate | Check Duplicate |
GET | /api/customers/past | Past Customers |
GET | /api/customers/past.csv | Past Customers Csv |
GET | /api/customers/past/labels.pdf | Past Customers Labels |
GET | /api/customers/{customer_id} | Get Customer |
PUT | /api/customers/{customer_id} | Update Customer |
DELETE | /api/customers/{customer_id} | Delete Customer |
GET | /api/customers/{customer_id}/credits | Customer Credits |
GET | /api/customers/{customer_id}/subs | Customer Subs |
| Method | Path | Summary |
|---|---|---|
GET | /api/deposits | List Deposits |
POST | /api/deposits | Create Deposit |
GET | /api/deposits/pending | List Pending Deposits |
GET | /api/deposits/{deposit_id} | Get Deposit |
PUT | /api/deposits/{deposit_id} | Update Deposit |
GET | /api/deposits/{deposit_id}/pdf | Deposit Pdf |
GET | /api/deposits/{deposit_id}/print-preview | Deposit Print Preview |
POST | /api/deposits/{deposit_id}/void | Void Deposit |
| Method | Path | Summary |
|---|---|---|
GET | /api/email-templates | List Templates |
POST | /api/email-templates | Create Template |
POST | /api/email-templates/preview | Preview Template |
POST | /api/email-templates/seed-defaults | Seed Defaults |
GET | /api/email-templates/{template_id} | Get Template |
PUT | /api/email-templates/{template_id} | Update Template |
DELETE | /api/email-templates/{template_id} | Delete Template |
| Method | Path | Summary |
|---|---|---|
GET | /api/estimates | List Estimates |
POST | /api/estimates | Create Estimate |
GET | /api/estimates/{estimate_id} | Get Estimate |
PUT | /api/estimates/{estimate_id} | Update Estimate |
POST | /api/estimates/{estimate_id}/accept | Accept Estimate |
POST | /api/estimates/{estimate_id}/convert | Convert To Invoice |
POST | /api/estimates/{estimate_id}/email | Email Estimate |
POST | /api/estimates/{estimate_id}/lost | Mark Estimate Lost |
GET | /api/estimates/{estimate_id}/pdf | Estimate Pdf |
GET | /api/estimates/{estimate_id}/print-preview | Estimate Print Preview |
| Method | Path | Summary |
|---|---|---|
GET | /api/invoice-messages | List Messages |
POST | /api/invoice-messages | Create Message |
PUT | /api/invoice-messages/{message_id} | Update Message |
DELETE | /api/invoice-messages/{message_id} | Delete Message |
| Method | Path | Summary |
|---|---|---|
GET | /api/invoices | List Invoices |
POST | /api/invoices | Create Invoice |
POST | /api/invoices/apply-late-fees | Apply Late Fees |
POST | /api/invoices/write-offs | Write Off Batch |
GET | /api/invoices/write-offs/candidates | Write Off Candidates |
GET | /api/invoices/{invoice_id} | Get Invoice |
PUT | /api/invoices/{invoice_id} | Update Invoice |
POST | /api/invoices/{invoice_id}/duplicate | Duplicate Invoice |
POST | /api/invoices/{invoice_id}/email | Email Invoice |
POST | /api/invoices/{invoice_id}/email-preview | Email Invoice Preview |
GET | /api/invoices/{invoice_id}/pdf | Invoice Pdf |
GET | /api/invoices/{invoice_id}/print-preview | Invoice Print Preview |
POST | /api/invoices/{invoice_id}/send | Mark Invoice Sent |
POST | /api/invoices/{invoice_id}/void | Void Invoice |
POST | /api/invoices/{invoice_id}/write-off | Write Off Invoice |
| Method | Path | Summary |
|---|---|---|
GET | /api/items | List Items |
POST | /api/items | Create Item |
GET | /api/items/low-stock | Low Stock Items |
GET | /api/items/valuation | Inventory Valuation |
GET | /api/items/{item_id} | Get Item |
PUT | /api/items/{item_id} | Update Item |
DELETE | /api/items/{item_id} | Delete Item |
POST | /api/items/{item_id}/adjust | Adjust Inventory |
GET | /api/items/{item_id}/movements | List Item Movements |
| Method | Path | Summary |
|---|---|---|
GET | /api/memorized | List Schedules |
POST | /api/memorized | Create Memorized |
GET | /api/memorized/due | List Due |
POST | /api/memorized/enter-due | Enter Due |
GET | /api/memorized/entered-recently | Entered Recently |
GET | /api/memorized/{mem_id} | Get Memorized |
PUT | /api/memorized/{mem_id} | Update Memorized |
DELETE | /api/memorized/{mem_id} | Delete Memorized |
POST | /api/memorized/{mem_id}/enter | Enter Now |
POST | /api/memorized/{mem_id}/pause | Pause Memorized |
POST | /api/memorized/{mem_id}/resume | Resume Memorized |
| Method | Path | Summary |
|---|---|---|
GET | /api/payment-terms | List Terms |
POST | /api/payment-terms | Create Term |
GET | /api/payment-terms/dates | Terms Dates |
GET | /api/payment-terms/{term_id} | Get Term |
PUT | /api/payment-terms/{term_id} | Update Term |
PATCH | /api/payment-terms/{term_id} | Patch Term |
DELETE | /api/payment-terms/{term_id} | Delete Term |
| Method | Path | Summary |
|---|---|---|
GET | /api/payments | List Payments |
POST | /api/payments | Create Payment |
GET | /api/payments/payment-link/{invoice_id} | Get Payment Link |
POST | /api/payments/payment-link/{invoice_id} | Make Payment Link |
GET | /api/payments/{payment_id} | Get Payment |
POST | /api/payments/{payment_id}/apply | Apply Payment |
POST | /api/payments/{payment_id}/discount | Add Discount |
POST | /api/payments/{payment_id}/replace | Replace Payment |
POST | /api/payments/{payment_id}/void | Void Payment |
POST | /api/payments/{provider_name}/check-status/{invoice_id} | Check Status |
POST | /api/payments/{provider_name}/create-checkout-session | Create Checkout |
POST | /api/payments/{provider_name}/payout | Record Payout |
POST | /api/payments/{provider_name}/webhook | Provider Webhook |
POST | /api/stripe/webhook | Legacy Stripe Webhook |
| Method | Path | Summary |
|---|---|---|
GET | /api/recurring | List Recurring |
POST | /api/recurring | Create Recurring |
POST | /api/recurring/generate | Generate Now |
GET | /api/recurring/{rec_id} | Get Recurring |
PUT | /api/recurring/{rec_id} | Update Recurring |
DELETE | /api/recurring/{rec_id} | Delete Recurring |
POST | /api/recurring/{rec_id}/generate | Generate One |
| Method | Path | Summary |
|---|---|---|
GET | /api/reseller-permits | List Permits |
POST | /api/reseller-permits | Create Permit |
GET | /api/reseller-permits/expiring | Expiring Permits |
GET | /api/reseller-permits/validate-format | Validate Format |
GET | /api/reseller-permits/{permit_id} | Get Permit |
PUT | /api/reseller-permits/{permit_id} | Update Permit |
DELETE | /api/reseller-permits/{permit_id} | Delete Permit |
POST | /api/reseller-permits/{permit_id}/mark-verified | Mark Verified |
| Method | Path | Summary |
|---|---|---|
GET | /api/sales-receipts | List Sales Receipts |
POST | /api/sales-receipts | Create Sales Receipt |
| Method | Path | Summary |
|---|---|---|
GET | /api/tax/mappings | List Mappings |
POST | /api/tax/mappings | Create Mapping |
GET | /api/tax/return | Entity Return Report |
GET | /api/tax/return/csv | Entity Return Csv |
GET | /api/tax/schedule-c | Schedule C Report |
GET | /api/tax/schedule-c/csv | Schedule C Csv |
Purchases (52)
| Method | Path | Summary |
|---|---|---|
GET | /api/bill-payments | List Bill Payments |
POST | /api/bill-payments | Create Bill Payment |
GET | /api/bill-payments/{bill_payment_id} | Get Bill Payment |
POST | /api/bill-payments/{bill_payment_id}/discount | Add Discount |
PUT | /api/bill-payments/{bill_payment_id}/memo | Update Bill Payment Memo |
POST | /api/bill-payments/{bill_payment_id}/replace | Replace Bill Payment |
POST | /api/bill-payments/{bill_payment_id}/void | Void Bill Payment |
| Method | Path | Summary |
|---|---|---|
GET | /api/bills | List Bills |
POST | /api/bills | Create Bill |
GET | /api/bills/{bill_id} | Get Bill |
PUT | /api/bills/{bill_id} | Update Bill |
GET | /api/bills/{bill_id}/pdf | Bill Pdf |
GET | /api/bills/{bill_id}/print-preview | Bill Print Preview |
POST | /api/bills/{bill_id}/void | Void Bill |
| Method | Path | Summary |
|---|---|---|
GET | /api/cc-charges | List Cc Charges |
POST | /api/cc-charges | Create Cc Charge |
POST | /api/cc-charges/{charge_id}/replace | Replace Cc Charge |
POST | /api/cc-charges/{charge_id}/void | Void Cc Charge |
| Method | Path | Summary |
|---|---|---|
GET | /api/checks/print | Print Check |
POST | /api/checks/print-batch | Print Check Batch |
GET | /api/checks/test-print | Test Print Check |
GET | /api/checks/unprinted | Unprinted Checks |
| Method | Path | Summary |
|---|---|---|
GET | /api/expenses | List Expenses |
POST | /api/expenses | Create Expense |
GET | /api/expenses/{expense_id} | Get Expense |
POST | /api/expenses/{expense_id}/replace | Replace Expense |
POST | /api/expenses/{expense_id}/void | Void Expense |
| Method | Path | Summary |
|---|---|---|
GET | /api/purchase-orders | List Pos |
POST | /api/purchase-orders | Create Po |
GET | /api/purchase-orders/{po_id} | Get Po |
PUT | /api/purchase-orders/{po_id} | Update Po |
POST | /api/purchase-orders/{po_id}/convert-to-bill | Convert To Bill |
GET | /api/purchase-orders/{po_id}/pay-app | Commitment Pay App |
GET | /api/purchase-orders/{po_id}/pdf | Po Pdf |
GET | /api/purchase-orders/{po_id}/print-preview | Po Print Preview |
POST | /api/purchase-orders/{po_id}/release-retainage | Release Retainage |
| Method | Path | Summary |
|---|---|---|
GET | /api/vendor-credits | List Vendor Credits |
POST | /api/vendor-credits | Create Vendor Credit |
GET | /api/vendor-credits/{vc_id} | Get Vendor Credit |
POST | /api/vendor-credits/{vc_id}/apply | Apply Vendor Credit |
POST | /api/vendor-credits/{vc_id}/replace | Replace Vendor Credit |
POST | /api/vendor-credits/{vc_id}/void | Void Vendor Credit |
| Method | Path | Summary |
|---|---|---|
GET | /api/vendors | List Vendors |
POST | /api/vendors | Create Vendor |
GET | /api/vendors/check-duplicate | Check Duplicate |
GET | /api/vendors/{vendor_id} | Get Vendor |
PUT | /api/vendors/{vendor_id} | Update Vendor |
DELETE | /api/vendors/{vendor_id} | Delete Vendor |
GET | /api/vendors/{vendor_id}/bank-entries | Vendor Bank Entries |
GET | /api/vendors/{vendor_id}/payment-history | Vendor Payment History Route |
GET | /api/vendors/{vendor_id}/payments/csv | Vendor Payments Csv |
GET | /api/vendors/{vendor_id}/summary | Vendor Summary |
Banking (66)
| Method | Path | Summary |
|---|---|---|
POST | /api/bank-import/import-csv/{bank_account_id} | Import Csv |
POST | /api/bank-import/import/{bank_account_id} | Import Ofx |
POST | /api/bank-import/preview | Preview Ofx |
POST | /api/bank-import/preview-csv | Preview Csv |
| Method | Path | Summary |
|---|---|---|
GET | /api/bank-rules | List Rules |
POST | /api/bank-rules | Create Rule |
POST | /api/bank-rules/apply | Apply Rules |
GET | /api/bank-rules/{rule_id} | Get Rule |
PUT | /api/bank-rules/{rule_id} | Update Rule |
DELETE | /api/bank-rules/{rule_id} | Delete Rule |
| Method | Path | Summary |
|---|---|---|
GET | /api/banking/accounts | List Bank Accounts |
POST | /api/banking/accounts | Create Bank Account |
GET | /api/banking/accounts/{account_id} | Get Bank Account |
PUT | /api/banking/accounts/{account_id} | Update Bank Account |
POST | /api/banking/accounts/{account_id}/feed/add-all | Feed Add All |
POST | /api/banking/accounts/{account_id}/feed/auto-match | Feed Auto Match |
POST | /api/banking/accounts/{account_id}/feed/exclude-all | Feed Exclude All |
GET | /api/banking/accounts/{account_id}/feed/excluded | Feed Excluded |
POST | /api/banking/accounts/{account_id}/post-legacy-balance | Post Legacy Balance |
GET | /api/banking/check-register | Check Register |
GET | /api/banking/entries/{txn_id} | Get Bank Entry |
PUT | /api/banking/entries/{txn_id} | Update Bank Entry |
POST | /api/banking/entries/{txn_id}/void | Void Bank Entry |
GET | /api/banking/ledger-balance | Ledger Balance |
GET | /api/banking/overview | Banking Overview |
GET | /api/banking/reconciliations | List Reconciliations |
POST | /api/banking/reconciliations | Create Reconciliation |
PUT | /api/banking/reconciliations/{recon_id} | Update Reconciliation |
DELETE | /api/banking/reconciliations/{recon_id} | Abandon Reconciliation |
POST | /api/banking/reconciliations/{recon_id}/complete | Complete Reconciliation |
POST | /api/banking/reconciliations/{recon_id}/mark-all | Mark All Cleared |
GET | /api/banking/reconciliations/{recon_id}/pdf | Reconciliation Report Pdf |
GET | /api/banking/reconciliations/{recon_id}/print | Reconciliation Report Print |
GET | /api/banking/reconciliations/{recon_id}/report | Reconciliation Report |
POST | /api/banking/reconciliations/{recon_id}/toggle/{line_id} | Toggle Cleared |
GET | /api/banking/reconciliations/{recon_id}/transactions | Get Reconciliation Transactions |
POST | /api/banking/registers/{account_id}/lines/{line_id}/cleared | Set Register Cleared |
GET | /api/banking/transactions | List Bank Transactions |
POST | /api/banking/transactions | Create Bank Transaction |
POST | /api/banking/transactions/vendors | Statement Vendors |
PATCH | /api/banking/transactions/{txn_id} | Statement Set Category |
POST | /api/banking/transactions/{txn_id}/add | Statement Add |
GET | /api/banking/transactions/{txn_id}/candidates | Statement Candidates |
POST | /api/banking/transactions/{txn_id}/exclude | Statement Exclude |
POST | /api/banking/transactions/{txn_id}/match | Statement Match |
POST | /api/banking/transactions/{txn_id}/payout | Statement Payout |
POST | /api/banking/transactions/{txn_id}/restore | Statement Restore |
POST | /api/banking/transactions/{txn_id}/unmatch | Statement Unmatch |
| Method | Path | Summary |
|---|---|---|
POST | /api/mercury/connect | Connect |
POST | /api/mercury/disconnect | Disconnect |
POST | /api/mercury/map | Save Mapping |
POST | /api/mercury/refresh | Refresh |
GET | /api/mercury/status | Status |
POST | /api/mercury/sync | Sync |
POST | /api/mercury/webhook | Receive Webhook |
POST | /api/mercury/webhook-settings | Configure Webhook |
DELETE | /api/mercury/webhook-settings | Disable Webhook |
| Method | Path | Summary |
|---|---|---|
POST | /api/simplefin/claim | Claim |
POST | /api/simplefin/disconnect | Disconnect |
POST | /api/simplefin/map | Save Mapping |
GET | /api/simplefin/status | Status |
POST | /api/simplefin/sync | Sync |
| Method | Path | Summary |
|---|---|---|
GET | /api/transfers | List Transfers |
POST | /api/transfers | Create Transfer |
POST | /api/transfers/{transfer_id}/replace | Replace Transfer |
POST | /api/transfers/{transfer_id}/void | Void Transfer |
Jobs, classes and assets (82)
| Method | Path | Summary |
|---|---|---|
GET | /api/budgets | List Budgets |
POST | /api/budgets | Create Budget |
POST | /api/budgets/bulk | Bulk Upsert |
GET | /api/budgets/print | Print Budgets |
GET | /api/budgets/variance | Budget Variance |
GET | /api/budgets/variance/print | Print Budget Variance |
| Method | Path | Summary |
|---|---|---|
GET | /api/classes | List Classes |
POST | /api/classes | Create Class |
GET | /api/classes/activity | Classes Activity |
GET | /api/classes/{class_id} | Get Class |
PUT | /api/classes/{class_id} | Update Class |
DELETE | /api/classes/{class_id} | Delete Class |
GET | /api/classes/{class_id}/summary | Class Summary |
GET | /api/classes/{class_id}/transactions | Class Transactions |
| Method | Path | Summary |
|---|---|---|
GET | /api/cost-codes | List Cost Codes |
POST | /api/cost-codes | Create Cost Code |
POST | /api/cost-codes/import | Import Codes |
POST | /api/cost-codes/standard | Load Standard Cost Codes |
GET | /api/cost-codes/tree | Cost Code Tree |
PUT | /api/cost-codes/{code_id} | Update Cost Code |
DELETE | /api/cost-codes/{code_id} | Delete Cost Code |
| Method | Path | Summary |
|---|---|---|
GET | /api/cost-types | List Cost Types |
POST | /api/cost-types | Create Cost Type |
POST | /api/cost-types/setup-offsets | Setup Offset Accounts |
PUT | /api/cost-types/{type_id} | Update Cost Type |
DELETE | /api/cost-types/{type_id} | Delete Cost Type |
| Method | Path | Summary |
|---|---|---|
GET | /api/equipment | List Equipment |
POST | /api/equipment | Create Equipment |
PUT | /api/equipment/{eq_id} | Update Equipment |
DELETE | /api/equipment/{eq_id} | Delete Equipment |
| Method | Path | Summary |
|---|---|---|
GET | /api/fixed-assets | List Assets |
POST | /api/fixed-assets | Create Asset |
POST | /api/fixed-assets/import-csv | Import Csv |
GET | /api/fixed-assets/reports/reconciliation | Reconciliation |
POST | /api/fixed-assets/run-depreciation | Depreciation Run |
GET | /api/fixed-assets/types | List Types |
POST | /api/fixed-assets/types | Create Type |
PUT | /api/fixed-assets/types/{type_id} | Update Type |
GET | /api/fixed-assets/{asset_id} | Get Asset |
PUT | /api/fixed-assets/{asset_id} | Update Asset |
POST | /api/fixed-assets/{asset_id}/dispose | Dispose |
POST | /api/fixed-assets/{asset_id}/post-purchase | Post Purchase |
| Method | Path | Summary |
|---|---|---|
GET | /api/job-costs | List Job Costs |
POST | /api/job-costs | Create Job Cost |
POST | /api/job-costs/allocate | Allocate |
GET | /api/job-costs/{jc_id} | Get Job Cost |
POST | /api/job-costs/{jc_id}/void | Void |
| Method | Path | Summary |
|---|---|---|
GET | /api/jobs | List Jobs |
POST | /api/jobs | Create Job |
GET | /api/jobs/budget-vs-actual | Jobs Budget Vs Actual |
GET | /api/jobs/profitability | Jobs Profitability |
GET | /api/jobs/{job_id} | Get Job |
PUT | /api/jobs/{job_id} | Update Job |
DELETE | /api/jobs/{job_id} | Delete Job |
GET | /api/jobs/{job_id}/budgets | Get Job Budgets |
PUT | /api/jobs/{job_id}/budgets | Save Job Budgets |
POST | /api/jobs/{job_id}/budgets/from-estimate/{estimate_id} | Seed Budget From Estimate |
GET | /api/jobs/{job_id}/buyout | Get Buyout |
GET | /api/jobs/{job_id}/contract | Get Contract |
PUT | /api/jobs/{job_id}/contract | Set Contract |
POST | /api/jobs/{job_id}/contract/from-estimate/{estimate_id} | Contract From Estimate |
GET | /api/jobs/{job_id}/cost-to-complete-forecast | Get Cost To Complete Forecast |
PUT | /api/jobs/{job_id}/cost-to-complete-forecast | Save Cost To Complete Forecast |
GET | /api/jobs/{job_id}/cost-tree | Get Job Cost Tree |
GET | /api/jobs/{job_id}/cost-tree/csv | Get Job Cost Tree Csv |
GET | /api/jobs/{job_id}/cost-tree/pdf | Get Job Cost Tree Pdf |
GET | /api/jobs/{job_id}/deposits | List Deposits |
POST | /api/jobs/{job_id}/deposits | Create Deposit |
POST | /api/jobs/{job_id}/deposits/{deposit_id}/void | Void Deposit |
PUT | /api/jobs/{job_id}/sov | Save Sov |
GET | /api/jobs/{job_id}/transactions | Get Job Transactions |
| Method | Path | Summary |
|---|---|---|
GET | /api/time-entries | List Time Entries |
POST | /api/time-entries | Create Time Entry |
POST | /api/time-entries/classify | Classify Hours |
POST | /api/time-entries/post-to-job | Post Entries To Job |
GET | /api/time-entries/summary | Pay Period Summary |
PUT | /api/time-entries/{entry_id} | Update Time Entry |
DELETE | /api/time-entries/{entry_id} | Delete Time Entry |
POST | /api/time-entries/{entry_id}/approve | Approve Time Entry |
POST | /api/time-entries/{entry_id}/post-to-job | Post Entry To Job |
POST | /api/time-entries/{entry_id}/reject | Reject Time Entry |
POST | /api/time-entries/{entry_id}/submit | Submit Time Entry |
Construction (44)
| Method | Path | Summary |
|---|---|---|
GET | /api/change-orders | List Change Orders |
POST | /api/change-orders | Create Change Order |
POST | /api/change-orders/allowance-return | Return Unspent Allowance |
GET | /api/change-orders/{co_id} | Get Change Order |
PUT | /api/change-orders/{co_id} | Update Change Order |
DELETE | /api/change-orders/{co_id} | Delete Change Order |
POST | /api/change-orders/{co_id}/approve | Approve Change Order |
GET | /api/change-orders/{co_id}/pdf | Change Order Pdf |
POST | /api/change-orders/{co_id}/promote | Promote Change Order |
POST | /api/change-orders/{co_id}/reject | Reject Change Order |
POST | /api/change-orders/{co_id}/revise | Revise Pco |
POST | /api/change-orders/{co_id}/sub-order | Sub Order From Owner |
POST | /api/change-orders/{co_id}/submit | Submit Change Order |
POST | /api/change-orders/{co_id}/void | Void Change Order |
| Method | Path | Summary |
|---|---|---|
POST | /api/construction/setup | Setup |
| Method | Path | Summary |
|---|---|---|
GET | /api/field-tickets | List Field Tickets |
POST | /api/field-tickets | Create Field Ticket |
POST | /api/field-tickets/bill | Bill Field Tickets |
POST | /api/field-tickets/make-change-order | Make Change Order |
GET | /api/field-tickets/purchase-orders | Job Purchase Orders |
GET | /api/field-tickets/{ticket_id} | Get Field Ticket |
PUT | /api/field-tickets/{ticket_id} | Update Field Ticket |
DELETE | /api/field-tickets/{ticket_id} | Delete Field Ticket |
POST | /api/field-tickets/{ticket_id}/post | Post Material Slip |
POST | /api/field-tickets/{ticket_id}/sign | Sign Field Ticket |
POST | /api/field-tickets/{ticket_id}/void | Void Field Ticket |
| Method | Path | Summary |
|---|---|---|
GET | /api/lien-waivers | List Lien Waivers |
POST | /api/lien-waivers | Create Lien Waiver |
GET | /api/lien-waivers/{waiver_id}/pdf | Lien Waiver Pdf |
| Method | Path | Summary |
|---|---|---|
GET | /api/pay-applications | List Pay Applications |
POST | /api/pay-applications | Create Pay Application |
GET | /api/pay-applications/{app_id} | Get Pay Application |
PUT | /api/pay-applications/{app_id} | Update Pay Application |
DELETE | /api/pay-applications/{app_id} | Delete Pay Application |
POST | /api/pay-applications/{app_id}/approve | Approve Pay Application |
GET | /api/pay-applications/{app_id}/payments | Pay Application Payments |
GET | /api/pay-applications/{app_id}/pdf | Pay Application Pdf |
POST | /api/pay-applications/{app_id}/refresh-lines | Refresh Pay Application Lines |
POST | /api/pay-applications/{app_id}/submit | Submit Pay Application |
POST | /api/pay-applications/{app_id}/void | Void Pay Application |
| Method | Path | Summary |
|---|---|---|
GET | /api/trade-packages | List Trade Packages |
POST | /api/trade-packages | Create Trade Package |
PUT | /api/trade-packages/{package_id} | Update Trade Package |
DELETE | /api/trade-packages/{package_id} | Delete Trade Package |
Payroll and HR (administrators) (113)
| Method | Path | Summary |
|---|---|---|
GET | /api/benefits/codes | List Codes |
POST | /api/benefits/codes | Create Code |
POST | /api/benefits/codes/seed-standard | Seed Standard |
GET | /api/benefits/codes/{code_id} | Get Code |
PUT | /api/benefits/codes/{code_id} | Update Code |
DELETE | /api/benefits/codes/{code_id} | Deactivate Code |
GET | /api/benefits/codes/{code_id}/rates | List Rates |
POST | /api/benefits/codes/{code_id}/rates | Add Rate |
DELETE | /api/benefits/codes/{code_id}/rates/{rate_id} | Delete Rate |
GET | /api/benefits/employee/{emp_id}/resolved | Resolved For Employee |
GET | /api/benefits/enrollments | List Enrollments |
POST | /api/benefits/enrollments | Create Enrollment |
PUT | /api/benefits/enrollments/{enrollment_id} | Update Enrollment |
DELETE | /api/benefits/enrollments/{enrollment_id} | End Enrollment |
GET | /api/benefits/groups | List Groups |
POST | /api/benefits/groups | Create Group |
PUT | /api/benefits/groups/{group_id} | Update Group |
DELETE | /api/benefits/groups/{group_id} | Delete Group |
PUT | /api/benefits/groups/{group_id}/codes | Set Group Codes |
PUT | /api/benefits/groups/{group_id}/members | Set Group Members |
GET | /api/benefits/remittance | Remittance |
POST | /api/benefits/remittance/bill | Remittance Bill |
POST | /api/benefits/setup-accounts | Setup Accounts |
GET | /api/benefits/ytd | List Ytd |
POST | /api/benefits/ytd/rebuild | Rebuild Ytd |
| Method | Path | Summary |
|---|---|---|
GET | /api/deductions/garnishments | List Garnishments |
POST | /api/deductions/garnishments | Create Garnishment |
DELETE | /api/deductions/garnishments/{order_id} | Remove Garnishment |
POST | /api/deductions/garnishments/{order_id}/end | End Garnishment |
| Method | Path | Summary |
|---|---|---|
GET | /api/document-audits | List Audits |
GET | /api/document-audits/verify/{content_hash} | Verify Hash |
GET | /api/document-audits/{audit_id} | Get Audit |
GET | /api/document-audits/{audit_id}/check | Check Audit |
| Method | Path | Summary |
|---|---|---|
GET | /api/employees | List Employees |
POST | /api/employees | Create Employee |
GET | /api/employees/{emp_id} | Get Employee |
PUT | /api/employees/{emp_id} | Update Employee |
GET | /api/employees/{emp_id}/bank-accounts | List Bank Accounts |
POST | /api/employees/{emp_id}/bank-accounts | Add Bank Account |
DELETE | /api/employees/{emp_id}/bank-accounts/{ba_id} | Remove Bank Account |
GET | /api/employees/{emp_id}/documents | List Employee Documents |
POST | /api/employees/{emp_id}/documents | Upload Employee Document |
GET | /api/employees/{emp_id}/documents/{doc_id} | Download Employee Document |
DELETE | /api/employees/{emp_id}/documents/{doc_id} | Delete Employee Document |
GET | /api/employees/{emp_id}/everify | Get Everify |
PUT | /api/employees/{emp_id}/everify | Update Everify |
GET | /api/employees/{emp_id}/portal-access | List Portal Access |
GET | /api/employees/{emp_id}/portal-token | Get Portal Token |
POST | /api/employees/{emp_id}/portal-token | Regenerate Portal Token |
GET | /api/employees/{emp_id}/ytd | Get Employee Ytd |
| Method | Path | Summary |
|---|---|---|
GET | /api/employees/{emp_id}/opening-ytd | Get Opening Ytd |
PUT | /api/employees/{emp_id}/opening-ytd | Put Opening Ytd |
DELETE | /api/employees/{emp_id}/opening-ytd | Delete Opening Ytd |
GET | /api/payroll | List Pay Runs |
POST | /api/payroll | Create Pay Run |
POST | /api/payroll/forms/940/{year} | Generate Form 940 |
GET | /api/payroll/forms/940/{year}/pdf | Generate Form 940 Pdf |
POST | /api/payroll/forms/940/{year}/pdf | Generate Form 940 Pdf |
POST | /api/payroll/forms/941/{year}/{quarter} | Generate Form 941 |
GET | /api/payroll/forms/941/{year}/{quarter}/pdf | Generate Form 941 Pdf |
POST | /api/payroll/forms/941/{year}/{quarter}/pdf | Generate Form 941 Pdf |
POST | /api/payroll/forms/w2/{emp_id} | Generate W2 Form |
GET | /api/payroll/forms/w2/{emp_id}/pdf | Generate W2 Form Pdf |
POST | /api/payroll/forms/w2/{emp_id}/pdf | Generate W2 Form Pdf |
POST | /api/payroll/forms/w3/{year} | Generate W3 Form |
GET | /api/payroll/forms/w3/{year}/pdf | Generate W3 Form Pdf |
POST | /api/payroll/forms/w3/{year}/pdf | Generate W3 Form Pdf |
POST | /api/payroll/gross-up | Gross Up Paycheck |
GET | /api/payroll/opening-ytd | List Opening Ytd |
POST | /api/payroll/opening-ytd/import | Import Opening Ytd |
GET | /api/payroll/opening-ytd/template | Opening Ytd Template |
GET | /api/payroll/states | Payroll States |
GET | /api/payroll/{run_id} | Get Pay Run |
DELETE | /api/payroll/{run_id} | Discard Pay Run |
GET | /api/payroll/{run_id}/nacha | Download Nacha |
POST | /api/payroll/{run_id}/nacha | Export Nacha |
GET | /api/payroll/{run_id}/paystub/{stub_id} | Download Paystub |
POST | /api/payroll/{run_id}/process | Process Pay Run |
POST | /api/payroll/{run_id}/void | Void Pay Run |
| Method | Path | Summary |
|---|---|---|
POST | /api/onboarding/tasks | Create Task |
PUT | /api/onboarding/tasks/{task_id} | Update Task |
POST | /api/onboarding/tasks/{task_id}/complete | Complete Task |
GET | /api/onboarding/{emp_id} | Get Checklist |
GET | /api/onboarding/{emp_id}/new-hire-report | New Hire Report |
GET | /api/onboarding/{emp_id}/new-hire-report/pdf | New Hire Report Pdf |
POST | /api/onboarding/{emp_id}/seed | Seed Checklist |
| Method | Path | Summary |
|---|---|---|
GET | /api/pto/accruals | List Accruals |
POST | /api/pto/accruals | Create Accrual |
POST | /api/pto/accruals/year-end-carryover | Year End Carryover |
POST | /api/pto/accruals/{accrual_id}/accrue | Run Accrual |
POST | /api/pto/accruals/{accrual_id}/revalue | Revalue Accrual |
GET | /api/pto/policies | List Policies |
POST | /api/pto/policies | Create Policy |
GET | /api/pto/policies/{policy_id} | Get Policy |
PUT | /api/pto/policies/{policy_id} | Update Policy |
GET | /api/pto/requests | List Requests |
POST | /api/pto/requests | Create Request |
POST | /api/pto/requests/{request_id}/approve | Approve Request |
POST | /api/pto/requests/{request_id}/cancel | Cancel Request |
POST | /api/pto/requests/{request_id}/decision | Decide Request |
POST | /api/pto/requests/{request_id}/reject | Reject Request |
| Method | Path | Summary |
|---|---|---|
GET | /api/tax-forms/1096/pdf | Get 1096 Pdf |
GET | /api/tax-forms/1099 | Get 1099 |
GET | /api/tax-forms/1099/{vendor_id}/pdf | Get 1099 Pdf |
GET | /api/tax-forms/940 | Get 940 |
GET | /api/tax-forms/940/pdf | Get 940 Pdf |
GET | /api/tax-forms/941 | Get 941 |
GET | /api/tax-forms/941/pdf | Get 941 Pdf |
GET | /api/tax-forms/liability | Get Tax Liability |
GET | /api/tax-forms/sui | Get Sui |
GET | /api/tax-forms/w2 | Get All W2 |
GET | /api/tax-forms/w2/{employee_id} | Get W2 |
GET | /api/tax-forms/w2/{employee_id}/pdf | Get W2 Pdf |
Nonprofit (28)
| Method | Path | Summary |
|---|---|---|
POST | /api/donors/gifts/{kind}/{gift_id}/acknowledgment/email | Acknowledgment Email |
GET | /api/donors/gifts/{kind}/{gift_id}/acknowledgment/pdf | Acknowledgment Pdf |
GET | /api/donors/gifts/{kind}/{gift_id}/acknowledgment/preview | Acknowledgment Preview |
GET | /api/donors/giving-statement/preview | Giving Statement Preview |
POST | /api/donors/giving-statements/batch-email | Giving Statements Batch Email |
GET | /api/donors/giving-statements/pdf | Giving Statements Pdf |
GET | /api/donors/{customer_id}/giving-statement/pdf | Giving Statement Pdf |
| Method | Path | Summary |
|---|---|---|
GET | /api/in-kind-gifts | List In Kind Gifts |
POST | /api/in-kind-gifts | Create In Kind Gift |
GET | /api/in-kind-gifts/{gift_id} | Get In Kind Gift |
POST | /api/in-kind-gifts/{gift_id}/void | Void In Kind Gift Route |
| Method | Path | Summary |
|---|---|---|
GET | /api/nonprofit/allocation-rules | List Allocation Rules |
POST | /api/nonprofit/allocation-rules | Create Allocation Rule |
GET | /api/nonprofit/allocation-rules/{rule_id} | Get Allocation Rule |
PUT | /api/nonprofit/allocation-rules/{rule_id} | Update Allocation Rule |
DELETE | /api/nonprofit/allocation-rules/{rule_id} | Delete Allocation Rule |
GET | /api/nonprofit/allocation-rules/{rule_id}/preview | Preview Allocation |
GET | /api/nonprofit/allocation-rules/{rule_id}/split | Split By Rule |
GET | /api/nonprofit/allocations | List Allocations |
POST | /api/nonprofit/allocations | Create Allocation |
GET | /api/nonprofit/allocations/{fa_id} | Get Allocation |
POST | /api/nonprofit/allocations/{fa_id}/void | Void Allocation |
GET | /api/nonprofit/releases | List Releases |
POST | /api/nonprofit/releases | Create Release |
GET | /api/nonprofit/releases/suggest | Suggest Release |
GET | /api/nonprofit/releases/{rel_id} | Get Release |
POST | /api/nonprofit/releases/{rel_id}/void | Void Release Route |
POST | /api/nonprofit/setup-accounts | Setup Accounts |
Import and export (43)
| Method | Path | Summary |
|---|---|---|
GET | /api/csv/export/accounts | Csv Export Accounts |
GET | /api/csv/export/bills | Csv Export Bills |
GET | /api/csv/export/classes | Csv Export Classes |
GET | /api/csv/export/customers | Csv Export Customers |
GET | /api/csv/export/deposits | Csv Export Deposits |
GET | /api/csv/export/invoices | Csv Export Invoices |
GET | /api/csv/export/items | Csv Export Items |
GET | /api/csv/export/jobs | Csv Export Jobs |
GET | /api/csv/export/sales-receipts | Csv Export Sales Receipts |
GET | /api/csv/export/vendors | Csv Export Vendors |
POST | /api/csv/import/accounts | Csv Import Accounts |
POST | /api/csv/import/customers | Csv Import Customers |
POST | /api/csv/import/items | Csv Import Items |
POST | /api/csv/import/qb-report | Csv Import Qb Report |
POST | /api/csv/import/vendors | Csv Import Vendors |
| Method | Path | Summary |
|---|---|---|
GET | /api/fx/rate | Fx Rate |
| Method | Path | Summary |
|---|---|---|
GET | /api/iif/export/accounts | Export Accounts Iif |
GET | /api/iif/export/all | Export All Iif |
GET | /api/iif/export/bill-payments | Export Bill Payments Iif |
GET | /api/iif/export/bills | Export Bills Iif |
GET | /api/iif/export/classes | Export Classes Iif |
GET | /api/iif/export/customers | Export Customers Iif |
GET | /api/iif/export/deposits | Export Deposits Iif |
GET | /api/iif/export/estimates | Export Estimates Iif |
GET | /api/iif/export/invoices | Export Invoices Iif |
GET | /api/iif/export/items | Export Items Iif |
GET | /api/iif/export/journal-entries | Export Journal Entries Iif |
GET | /api/iif/export/payments | Export Payments Iif |
GET | /api/iif/export/register-entries | Export Register Entries Iif |
GET | /api/iif/export/sales-receipts | Export Sales Receipts Iif |
GET | /api/iif/export/transfers | Export Transfers Iif |
GET | /api/iif/export/vendors | Export Vendors Iif |
POST | /api/iif/import | Import Iif |
POST | /api/iif/validate | Validate Iif File |
| Method | Path | Summary |
|---|---|---|
GET | /api/migration/sources | List Sources |
POST | /api/migration/{source}/dry-run | Migration Dry Run |
POST | /api/migration/{source}/import | Migration Import |
| Method | Path | Summary |
|---|---|---|
DELETE | /api/ocr/intake/{intake_id} | Discard Intake |
POST | /api/ocr/intake/{intake_id}/attach | Attach Intake |
GET | /api/ocr/intake/{intake_id}/image | Intake Image |
POST | /api/ocr/intake/{intake_id}/region | Ocr Intake Region |
POST | /api/ocr/receipt | Scan Receipt |
GET | /api/ocr/status | Ocr Status |
Files (10)
| Method | Path | Summary |
|---|---|---|
GET | /api/attachments/download/{attachment_id} | Download Attachment |
DELETE | /api/attachments/{attachment_id} | Delete Attachment |
GET | /api/attachments/{entity_type}/{entity_id} | List Attachments |
POST | /api/attachments/{entity_type}/{entity_id} | Upload Attachment |
| Method | Path | Summary |
|---|---|---|
GET | /api/uploads/legacy | Legacy Folder |
DELETE | /api/uploads/legacy | Remove Legacy Folder |
GET | /api/uploads/logo | Logo Info |
POST | /api/uploads/logo | Upload Logo |
DELETE | /api/uploads/logo | Remove Logo |
GET | /api/uploads/logo/{file_id} | Logo Image |
Company, access and audit (49)
| Method | Path | Summary |
|---|---|---|
GET | /api/accountants-copy/changes | Changes |
POST | /api/accountants-copy/changes/apply | Apply |
POST | /api/accountants-copy/changes/preview | Preview |
GET | /api/accountants-copy/download/{copy_id} | Download |
POST | /api/accountants-copy/make | Make |
POST | /api/accountants-copy/open | Open Copy |
GET | /api/accountants-copy/status | Status |
| Method | Path | Summary |
|---|---|---|
GET | /api/audit | List Audit Logs |
GET | /api/audit/tables | List Audited Tables |
| Method | Path | Summary |
|---|---|---|
POST | /api/auth/company | Choose Company |
POST | /api/auth/login | Login |
POST | /api/auth/logout | Logout |
POST | /api/auth/password | Set Own Password |
GET | /api/auth/reset-at-computer | Reset At Computer Options |
POST | /api/auth/reset-at-computer | Reset At Computer |
POST | /api/auth/setup | Setup |
GET | /api/auth/status | Auth Status |
| Method | Path | Summary |
|---|---|---|
GET | /api/backups | List Backups |
POST | /api/backups | Make Backup |
GET | /api/backups/download/{filename} | Download Backup |
POST | /api/backups/restore | Restore |
| Method | Path | Summary |
|---|---|---|
GET | /api/companies | Get Companies |
POST | /api/companies | New Company |
POST | /api/companies/sample | New Sample Company |
| Method | Path | Summary |
|---|---|---|
GET | /api/company-file/encryption | Encryption Status |
POST | /api/company-file/encryption | Change Encryption |
POST | /api/company-file/encryption/recovery-key | New Recovery Key |
| Method | Path | Summary |
|---|---|---|
GET | /api/email-log | List Email Log |
| Method | Path | Summary |
|---|---|---|
GET | /api/preferences/{key} | Get Preference |
PUT | /api/preferences/{key} | Put Preference |
DELETE | /api/preferences/{key} | Delete Preference |
| Method | Path | Summary |
|---|---|---|
GET | /api/settings | Get Settings |
PUT | /api/settings | Update Settings |
GET | /api/settings/check-bank-details/{account_id} | Get Bank Check Details |
PUT | /api/settings/check-bank-details/{account_id} | Put Bank Check Details |
GET | /api/settings/payroll-accounts | Get Payroll Accounts |
POST | /api/settings/test-email | Test Email |
GET | /api/settings/unreadable-secrets | Get Unreadable Secrets |
| Method | Path | Summary |
|---|---|---|
GET | /api/support/diagnostics | Diagnostics |
POST | /api/support/reveal-log | Reveal Log |
| Method | Path | Summary |
|---|---|---|
GET | /api/system | System Info |
GET | /api/system/update-check | Update Check |
| Method | Path | Summary |
|---|---|---|
GET | /api/tokens | List Tokens |
POST | /api/tokens | Create Token |
PUT | /api/tokens/{token_id} | Update Token |
| Method | Path | Summary |
|---|---|---|
GET | /api/users | List Users |
POST | /api/users | Create User |
POST | /api/users/invite | Invite User |
PUT | /api/users/{user_id} | Update User |
Outside /api (24)
| Method | Path | Summary |
|---|---|---|
GET | / | Serve Index |
GET | /analytics | Serve Analytics Redirect |
GET | /health | Health Check |
| Method | Path | Summary |
|---|---|---|
GET | /pay/{token} | Public Payment Page |
| Method | Path | Summary |
|---|---|---|
GET | /portal/ | Portal Dashboard |
GET | /portal/bank | Portal Bank |
POST | /portal/bank | Portal Bank Add |
GET | /portal/favicon.ico | Portal Favicon |
GET | /portal/logo | Portal Logo |
POST | /portal/logout | Portal Logout |
GET | /portal/paystubs | Portal Paystubs |
GET | /portal/profile | Portal Profile |
POST | /portal/profile | Portal Profile Save |
GET | /portal/pto | Portal Pto |
POST | /portal/pto | Portal Pto Request |
POST | /portal/pto/{request_id}/withdraw | Portal Pto Withdraw |
GET | /portal/{token} | Portal Claim Dashboard |
GET | /portal/{token}/bank | Portal Claim Bank |
POST | /portal/{token}/bank | Portal Claim Bank Add |
GET | /portal/{token}/paystubs | Portal Claim Paystubs |
GET | /portal/{token}/profile | Portal Claim Profile |
POST | /portal/{token}/profile | Portal Claim Profile Save |
GET | /portal/{token}/pto | Portal Claim Pto |
POST | /portal/{token}/pto | Portal Claim Pto Request |