Evenbead docs
Contents

Reports

18 operations. All areas

GET/v1/reports/trial-balance

Trial balance as of a date

  • Operation getTrialBalance
  • Scope: read
  • Read
Parameters
  • as_of query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Trial balance (TrialBalance)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/transactions

Search posted journal entries

  • Operation searchTransactions
  • Scope: read
  • Read
Parameters
  • from query, string
  • to query, string
  • account query, string
  • text query, string
  • min_cents query, integer
  • max_cents query, integer
  • limit query, integer
Responses
  • 200 Entries (object)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/profit-and-loss

Profit and loss for a date range, by account; optionally one class; accrual (default) or cash basis

  • Operation getProfitAndLoss
  • Scope: read
  • Read
Parameters
  • from query, string, required
  • to query, string, required
  • class query, string
  • basis query, "accrual" | "cash"
  • format query, "json" | "csv"
Responses
  • 200 P&L (ProfitAndLoss)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/balance-sheet

Balance sheet as of a date, with current-year earnings and prior-year retained earnings rolled up

  • Operation getBalanceSheet
  • Scope: read
  • Read
Parameters
  • as_of query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Balance sheet (BalanceSheet)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/general-ledger

General ledger detail: every line in a date range by account, with opening, running and closing balances

  • Operation getGeneralLedger
  • Scope: read
  • Read
Parameters
  • from query, string, required
  • to query, string, required
  • account query, string
  • format query, "json" | "csv"
Responses
  • 200 General ledger (GeneralLedger)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/ar-aging

Accounts receivable aging as of a date: open documents by days past due (current, 1-30, 31-60, 61-90, 90+), with the control-account tie-out

  • Operation getArAging
  • Scope: read
  • Read
Parameters
  • as_of query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Aging (AgingReport)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/ap-aging

Accounts payable aging as of a date: open documents by days past due (current, 1-30, 31-60, 61-90, 90+), with the control-account tie-out

  • Operation getApAging
  • Scope: read
  • Read
Parameters
  • as_of query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Aging (AgingReport)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/sales-tax

Sales-tax liability for a period: taxable and non-taxable sales and tax by rate, jurisdiction, agency and month or quarter (accrual, by document date; voids reverse on their date), with what the payable accounts hold and the ledger tie-out. Filing is out of scope.

  • Operation getSalesTaxReport
  • Scope: read
  • Read
Parameters
  • from query, string, required
  • to query, string, required
  • group_by query, "month" | "quarter"
  • format query, "json" | "csv"
Responses
  • 200 Sales-tax liability (SalesTaxReport)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/accounts/{code}/register

An account's register: every line in a date range with the running balance (natural sign), the document, payment or entry behind it, the other side of the entry and whether it is reconciled

  • Operation getAccountRegister
  • Scope: read
  • Read
Parameters
  • code path, string, required
  • from query, string
  • to query, string
  • limit query, integer
  • format query, "json" | "csv"
Responses
  • 200 Register (AccountRegister)
  • Errors 400, 401, 403, 404, 429, 500 (Error: error.type, message)

GET/v1/search

Search these books: transactions by number, amount ($ or cents as dollars), memo, reference, line description or customer/vendor name; customers and vendors; products and services; accounts by code or name

  • Operation searchBooks
  • Scope: read
  • Read
Parameters
  • q query, string, required
  • limit query, integer
Responses
  • 200 Results by group (SearchResult)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/dashboard

Dashboard figures computed on the server: P&L this month and fiscal year to date, cash at the last 12 month-ends, AR and AP with what is overdue, and the bank accounts with unreconciled lines

  • Operation getDashboard
  • Scope: read
  • Read
Parameters
  • as_of query, string
Responses
  • 200 Dashboard (Dashboard)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/sales-by-customer

Sales by customer (income on invoices, sales receipts and credit memos, accrual), with what the P&L holds beyond them

  • Operation getSalesByCustomer
  • Scope: read
  • Read
Parameters
  • from query, string, required
  • to query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Sales by customer (SalesOrExpensesByParty)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/sales-by-item

Sales by product or service: quantity and amount on invoices and sales receipts less credit memos (no tax lines), by document date; voids subtract on their date

  • Operation getSalesByItem
  • Scope: read
  • Read
Parameters
  • from query, string, required
  • to query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Sales by item (SalesByItem)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/expenses-by-vendor

Expenses by vendor (cost of sales and expense accounts on bills, vendor credits, expenses and checks, accrual), with what the P&L holds beyond them

  • Operation getExpensesByVendor
  • Scope: read
  • Read
Parameters
  • from query, string, required
  • to query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Expenses by vendor (SalesOrExpensesByParty)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/ar-detail

Receivables detail as of a date: every open invoice, unapplied credit memo and customer payment by customer, with the control-account tie-out

  • Operation getArDetail
  • Scope: read
  • Read
Parameters
  • as_of query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Open documents (OpenDocuments)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/ap-detail

Payables detail as of a date: every open bill, unapplied vendor credit and prepayment by vendor, with the control-account tie-out

  • Operation getApDetail
  • Scope: read
  • Read
Parameters
  • as_of query, string, required
  • format query, "json" | "csv"
Responses
  • 200 Open documents (OpenDocuments)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/transaction-list

Every posted entry in a date range by date: document, payment or journal entry, contact, accounts and amount

  • Operation getTransactionList
  • Scope: read
  • Read
Parameters
  • from query, string, required
  • to query, string, required
  • limit query, integer
  • format query, "json" | "csv"
Responses
  • 200 Transactions (TransactionList)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)

GET/v1/reports/1099-summary

1099 summary for a calendar year: payments to vendors flagged for 1099s (bill payments, expenses and checks; card payments and refunds left out), whether each reaches the filing threshold and has a tax ID on file (last four digits only), and unflagged vendors to review. Filing is out of scope.

  • Operation get1099Summary
  • Scope: read
  • Read
Parameters
  • year query, integer, required
  • threshold_cents query, integer
  • format query, "json" | "csv"
Responses
  • 200 1099 summary (Summary1099)
  • Errors 400, 401, 403, 429, 500 (Error: error.type, message)