Docs Developers

API reference

For SlowBooks Pro v2.31.14 · 835 operations

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.

RoleWhat a token with it may do
readonlyRead 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.
bookkeeperRead 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.
accountantRead 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.

StatusMeans
401No token, a wrong or revoked token, or a sign-in for another company.
403The role does not allow it, or the date is on or before the closing date.
404No such record.
405A DELETE on a posted document; the answer names its void route.
409A conflict: for example an Idempotency-Key sent again with a different body, or a schedule entered elsewhere first.
422A 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)

accounts
MethodPathSummary
GET/api/accountsList Accounts
POST/api/accountsCreate Account
GET/api/accounts/detail-typesList Detail Types
POST/api/accounts/rebuild-balancesRebuild Balances
GET/api/accounts/unused-seededUnused Seeded
POST/api/accounts/unused-seeded/removeRemove Unused Seeded
GET/api/accounts/{account_id}Get Account
PUT/api/accounts/{account_id}Update Account
DELETE/api/accounts/{account_id}Delete Account
analytics
MethodPathSummary
GET/api/analytics/ai-actionsList Ai Actions
POST/api/analytics/ai-actions/{action_key}Run Ai Action
GET/api/analytics/ai-configGet Ai Config
PUT/api/analytics/ai-configPut Ai Config
POST/api/analytics/ai-config/testTest Ai Config
POST/api/analytics/ai-insightsAi Insights
GET/api/analytics/ai-modelsGet Ai Models
POST/api/analytics/ai-modelsPost Ai Models
POST/api/analytics/ai-queryAi Query
GET/api/analytics/cash-flowGet Cash Flow
GET/api/analytics/dashboardGet Dashboard
GET/api/analytics/expensesGet Expenses
GET/api/analytics/export.csvExport Csv
GET/api/analytics/export.pdfExport Pdf
GET/api/analytics/profitabilityGet Profitability
GET/api/analytics/revenueGet Revenue
dashboard
MethodPathSummary
GET/api/dashboard/dataWidget Data
GET/api/dashboard/widgetsList Widgets
journal
MethodPathSummary
GET/api/journalList Journal Entries
POST/api/journalCreate Manual Journal Entry
GET/api/journal/{entry_id}Get Journal Entry
PUT/api/journal/{entry_id}Update Journal Entry
POST/api/journal/{entry_id}/voidVoid Journal Entry
opening_balances
MethodPathSummary
POST/api/opening-balancesCreate Opening Balances
GET/api/opening-balances/statusStatus
reclassify
MethodPathSummary
POST/api/reclassifyReclassify
GET/api/reclassify/linesLines
reports
MethodPathSummary
GET/api/reports/1099-summaryReport 1099 Summary
GET/api/reports/account-transactionsAccount Transactions
GET/api/reports/account-transactions/csvAccount Transactions Csv Route
GET/api/reports/account-transactions/pdfAccount Transactions Pdf Route
GET/api/reports/account-transactions/printAccount Transactions Pdf Route Print
GET/api/reports/accountants-packageAccountants Package
GET/api/reports/accountants-package/manifestAccountants Package Manifest
GET/api/reports/adjusting-entriesAdjusting Entries
GET/api/reports/adjusting-entries/csvAdjusting Entries Csv Route
GET/api/reports/adjusting-entries/pdfAdjusting Entries Pdf Route
GET/api/reports/adjusting-entries/printAdjusting Entries Pdf Route Print
GET/api/reports/ap-agingAp Aging
GET/api/reports/ap-aging/csvAp Aging Csv Route
GET/api/reports/ar-agingAr Aging
GET/api/reports/ar-aging/csvAr Aging Csv Route
GET/api/reports/balance-sheetBalance Sheet
GET/api/reports/balance-sheet/csvBalance Sheet Csv Route
GET/api/reports/balance-sheet/pdfBalance Sheet Pdf
GET/api/reports/balance-sheet/printBalance Sheet Pdf Print
POST/api/reports/batch-email-statementsBatch Email Statements
GET/api/reports/buyoutBuyout Route
GET/api/reports/buyout/csvBuyout Csv
GET/api/reports/buyout/pdfBuyout Pdf
GET/api/reports/buyout/printBuyout Pdf Print
GET/api/reports/cash-flowCash Flow
GET/api/reports/change-order-logChange Order Log Route
GET/api/reports/change-order-log/csvChange Order Log Csv
GET/api/reports/change-order-log/pdfChange Order Log Pdf
GET/api/reports/change-order-log/printChange Order Log Pdf Print
GET/api/reports/closing-date-exceptionsClosing Date Exceptions Route
GET/api/reports/closing-date-exceptions/csvClosing Date Exceptions Csv Route
GET/api/reports/closing-date-exceptions/pdfClosing Date Exceptions Pdf Route
GET/api/reports/closing-date-exceptions/printClosing Date Exceptions Pdf Route Print
POST/api/reports/collection-lettersCollection Letters
GET/api/reports/commitment-statusCommitment Status Route
GET/api/reports/commitment-status/csvCommitment Status Csv
GET/api/reports/commitment-status/pdfCommitment Status Pdf
GET/api/reports/commitment-status/printCommitment Status Pdf Print
GET/api/reports/complianceCompliance Route
GET/api/reports/compliance/csvCompliance Csv
GET/api/reports/compliance/pdfCompliance Pdf
GET/api/reports/compliance/printCompliance Pdf Print
GET/api/reports/cost-to-completeCost To Complete Route
GET/api/reports/cost-to-complete-forecastCost To Complete Forecast Route
GET/api/reports/cost-to-complete-forecast/csvCost To Complete Forecast Csv
GET/api/reports/cost-to-complete-forecast/pdfCost To Complete Forecast Pdf
GET/api/reports/cost-to-complete-forecast/printCost To Complete Forecast Pdf Print
GET/api/reports/cost-to-complete/csvCost To Complete Csv
GET/api/reports/cost-to-complete/pdfCost To Complete Pdf
GET/api/reports/cost-to-complete/printCost To Complete Pdf Print
GET/api/reports/customer-statement/{customer_id}/pdfCustomer Statement Pdf
GET/api/reports/customer-statement/{customer_id}/printCustomer Statement Pdf Print
GET/api/reports/field-ticket-logField Ticket Log Route
GET/api/reports/field-ticket-log/csvField Ticket Log Csv
GET/api/reports/field-ticket-log/pdfField Ticket Log Pdf
GET/api/reports/field-ticket-log/printField Ticket Log Pdf Print
GET/api/reports/financial-statements/pdfFinancial Statements Pdf
GET/api/reports/financial-statements/printFinancial Statements Pdf Print
GET/api/reports/first-dateFirst Date
GET/api/reports/functional-expensesFunctional Expenses
GET/api/reports/functional-expenses/csvFunctional Expenses Csv
GET/api/reports/functional-expenses/pdfFunctional Expenses Pdf
GET/api/reports/functional-expenses/printFunctional Expenses Pdf Print
GET/api/reports/fund-balancesFund Balances
GET/api/reports/fund-balances/csvFund Balances Csv
GET/api/reports/fund-balances/pdfFund Balances Pdf
GET/api/reports/fund-balances/printFund Balances Pdf Print
GET/api/reports/general-ledgerGeneral Ledger
GET/api/reports/general-ledger/csvGeneral Ledger Csv Route
GET/api/reports/general-ledger/pdfGeneral Ledger Pdf
GET/api/reports/general-ledger/printGeneral Ledger Pdf Print
GET/api/reports/income-by-customerIncome By Customer
GET/api/reports/job-budget-vs-actual/csvJob Budget Vs Actual Csv
GET/api/reports/job-budget-vs-actual/pdfJob Budget Vs Actual Pdf
GET/api/reports/job-budget-vs-actual/printJob Budget Vs Actual Pdf Print
GET/api/reports/job-cost-by-vendorJob Cost By Vendor Route
GET/api/reports/job-cost-by-vendor/csvJob Cost By Vendor Csv
GET/api/reports/job-cost-by-vendor/pdfJob Cost By Vendor Pdf
GET/api/reports/job-cost-by-vendor/printJob Cost By Vendor Pdf Print
GET/api/reports/job-profitabilityJob Profitability Report
GET/api/reports/job-profitability/csvJob Profitability Csv
GET/api/reports/job-profitability/pdfJob Profitability Pdf
GET/api/reports/job-profitability/printJob Profitability Pdf Print
GET/api/reports/pledgesPledges
GET/api/reports/pledges/csvPledges Csv
GET/api/reports/pledges/pdfPledges Pdf
GET/api/reports/pledges/printPledges Pdf Print
GET/api/reports/possible-duplicatesPossible Duplicates Route
GET/api/reports/possible-duplicates/csvPossible Duplicates Csv Route
POST/api/reports/possible-duplicates/dismissDismiss Possible Duplicate
DELETE/api/reports/possible-duplicates/dismissals/{dismissal_id}Restore Possible Duplicate
GET/api/reports/possible-duplicates/pdfPossible Duplicates Pdf Route
GET/api/reports/possible-duplicates/printPossible Duplicates Pdf Route Print
GET/api/reports/profit-lossProfit Loss
GET/api/reports/profit-loss-by-classProfit Loss By Class
GET/api/reports/profit-loss-by-class/csvProfit Loss By Class Csv Route
GET/api/reports/profit-loss-by-class/pdfProfit Loss By Class Pdf
GET/api/reports/profit-loss-by-class/printProfit Loss By Class Pdf Print
GET/api/reports/profit-loss-by-jobProfit Loss By Job
GET/api/reports/profit-loss-by-job/csvProfit Loss By Job Csv Route
GET/api/reports/profit-loss-by-job/pdfProfit Loss By Job Pdf
GET/api/reports/profit-loss-by-job/printProfit Loss By Job Pdf Print
GET/api/reports/profit-loss-detailProfit Loss Detail
GET/api/reports/profit-loss-detail/csvProfit Loss Detail Csv Route
GET/api/reports/profit-loss-detail/pdfProfit Loss Detail Pdf
GET/api/reports/profit-loss-detail/printProfit Loss Detail Pdf Print
GET/api/reports/profit-loss/csvProfit Loss Csv Route
GET/api/reports/profit-loss/pdfProfit Loss Pdf
GET/api/reports/profit-loss/printProfit Loss Pdf Print
GET/api/reports/purchases-by-itemPurchases By Item
GET/api/reports/purchases-by-item/csvPurchases By Item Csv Route
GET/api/reports/purchases-by-item/linesPurchases By Item Lines
GET/api/reports/purchases-by-item/pdfPurchases By Item Pdf
GET/api/reports/purchases-by-item/printPurchases By Item Pdf Print
GET/api/reports/retainageRetainage Route
GET/api/reports/retainage/csvRetainage Csv
GET/api/reports/retainage/pdfRetainage Pdf
GET/api/reports/retainage/printRetainage Pdf Print
GET/api/reports/sales-by-itemSales By Item
GET/api/reports/sales-by-item/csvSales By Item Csv Route
GET/api/reports/sales-by-item/linesSales By Item Lines
GET/api/reports/sales-by-item/pdfSales By Item Pdf
GET/api/reports/sales-by-item/printSales By Item Pdf Print
GET/api/reports/sales-taxSales Tax Report
POST/api/reports/sales-tax/payPay Sales Tax
GET/api/reports/statement-of-activitiesStatement Of Activities
GET/api/reports/statement-of-activities/csvStatement Of Activities Csv
GET/api/reports/statement-of-activities/pdfStatement Of Activities Pdf
GET/api/reports/statement-of-activities/printStatement Of Activities Pdf Print
GET/api/reports/statement-of-financial-positionStatement Of Financial Position
GET/api/reports/statement-of-financial-position/csvStatement Of Financial Position Csv
GET/api/reports/statement-of-financial-position/pdfStatement Of Financial Position Pdf
GET/api/reports/statement-of-financial-position/printStatement Of Financial Position Pdf Print
GET/api/reports/trial-balanceTrial Balance
GET/api/reports/trial-balance/csvTrial Balance Csv Route
GET/api/reports/trial-balance/pdfTrial Balance Pdf
GET/api/reports/trial-balance/printTrial Balance Pdf Print
GET/api/reports/wip-scheduleWip Schedule Route
GET/api/reports/wip-schedule/csvWip Schedule Csv
GET/api/reports/wip-schedule/pdfWip Schedule Pdf
POST/api/reports/wip-schedule/postWip Schedule Post
GET/api/reports/wip-schedule/printWip Schedule Pdf Print
POST/api/reports/wip-schedule/voidWip Schedule Void
saved-reports
MethodPathSummary
GET/api/saved-reportsList Saved Reports
POST/api/saved-reportsCreate 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
search
MethodPathSummary
GET/api/searchUnified Search

