/
Documentation

API Reference

All endpoints available at https://api.syncbooksapp.com/api/addon/v1

Authentication

All requests require Authorization: Bearer <session_token>. The SDK handles this automatically.

Try it live

Use the API Playground to test endpoints interactively with your session token.

Context

GET/meCurrent org + user + scopes

Customers

GET/customersList (paginated, searchable)
GET/customers/:idGet single
POST/customersCreate
PUT/customers/:idUpdate
DELETE/customers/:idDelete

Invoices

GET/invoicesList (filter by status, customerId)
GET/invoices/:idGet single
GET/invoices/summaryCounts by status
POST/invoicesCreate
PUT/invoices/:idUpdate
DELETE/invoices/:idDelete

Products

GET/productsList (search, type, status)
GET/products/:idGet single
POST/productsCreate
PUT/products/:idUpdate
DELETE/products/:idDelete

Payments

GET/paymentsList
GET/payments/:idGet single
POST/paymentsCreate
PUT/payments/:idUpdate

Expenses

GET/expensesList
GET/expenses/:idGet single
GET/expenses/summaryTotals
POST/expensesCreate
PUT/expenses/:idUpdate
POST/expenses/:id/approveApprove

Vendors

GET/vendorsList
GET/vendors/:idGet single
POST/vendorsCreate
PUT/vendors/:idUpdate
DELETE/vendors/:idDelete

Bills

GET/billsList
GET/bills/:idGet single
POST/billsCreate
PUT/bills/:idUpdate
POST/bills/:id/approveApprove

Estimates

GET/estimatesList
GET/estimates/:idGet single
POST/estimatesCreate
PUT/estimates/:idUpdate
POST/estimates/:id/acceptAccept
POST/estimates/:id/declineDecline

Reports

GET/reports/summaryRevenue/expenses overview
GET/reports/trial-balanceAll accounts with balances
GET/reports/profit-lossIncome statement
GET/reports/balance-sheetFinancial position
GET/reports/cash-flowCash inflows/outflows
GET/reports/ar-agingReceivables aging
GET/reports/ap-agingPayables aging
GET/reports/tax-summaryVAT/tax summary

Bank Transactions

GET/bank-transactionsList (date filters)
GET/bank-transactions/:idGet single
POST/bank-transactionsCreate
POST/bank-transactions/:id/categorizeCategorize
POST/bank-transactions/:id/reconcileReconcile

Journal Entries

GET/journal-entriesList
GET/journal-entries/:idGet single
POST/journal-entriesCreate
PUT/journal-entries/:idUpdate (draft only)
POST/journal-entries/:id/postPost to GL
POST/journal-entries/:id/voidVoid

CRM

GET/crm/leadsList leads
GET/crm/leads/:idGet lead
POST/crm/leadsCreate lead
GET/crm/opportunitiesList opportunities
POST/crm/opportunitiesCreate opportunity
GET/crm/contactsList contacts

Search & Utility

GET/searchCross-resource search
GET/configGet addon config
PUT/configSave addon config
POST/notificationsSend notification
GET/notesGet notes for resource
POST/notesCreate note

Events & Webhooks

GET/events/catalogAll available events
GET/events/subscriptionsYour subscriptions
POST/events/subscribeSubscribe to event
POST/events/unsubscribeUnsubscribe
GET/webhooksList webhook endpoints
POST/webhooksRegister endpoint
POST/webhooks/:id/testTest delivery

This is a summary. Many more endpoints exist for Fleet, E-commerce, Subscriptions, Helpdesk, Rental, Repairs, Field Service, Fuel Station, Production, and POS. Use the API Playground for the complete interactive list.