Sales (139)

batch_payments
MethodPathSummary
POST/api/batch-paymentsCreate Batch Payment
collections
MethodPathSummary
GET/api/collections/invoicesCollections Invoices
POST/api/collections/invoices/{invoice_id}/remindRemind Invoice
GET/api/collections/reminders/dueReminders Due
POST/api/collections/reminders/runReminders Run
POST/api/collections/reminders/run-if-dueReminders Run If Due
GET/api/collections/rulesList Rules
POST/api/collections/rulesCreate Rule
PUT/api/collections/rules/{rule_id}Update Rule
DELETE/api/collections/rules/{rule_id}Delete Rule
GET/api/collections/statements/dueStatements Due
POST/api/collections/statements/runStatements Run
credit_memos
MethodPathSummary
GET/api/credit-memosList Credit Memos
POST/api/credit-memosCreate Credit Memo
GET/api/credit-memos/{cm_id}Get Credit Memo
POST/api/credit-memos/{cm_id}/applyApply Credit
GET/api/credit-memos/{cm_id}/pdfCredit Memo Pdf
GET/api/credit-memos/{cm_id}/print-previewCredit Memo Print Preview
POST/api/credit-memos/{cm_id}/replaceReplace Credit Memo
POST/api/credit-memos/{cm_id}/voidVoid Credit Memo
customers
MethodPathSummary
GET/api/customersList Customers
POST/api/customersCreate Customer
GET/api/customers/check-duplicateCheck Duplicate
GET/api/customers/pastPast Customers
GET/api/customers/past.csvPast Customers Csv
GET/api/customers/past/labels.pdfPast 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}/creditsCustomer Credits
GET/api/customers/{customer_id}/subsCustomer Subs
deposits
MethodPathSummary
GET/api/depositsList Deposits
POST/api/depositsCreate Deposit
GET/api/deposits/pendingList Pending Deposits
GET/api/deposits/{deposit_id}Get Deposit
PUT/api/deposits/{deposit_id}Update Deposit
GET/api/deposits/{deposit_id}/pdfDeposit Pdf
GET/api/deposits/{deposit_id}/print-previewDeposit Print Preview
POST/api/deposits/{deposit_id}/voidVoid Deposit
email-templates
MethodPathSummary
GET/api/email-templatesList Templates
POST/api/email-templatesCreate Template
POST/api/email-templates/previewPreview Template
POST/api/email-templates/seed-defaultsSeed 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
estimates
MethodPathSummary
GET/api/estimatesList Estimates
POST/api/estimatesCreate Estimate
GET/api/estimates/{estimate_id}Get Estimate
PUT/api/estimates/{estimate_id}Update Estimate
POST/api/estimates/{estimate_id}/acceptAccept Estimate
POST/api/estimates/{estimate_id}/convertConvert To Invoice
POST/api/estimates/{estimate_id}/emailEmail Estimate
POST/api/estimates/{estimate_id}/lostMark Estimate Lost
GET/api/estimates/{estimate_id}/pdfEstimate Pdf
GET/api/estimates/{estimate_id}/print-previewEstimate Print Preview
invoice-messages
MethodPathSummary
GET/api/invoice-messagesList Messages
POST/api/invoice-messagesCreate Message
PUT/api/invoice-messages/{message_id}Update Message
DELETE/api/invoice-messages/{message_id}Delete Message
invoices
MethodPathSummary
GET/api/invoicesList Invoices
POST/api/invoicesCreate Invoice
POST/api/invoices/apply-late-feesApply Late Fees
POST/api/invoices/write-offsWrite Off Batch
GET/api/invoices/write-offs/candidatesWrite Off Candidates
GET/api/invoices/{invoice_id}Get Invoice
PUT/api/invoices/{invoice_id}Update Invoice
POST/api/invoices/{invoice_id}/duplicateDuplicate Invoice
POST/api/invoices/{invoice_id}/emailEmail Invoice
POST/api/invoices/{invoice_id}/email-previewEmail Invoice Preview
GET/api/invoices/{invoice_id}/pdfInvoice Pdf
GET/api/invoices/{invoice_id}/print-previewInvoice Print Preview
POST/api/invoices/{invoice_id}/sendMark Invoice Sent
POST/api/invoices/{invoice_id}/voidVoid Invoice
POST/api/invoices/{invoice_id}/write-offWrite Off Invoice
items
MethodPathSummary
GET/api/itemsList Items
POST/api/itemsCreate Item
GET/api/items/low-stockLow Stock Items
GET/api/items/valuationInventory 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}/adjustAdjust Inventory
GET/api/items/{item_id}/movementsList Item Movements
memorized
MethodPathSummary
GET/api/memorizedList Schedules
POST/api/memorizedCreate Memorized
GET/api/memorized/dueList Due
POST/api/memorized/enter-dueEnter Due
GET/api/memorized/entered-recentlyEntered 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}/enterEnter Now
POST/api/memorized/{mem_id}/pausePause Memorized
POST/api/memorized/{mem_id}/resumeResume Memorized
payment-terms
MethodPathSummary
GET/api/payment-termsList Terms
POST/api/payment-termsCreate Term
GET/api/payment-terms/datesTerms 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
payments
MethodPathSummary
GET/api/paymentsList Payments
POST/api/paymentsCreate 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}/applyApply Payment
POST/api/payments/{payment_id}/discountAdd Discount
POST/api/payments/{payment_id}/replaceReplace Payment
POST/api/payments/{payment_id}/voidVoid Payment
POST/api/payments/{provider_name}/check-status/{invoice_id}Check Status
POST/api/payments/{provider_name}/create-checkout-sessionCreate Checkout
POST/api/payments/{provider_name}/payoutRecord Payout
POST/api/payments/{provider_name}/webhookProvider Webhook
POST/api/stripe/webhookLegacy Stripe Webhook
recurring
MethodPathSummary
GET/api/recurringList Recurring
POST/api/recurringCreate Recurring
POST/api/recurring/generateGenerate 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}/generateGenerate One
reseller-permits
MethodPathSummary
GET/api/reseller-permitsList Permits
POST/api/reseller-permitsCreate Permit
GET/api/reseller-permits/expiringExpiring Permits
GET/api/reseller-permits/validate-formatValidate 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-verifiedMark Verified
sales-receipts
MethodPathSummary
GET/api/sales-receiptsList Sales Receipts
POST/api/sales-receiptsCreate Sales Receipt
tax
MethodPathSummary
GET/api/tax/mappingsList Mappings
POST/api/tax/mappingsCreate Mapping
GET/api/tax/returnEntity Return Report
GET/api/tax/return/csvEntity Return Csv
GET/api/tax/schedule-cSchedule C Report
GET/api/tax/schedule-c/csvSchedule C Csv

Purchases (52)

bill_payments
MethodPathSummary
GET/api/bill-paymentsList Bill Payments
POST/api/bill-paymentsCreate Bill Payment
GET/api/bill-payments/{bill_payment_id}Get Bill Payment
POST/api/bill-payments/{bill_payment_id}/discountAdd Discount
PUT/api/bill-payments/{bill_payment_id}/memoUpdate Bill Payment Memo
POST/api/bill-payments/{bill_payment_id}/replaceReplace Bill Payment
POST/api/bill-payments/{bill_payment_id}/voidVoid Bill Payment
bills
MethodPathSummary
GET/api/billsList Bills
POST/api/billsCreate Bill
GET/api/bills/{bill_id}Get Bill
PUT/api/bills/{bill_id}Update Bill
GET/api/bills/{bill_id}/pdfBill Pdf
GET/api/bills/{bill_id}/print-previewBill Print Preview
POST/api/bills/{bill_id}/voidVoid Bill
cc-charges
MethodPathSummary
GET/api/cc-chargesList Cc Charges
POST/api/cc-chargesCreate Cc Charge
POST/api/cc-charges/{charge_id}/replaceReplace Cc Charge
POST/api/cc-charges/{charge_id}/voidVoid Cc Charge
checks
MethodPathSummary
GET/api/checks/printPrint Check
POST/api/checks/print-batchPrint Check Batch
GET/api/checks/test-printTest Print Check
GET/api/checks/unprintedUnprinted Checks
expenses
MethodPathSummary
GET/api/expensesList Expenses
POST/api/expensesCreate Expense
GET/api/expenses/{expense_id}Get Expense
POST/api/expenses/{expense_id}/replaceReplace Expense
POST/api/expenses/{expense_id}/voidVoid Expense
purchase_orders
MethodPathSummary
GET/api/purchase-ordersList Pos
POST/api/purchase-ordersCreate 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-billConvert To Bill
GET/api/purchase-orders/{po_id}/pay-appCommitment Pay App
GET/api/purchase-orders/{po_id}/pdfPo Pdf
GET/api/purchase-orders/{po_id}/print-previewPo Print Preview
POST/api/purchase-orders/{po_id}/release-retainageRelease Retainage
vendor_credits
MethodPathSummary
GET/api/vendor-creditsList Vendor Credits
POST/api/vendor-creditsCreate Vendor Credit
GET/api/vendor-credits/{vc_id}Get Vendor Credit
POST/api/vendor-credits/{vc_id}/applyApply Vendor Credit
POST/api/vendor-credits/{vc_id}/replaceReplace Vendor Credit
POST/api/vendor-credits/{vc_id}/voidVoid Vendor Credit
vendors
MethodPathSummary
GET/api/vendorsList Vendors
POST/api/vendorsCreate Vendor
GET/api/vendors/check-duplicateCheck 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-entriesVendor Bank Entries
GET/api/vendors/{vendor_id}/payment-historyVendor Payment History Route
GET/api/vendors/{vendor_id}/payments/csvVendor Payments Csv
GET/api/vendors/{vendor_id}/summaryVendor Summary

Banking (66)

bank_import
MethodPathSummary
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/previewPreview Ofx
POST/api/bank-import/preview-csvPreview Csv
bank-rules
MethodPathSummary
GET/api/bank-rulesList Rules
POST/api/bank-rulesCreate Rule
POST/api/bank-rules/applyApply 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
banking
MethodPathSummary
GET/api/banking/accountsList Bank Accounts
POST/api/banking/accountsCreate 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-allFeed Add All
POST/api/banking/accounts/{account_id}/feed/auto-matchFeed Auto Match
POST/api/banking/accounts/{account_id}/feed/exclude-allFeed Exclude All
GET/api/banking/accounts/{account_id}/feed/excludedFeed Excluded
POST/api/banking/accounts/{account_id}/post-legacy-balancePost Legacy Balance
GET/api/banking/check-registerCheck 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}/voidVoid Bank Entry
GET/api/banking/ledger-balanceLedger Balance
GET/api/banking/overviewBanking Overview
GET/api/banking/reconciliationsList Reconciliations
POST/api/banking/reconciliationsCreate Reconciliation
PUT/api/banking/reconciliations/{recon_id}Update Reconciliation
DELETE/api/banking/reconciliations/{recon_id}Abandon Reconciliation
POST/api/banking/reconciliations/{recon_id}/completeComplete Reconciliation
POST/api/banking/reconciliations/{recon_id}/mark-allMark All Cleared
GET/api/banking/reconciliations/{recon_id}/pdfReconciliation Report Pdf
GET/api/banking/reconciliations/{recon_id}/printReconciliation Report Print
GET/api/banking/reconciliations/{recon_id}/reportReconciliation Report
POST/api/banking/reconciliations/{recon_id}/toggle/{line_id}Toggle Cleared
GET/api/banking/reconciliations/{recon_id}/transactionsGet Reconciliation Transactions
POST/api/banking/registers/{account_id}/lines/{line_id}/clearedSet Register Cleared
GET/api/banking/transactionsList Bank Transactions
POST/api/banking/transactionsCreate Bank Transaction
POST/api/banking/transactions/vendorsStatement Vendors
PATCH/api/banking/transactions/{txn_id}Statement Set Category
POST/api/banking/transactions/{txn_id}/addStatement Add
GET/api/banking/transactions/{txn_id}/candidatesStatement Candidates
POST/api/banking/transactions/{txn_id}/excludeStatement Exclude
POST/api/banking/transactions/{txn_id}/matchStatement Match
POST/api/banking/transactions/{txn_id}/payoutStatement Payout
POST/api/banking/transactions/{txn_id}/restoreStatement Restore
POST/api/banking/transactions/{txn_id}/unmatchStatement Unmatch
mercury
MethodPathSummary
POST/api/mercury/connectConnect
POST/api/mercury/disconnectDisconnect
POST/api/mercury/mapSave Mapping
POST/api/mercury/refreshRefresh
GET/api/mercury/statusStatus
POST/api/mercury/syncSync
POST/api/mercury/webhookReceive Webhook
POST/api/mercury/webhook-settingsConfigure Webhook
DELETE/api/mercury/webhook-settingsDisable Webhook
simplefin
MethodPathSummary
POST/api/simplefin/claimClaim
POST/api/simplefin/disconnectDisconnect
POST/api/simplefin/mapSave Mapping
GET/api/simplefin/statusStatus
POST/api/simplefin/syncSync
transfers
MethodPathSummary
GET/api/transfersList Transfers
POST/api/transfersCreate Transfer
POST/api/transfers/{transfer_id}/replaceReplace Transfer
POST/api/transfers/{transfer_id}/voidVoid Transfer

Jobs, classes and assets (82)

budgets
MethodPathSummary
GET/api/budgetsList Budgets
POST/api/budgetsCreate Budget
POST/api/budgets/bulkBulk Upsert
GET/api/budgets/printPrint Budgets
GET/api/budgets/varianceBudget Variance
GET/api/budgets/variance/printPrint Budget Variance
classes
MethodPathSummary
GET/api/classesList Classes
POST/api/classesCreate Class
GET/api/classes/activityClasses 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}/summaryClass Summary
GET/api/classes/{class_id}/transactionsClass Transactions
cost-codes
MethodPathSummary
GET/api/cost-codesList Cost Codes
POST/api/cost-codesCreate Cost Code
POST/api/cost-codes/importImport Codes
POST/api/cost-codes/standardLoad Standard Cost Codes
GET/api/cost-codes/treeCost Code Tree
PUT/api/cost-codes/{code_id}Update Cost Code
DELETE/api/cost-codes/{code_id}Delete Cost Code
cost-types
MethodPathSummary
GET/api/cost-typesList Cost Types
POST/api/cost-typesCreate Cost Type
POST/api/cost-types/setup-offsetsSetup Offset Accounts
PUT/api/cost-types/{type_id}Update Cost Type
DELETE/api/cost-types/{type_id}Delete Cost Type
equipment
MethodPathSummary
GET/api/equipmentList Equipment
POST/api/equipmentCreate Equipment
PUT/api/equipment/{eq_id}Update Equipment
DELETE/api/equipment/{eq_id}Delete Equipment
fixed_assets
MethodPathSummary
GET/api/fixed-assetsList Assets
POST/api/fixed-assetsCreate Asset
POST/api/fixed-assets/import-csvImport Csv
GET/api/fixed-assets/reports/reconciliationReconciliation
POST/api/fixed-assets/run-depreciationDepreciation Run
GET/api/fixed-assets/typesList Types
POST/api/fixed-assets/typesCreate 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}/disposeDispose
POST/api/fixed-assets/{asset_id}/post-purchasePost Purchase
job-costs
MethodPathSummary
GET/api/job-costsList Job Costs
POST/api/job-costsCreate Job Cost
POST/api/job-costs/allocateAllocate
GET/api/job-costs/{jc_id}Get Job Cost
POST/api/job-costs/{jc_id}/voidVoid
jobs
MethodPathSummary
GET/api/jobsList Jobs
POST/api/jobsCreate Job
GET/api/jobs/budget-vs-actualJobs Budget Vs Actual
GET/api/jobs/profitabilityJobs 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}/budgetsGet Job Budgets
PUT/api/jobs/{job_id}/budgetsSave Job Budgets
POST/api/jobs/{job_id}/budgets/from-estimate/{estimate_id}Seed Budget From Estimate
GET/api/jobs/{job_id}/buyoutGet Buyout
GET/api/jobs/{job_id}/contractGet Contract
PUT/api/jobs/{job_id}/contractSet Contract
POST/api/jobs/{job_id}/contract/from-estimate/{estimate_id}Contract From Estimate
GET/api/jobs/{job_id}/cost-to-complete-forecastGet Cost To Complete Forecast
PUT/api/jobs/{job_id}/cost-to-complete-forecastSave Cost To Complete Forecast
GET/api/jobs/{job_id}/cost-treeGet Job Cost Tree
GET/api/jobs/{job_id}/cost-tree/csvGet Job Cost Tree Csv
GET/api/jobs/{job_id}/cost-tree/pdfGet Job Cost Tree Pdf
GET/api/jobs/{job_id}/depositsList Deposits
POST/api/jobs/{job_id}/depositsCreate Deposit
POST/api/jobs/{job_id}/deposits/{deposit_id}/voidVoid Deposit
PUT/api/jobs/{job_id}/sovSave Sov
GET/api/jobs/{job_id}/transactionsGet Job Transactions
time-entries
MethodPathSummary
GET/api/time-entriesList Time Entries
POST/api/time-entriesCreate Time Entry
POST/api/time-entries/classifyClassify Hours
POST/api/time-entries/post-to-jobPost Entries To Job
GET/api/time-entries/summaryPay 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}/approveApprove Time Entry
POST/api/time-entries/{entry_id}/post-to-jobPost Entry To Job
POST/api/time-entries/{entry_id}/rejectReject Time Entry
POST/api/time-entries/{entry_id}/submitSubmit Time Entry

Construction (44)

change-orders
MethodPathSummary
GET/api/change-ordersList Change Orders
POST/api/change-ordersCreate Change Order
POST/api/change-orders/allowance-returnReturn 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}/approveApprove Change Order
GET/api/change-orders/{co_id}/pdfChange Order Pdf
POST/api/change-orders/{co_id}/promotePromote Change Order
POST/api/change-orders/{co_id}/rejectReject Change Order
POST/api/change-orders/{co_id}/reviseRevise Pco
POST/api/change-orders/{co_id}/sub-orderSub Order From Owner
POST/api/change-orders/{co_id}/submitSubmit Change Order
POST/api/change-orders/{co_id}/voidVoid Change Order
construction
MethodPathSummary
POST/api/construction/setupSetup
field-tickets
MethodPathSummary
GET/api/field-ticketsList Field Tickets
POST/api/field-ticketsCreate Field Ticket
POST/api/field-tickets/billBill Field Tickets
POST/api/field-tickets/make-change-orderMake Change Order
GET/api/field-tickets/purchase-ordersJob 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}/postPost Material Slip
POST/api/field-tickets/{ticket_id}/signSign Field Ticket
POST/api/field-tickets/{ticket_id}/voidVoid Field Ticket
lien-waivers
MethodPathSummary
GET/api/lien-waiversList Lien Waivers
POST/api/lien-waiversCreate Lien Waiver
GET/api/lien-waivers/{waiver_id}/pdfLien Waiver Pdf
pay-applications
MethodPathSummary
GET/api/pay-applicationsList Pay Applications
POST/api/pay-applicationsCreate 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}/approveApprove Pay Application
GET/api/pay-applications/{app_id}/paymentsPay Application Payments
GET/api/pay-applications/{app_id}/pdfPay Application Pdf
POST/api/pay-applications/{app_id}/refresh-linesRefresh Pay Application Lines
POST/api/pay-applications/{app_id}/submitSubmit Pay Application
POST/api/pay-applications/{app_id}/voidVoid Pay Application
trade-packages
MethodPathSummary
GET/api/trade-packagesList Trade Packages
POST/api/trade-packagesCreate 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)

benefits
MethodPathSummary
GET/api/benefits/codesList Codes
POST/api/benefits/codesCreate Code
POST/api/benefits/codes/seed-standardSeed 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}/ratesList Rates
POST/api/benefits/codes/{code_id}/ratesAdd Rate
DELETE/api/benefits/codes/{code_id}/rates/{rate_id}Delete Rate
GET/api/benefits/employee/{emp_id}/resolvedResolved For Employee
GET/api/benefits/enrollmentsList Enrollments
POST/api/benefits/enrollmentsCreate Enrollment
PUT/api/benefits/enrollments/{enrollment_id}Update Enrollment
DELETE/api/benefits/enrollments/{enrollment_id}End Enrollment
GET/api/benefits/groupsList Groups
POST/api/benefits/groupsCreate Group
PUT/api/benefits/groups/{group_id}Update Group
DELETE/api/benefits/groups/{group_id}Delete Group
PUT/api/benefits/groups/{group_id}/codesSet Group Codes
PUT/api/benefits/groups/{group_id}/membersSet Group Members
GET/api/benefits/remittanceRemittance
POST/api/benefits/remittance/billRemittance Bill
POST/api/benefits/setup-accountsSetup Accounts
GET/api/benefits/ytdList Ytd
POST/api/benefits/ytd/rebuildRebuild Ytd
deductions
MethodPathSummary
GET/api/deductions/garnishmentsList Garnishments
POST/api/deductions/garnishmentsCreate Garnishment
DELETE/api/deductions/garnishments/{order_id}Remove Garnishment
POST/api/deductions/garnishments/{order_id}/endEnd Garnishment
document-audit
MethodPathSummary
GET/api/document-auditsList Audits
GET/api/document-audits/verify/{content_hash}Verify Hash
GET/api/document-audits/{audit_id}Get Audit
GET/api/document-audits/{audit_id}/checkCheck Audit
employees
MethodPathSummary
GET/api/employeesList Employees
POST/api/employeesCreate Employee
GET/api/employees/{emp_id}Get Employee
PUT/api/employees/{emp_id}Update Employee
GET/api/employees/{emp_id}/bank-accountsList Bank Accounts
POST/api/employees/{emp_id}/bank-accountsAdd Bank Account
DELETE/api/employees/{emp_id}/bank-accounts/{ba_id}Remove Bank Account
GET/api/employees/{emp_id}/documentsList Employee Documents
POST/api/employees/{emp_id}/documentsUpload 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}/everifyGet Everify
PUT/api/employees/{emp_id}/everifyUpdate Everify
GET/api/employees/{emp_id}/portal-accessList Portal Access
GET/api/employees/{emp_id}/portal-tokenGet Portal Token
POST/api/employees/{emp_id}/portal-tokenRegenerate Portal Token
GET/api/employees/{emp_id}/ytdGet Employee Ytd
payroll
MethodPathSummary
GET/api/employees/{emp_id}/opening-ytdGet Opening Ytd
PUT/api/employees/{emp_id}/opening-ytdPut Opening Ytd
DELETE/api/employees/{emp_id}/opening-ytdDelete Opening Ytd
GET/api/payrollList Pay Runs
POST/api/payrollCreate Pay Run
POST/api/payroll/forms/940/{year}Generate Form 940
GET/api/payroll/forms/940/{year}/pdfGenerate Form 940 Pdf
POST/api/payroll/forms/940/{year}/pdfGenerate Form 940 Pdf
POST/api/payroll/forms/941/{year}/{quarter}Generate Form 941
GET/api/payroll/forms/941/{year}/{quarter}/pdfGenerate Form 941 Pdf
POST/api/payroll/forms/941/{year}/{quarter}/pdfGenerate Form 941 Pdf
POST/api/payroll/forms/w2/{emp_id}Generate W2 Form
GET/api/payroll/forms/w2/{emp_id}/pdfGenerate W2 Form Pdf
POST/api/payroll/forms/w2/{emp_id}/pdfGenerate W2 Form Pdf
POST/api/payroll/forms/w3/{year}Generate W3 Form
GET/api/payroll/forms/w3/{year}/pdfGenerate W3 Form Pdf
POST/api/payroll/forms/w3/{year}/pdfGenerate W3 Form Pdf
POST/api/payroll/gross-upGross Up Paycheck
GET/api/payroll/opening-ytdList Opening Ytd
POST/api/payroll/opening-ytd/importImport Opening Ytd
GET/api/payroll/opening-ytd/templateOpening Ytd Template
GET/api/payroll/statesPayroll States
GET/api/payroll/{run_id}Get Pay Run
DELETE/api/payroll/{run_id}Discard Pay Run
GET/api/payroll/{run_id}/nachaDownload Nacha
POST/api/payroll/{run_id}/nachaExport Nacha
GET/api/payroll/{run_id}/paystub/{stub_id}Download Paystub
POST/api/payroll/{run_id}/processProcess Pay Run
POST/api/payroll/{run_id}/voidVoid Pay Run
onboarding
MethodPathSummary
POST/api/onboarding/tasksCreate Task
PUT/api/onboarding/tasks/{task_id}Update Task
POST/api/onboarding/tasks/{task_id}/completeComplete Task
GET/api/onboarding/{emp_id}Get Checklist
GET/api/onboarding/{emp_id}/new-hire-reportNew Hire Report
GET/api/onboarding/{emp_id}/new-hire-report/pdfNew Hire Report Pdf
POST/api/onboarding/{emp_id}/seedSeed Checklist
pto
MethodPathSummary
GET/api/pto/accrualsList Accruals
POST/api/pto/accrualsCreate Accrual
POST/api/pto/accruals/year-end-carryoverYear End Carryover
POST/api/pto/accruals/{accrual_id}/accrueRun Accrual
POST/api/pto/accruals/{accrual_id}/revalueRevalue Accrual
GET/api/pto/policiesList Policies
POST/api/pto/policiesCreate Policy
GET/api/pto/policies/{policy_id}Get Policy
PUT/api/pto/policies/{policy_id}Update Policy
GET/api/pto/requestsList Requests
POST/api/pto/requestsCreate Request
POST/api/pto/requests/{request_id}/approveApprove Request
POST/api/pto/requests/{request_id}/cancelCancel Request
POST/api/pto/requests/{request_id}/decisionDecide Request
POST/api/pto/requests/{request_id}/rejectReject Request
tax-forms
MethodPathSummary
GET/api/tax-forms/1096/pdfGet 1096 Pdf
GET/api/tax-forms/1099Get 1099
GET/api/tax-forms/1099/{vendor_id}/pdfGet 1099 Pdf
GET/api/tax-forms/940Get 940
GET/api/tax-forms/940/pdfGet 940 Pdf
GET/api/tax-forms/941Get 941
GET/api/tax-forms/941/pdfGet 941 Pdf
GET/api/tax-forms/liabilityGet Tax Liability
GET/api/tax-forms/suiGet Sui
GET/api/tax-forms/w2Get All W2
GET/api/tax-forms/w2/{employee_id}Get W2
GET/api/tax-forms/w2/{employee_id}/pdfGet W2 Pdf

Nonprofit (28)

donors
MethodPathSummary
POST/api/donors/gifts/{kind}/{gift_id}/acknowledgment/emailAcknowledgment Email
GET/api/donors/gifts/{kind}/{gift_id}/acknowledgment/pdfAcknowledgment Pdf
GET/api/donors/gifts/{kind}/{gift_id}/acknowledgment/previewAcknowledgment Preview
GET/api/donors/giving-statement/previewGiving Statement Preview
POST/api/donors/giving-statements/batch-emailGiving Statements Batch Email
GET/api/donors/giving-statements/pdfGiving Statements Pdf
GET/api/donors/{customer_id}/giving-statement/pdfGiving Statement Pdf
in-kind-gifts
MethodPathSummary
GET/api/in-kind-giftsList In Kind Gifts
POST/api/in-kind-giftsCreate In Kind Gift
GET/api/in-kind-gifts/{gift_id}Get In Kind Gift
POST/api/in-kind-gifts/{gift_id}/voidVoid In Kind Gift Route
nonprofit
MethodPathSummary
GET/api/nonprofit/allocation-rulesList Allocation Rules
POST/api/nonprofit/allocation-rulesCreate 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}/previewPreview Allocation
GET/api/nonprofit/allocation-rules/{rule_id}/splitSplit By Rule
GET/api/nonprofit/allocationsList Allocations
POST/api/nonprofit/allocationsCreate Allocation
GET/api/nonprofit/allocations/{fa_id}Get Allocation
POST/api/nonprofit/allocations/{fa_id}/voidVoid Allocation
GET/api/nonprofit/releasesList Releases
POST/api/nonprofit/releasesCreate Release
GET/api/nonprofit/releases/suggestSuggest Release
GET/api/nonprofit/releases/{rel_id}Get Release
POST/api/nonprofit/releases/{rel_id}/voidVoid Release Route
POST/api/nonprofit/setup-accountsSetup Accounts

Import and export (43)

csv
MethodPathSummary
GET/api/csv/export/accountsCsv Export Accounts
GET/api/csv/export/billsCsv Export Bills
GET/api/csv/export/classesCsv Export Classes
GET/api/csv/export/customersCsv Export Customers
GET/api/csv/export/depositsCsv Export Deposits
GET/api/csv/export/invoicesCsv Export Invoices
GET/api/csv/export/itemsCsv Export Items
GET/api/csv/export/jobsCsv Export Jobs
GET/api/csv/export/sales-receiptsCsv Export Sales Receipts
GET/api/csv/export/vendorsCsv Export Vendors
POST/api/csv/import/accountsCsv Import Accounts
POST/api/csv/import/customersCsv Import Customers
POST/api/csv/import/itemsCsv Import Items
POST/api/csv/import/qb-reportCsv Import Qb Report
POST/api/csv/import/vendorsCsv Import Vendors
fx
MethodPathSummary
GET/api/fx/rateFx Rate
iif
MethodPathSummary
GET/api/iif/export/accountsExport Accounts Iif
GET/api/iif/export/allExport All Iif
GET/api/iif/export/bill-paymentsExport Bill Payments Iif
GET/api/iif/export/billsExport Bills Iif
GET/api/iif/export/classesExport Classes Iif
GET/api/iif/export/customersExport Customers Iif
GET/api/iif/export/depositsExport Deposits Iif
GET/api/iif/export/estimatesExport Estimates Iif
GET/api/iif/export/invoicesExport Invoices Iif
GET/api/iif/export/itemsExport Items Iif
GET/api/iif/export/journal-entriesExport Journal Entries Iif
GET/api/iif/export/paymentsExport Payments Iif
GET/api/iif/export/register-entriesExport Register Entries Iif
GET/api/iif/export/sales-receiptsExport Sales Receipts Iif
GET/api/iif/export/transfersExport Transfers Iif
GET/api/iif/export/vendorsExport Vendors Iif
POST/api/iif/importImport Iif
POST/api/iif/validateValidate Iif File
migration
MethodPathSummary
GET/api/migration/sourcesList Sources
POST/api/migration/{source}/dry-runMigration Dry Run
POST/api/migration/{source}/importMigration Import
ocr
MethodPathSummary
DELETE/api/ocr/intake/{intake_id}Discard Intake
POST/api/ocr/intake/{intake_id}/attachAttach Intake
GET/api/ocr/intake/{intake_id}/imageIntake Image
POST/api/ocr/intake/{intake_id}/regionOcr Intake Region
POST/api/ocr/receiptScan Receipt
GET/api/ocr/statusOcr Status

Files (10)

attachments
MethodPathSummary
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
uploads
MethodPathSummary
GET/api/uploads/legacyLegacy Folder
DELETE/api/uploads/legacyRemove Legacy Folder
GET/api/uploads/logoLogo Info
POST/api/uploads/logoUpload Logo
DELETE/api/uploads/logoRemove Logo
GET/api/uploads/logo/{file_id}Logo Image

Company, access and audit (49)

accountants-copy
MethodPathSummary
GET/api/accountants-copy/changesChanges
POST/api/accountants-copy/changes/applyApply
POST/api/accountants-copy/changes/previewPreview
GET/api/accountants-copy/download/{copy_id}Download
POST/api/accountants-copy/makeMake
POST/api/accountants-copy/openOpen Copy
GET/api/accountants-copy/statusStatus
audit
MethodPathSummary
GET/api/auditList Audit Logs
GET/api/audit/tablesList Audited Tables
auth
MethodPathSummary
POST/api/auth/companyChoose Company
POST/api/auth/loginLogin
POST/api/auth/logoutLogout
POST/api/auth/passwordSet Own Password
GET/api/auth/reset-at-computerReset At Computer Options
POST/api/auth/reset-at-computerReset At Computer
POST/api/auth/setupSetup
GET/api/auth/statusAuth Status
backups
MethodPathSummary
GET/api/backupsList Backups
POST/api/backupsMake Backup
GET/api/backups/download/{filename}Download Backup
POST/api/backups/restoreRestore
companies
MethodPathSummary
GET/api/companiesGet Companies
POST/api/companiesNew Company
POST/api/companies/sampleNew Sample Company
company-file
MethodPathSummary
GET/api/company-file/encryptionEncryption Status
POST/api/company-file/encryptionChange Encryption
POST/api/company-file/encryption/recovery-keyNew Recovery Key
email_log
MethodPathSummary
GET/api/email-logList Email Log
preferences
MethodPathSummary
GET/api/preferences/{key}Get Preference
PUT/api/preferences/{key}Put Preference
DELETE/api/preferences/{key}Delete Preference
settings
MethodPathSummary
GET/api/settingsGet Settings
PUT/api/settingsUpdate 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-accountsGet Payroll Accounts
POST/api/settings/test-emailTest Email
GET/api/settings/unreadable-secretsGet Unreadable Secrets
support
MethodPathSummary
GET/api/support/diagnosticsDiagnostics
POST/api/support/reveal-logReveal Log
system
MethodPathSummary
GET/api/systemSystem Info
GET/api/system/update-checkUpdate Check
api_tokens
MethodPathSummary
GET/api/tokensList Tokens
POST/api/tokensCreate Token
PUT/api/tokens/{token_id}Update Token
users
MethodPathSummary
GET/api/usersList Users
POST/api/usersCreate User
POST/api/users/inviteInvite User
PUT/api/users/{user_id}Update User

Outside /api (24)

untagged
MethodPathSummary
GET/Serve Index
GET/analyticsServe Analytics Redirect
GET/healthHealth Check
public
MethodPathSummary
GET/pay/{token}Public Payment Page
portal
MethodPathSummary
GET/portal/Portal Dashboard
GET/portal/bankPortal Bank
POST/portal/bankPortal Bank Add
GET/portal/favicon.icoPortal Favicon
GET/portal/logoPortal Logo
POST/portal/logoutPortal Logout
GET/portal/paystubsPortal Paystubs
GET/portal/profilePortal Profile
POST/portal/profilePortal Profile Save
GET/portal/ptoPortal Pto
POST/portal/ptoPortal Pto Request
POST/portal/pto/{request_id}/withdrawPortal Pto Withdraw
GET/portal/{token}Portal Claim Dashboard
GET/portal/{token}/bankPortal Claim Bank
POST/portal/{token}/bankPortal Claim Bank Add
GET/portal/{token}/paystubsPortal Claim Paystubs
GET/portal/{token}/profilePortal Claim Profile
POST/portal/{token}/profilePortal Claim Profile Save
GET/portal/{token}/ptoPortal Claim Pto
POST/portal/{token}/ptoPortal Claim Pto Request