Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Financial Management

Accounting

329 endpoints329 implementedAll modules →
  1. GET /rest/v1.0/companies/{company_id}/accounting/accountsList GL accounts
  2. POST /rest/v1.0/companies/{company_id}/accounting/accountsCreate a GL account
  3. GET /rest/v1.0/companies/{company_id}/accounting/accounts/{id}Show a GL account
  4. PATCH /rest/v1.0/companies/{company_id}/accounting/accounts/{id}Update a GL account
  5. POST /rest/v1.0/companies/{company_id}/accounting/accounts/apply_templateApply the construction chart of accounts
  6. GET /rest/v1.0/companies/{company_id}/accounting/accounts/treeChart of accounts tree
  7. GET /rest/v1.0/companies/{company_id}/accounting/ach/monitoringACH fraud-monitoring evidence
  8. GET /rest/v1.0/companies/{company_id}/accounting/ach/noticesACH returns and NOCs
  9. POST /rest/v1.0/companies/{company_id}/accounting/ach/noticesImport an ACH return/NOC file
  10. POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/{id}/resolveResolve a manual NOC
  11. POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/apply_nocsApply NOCs
  12. POST /rest/v1.0/companies/{company_id}/accounting/ach/prenotesGenerate a prenote file
  13. POST /rest/v1.0/companies/{company_id}/accounting/allocation_runsPost an allocation run
  14. POST /rest/v1.0/companies/{company_id}/accounting/allocation_runs/{id}/reverseReverse an allocation run
  15. GET /rest/v1.0/companies/{company_id}/accounting/ap/agingAP aging as of a date
  16. GET /rest/v1.0/companies/{company_id}/accounting/ap/backup_noticesList CP2100 B notices
  17. POST /rest/v1.0/companies/{company_id}/accounting/ap/backup_noticesRecord a CP2100 B notice
  18. PATCH /rest/v1.0/companies/{company_id}/accounting/ap/backup_notices/{id}Mark a B notice letter sent or record the cure
  19. GET /rest/v1.0/companies/{company_id}/accounting/ap/backup_notices/{id}/letterB notice letter
  20. GET /rest/v1.0/companies/{company_id}/accounting/ap/billsList bills and vendor credits
  21. POST /rest/v1.0/companies/{company_id}/accounting/ap/billsCreate a draft bill or vendor credit
  22. GET /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}Show a bill
  23. PATCH /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}Edit a draft or pending bill
  24. DELETE /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}Delete a draft bill
  25. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/apply_creditApply a vendor credit to a bill
  26. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/approveApprove a bill
  27. GET /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/attachmentsList attachments on a bill
  28. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/attachmentsAttach a file to a bill
  29. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/override_holdOverride a hold
  30. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/rejectReject a bill (return to the preparer)
  31. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/release_retainageRelease retainage payable
  32. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/submitSubmit a bill for approval
  33. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/unapply_creditUndo a vendor credit application
  34. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/voidVoid a posted bill
  35. POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/from_sourceDraft a bill from a requisition or direct cost
  36. POST /rest/v1.0/companies/{company_id}/accounting/ap/checks/{id}/reprintReprint a check under a new number
  37. GET /rest/v1.0/companies/{company_id}/accounting/ap/compliance_requirementsList compliance requirements
  38. POST /rest/v1.0/companies/{company_id}/accounting/ap/compliance_requirementsRequire a compliance document
  39. DELETE /rest/v1.0/companies/{company_id}/accounting/ap/compliance_requirements/{id}Drop a compliance requirement
  40. GET /rest/v1.0/companies/{company_id}/accounting/ap/form_10991099 review
  41. POST /rest/v1.0/companies/{company_id}/accounting/ap/form_1099/irisExport 1099s as IRIS Taxpayer Portal CSV files
  42. POST /rest/v1.0/companies/{company_id}/accounting/ap/form_1099/pub1220Export 1099s as an IRS Pub 1220 file
  43. GET /rest/v1.0/companies/{company_id}/accounting/ap/form_945Form 945 data
  44. POST /rest/v1.0/companies/{company_id}/accounting/ap/form_945/eftpsEFTPS 945 deposits
  45. GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runsList payment runs
  46. POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runsCreate a draft payment run
  47. GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}Show a payment run
  48. DELETE /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}Delete a draft run
  49. GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/checksCheck print data
  50. GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/nachaACH (NACHA) file
  51. POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/nachaRe-send the ACH (NACHA) file
  52. GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/positive_payPositive pay file (CSV)
  53. POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/rejectReject a payment run release
  54. POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/releaseRelease (approve) and post a payment run
  55. GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_selectionPayment selection
  56. GET /rest/v1.0/companies/{company_id}/accounting/ap/paymentsList payments
  57. POST /rest/v1.0/companies/{company_id}/accounting/ap/paymentsCreate one manual payment
  58. GET /rest/v1.0/companies/{company_id}/accounting/ap/payments/{id}Show a payment
  59. POST /rest/v1.0/companies/{company_id}/accounting/ap/payments/{id}/voidVoid a payment
  60. GET /rest/v1.0/companies/{company_id}/accounting/ap/receiptsList PO receipts
  61. POST /rest/v1.0/companies/{company_id}/accounting/ap/receiptsReceive against a purchase order
  62. POST /rest/v1.0/companies/{company_id}/accounting/ap/receipts/{id}/voidVoid a PO receipt
  63. POST /rest/v1.0/companies/{company_id}/accounting/ap/retainage_releases/{id}/voidVoid a retainage release
  64. GET /rest/v1.0/companies/{company_id}/accounting/ap/settingsAP settings
  65. PATCH /rest/v1.0/companies/{company_id}/accounting/ap/settingsUpdate AP settings
  66. GET /rest/v1.0/companies/{company_id}/accounting/ap/tie_outAP subledger tie-out
  67. POST /rest/v1.0/companies/{company_id}/accounting/ap/tin_matching/exportExport an IRS bulk TIN Matching request file
  68. POST /rest/v1.0/companies/{company_id}/accounting/ap/tin_matching/importImport IRS bulk TIN Matching results
  69. GET /rest/v1.0/companies/{company_id}/accounting/ap/vendorsList AP vendors
  70. GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}Show an AP vendor
  71. GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/attachmentsList attachments on a vendor
  72. POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/attachmentsAttach a file to a vendor
  73. POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/complianceRecord a compliance document
  74. PATCH /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/compliance/{compliance_id}Lift or reinstate a compliance record
  75. GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/compliance/{compliance_id}/attachmentsList attachments on a vendor compliance record (COI, W-9, license)
  76. POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/compliance/{compliance_id}/attachmentsAttach a file to a vendor compliance record (COI, W-9, license)
  77. POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/lien_waiversRecord a lien waiver received
  78. GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/lien_waivers/{waiver_id}/attachmentsList attachments on a lien waiver
  79. POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/lien_waivers/{waiver_id}/attachmentsAttach a file to a lien waiver
  80. GET /rest/v1.0/companies/{company_id}/accounting/approval_delegationsList approval delegations
  81. POST /rest/v1.0/companies/{company_id}/accounting/approval_delegationsCreate an approval delegation
  82. DELETE /rest/v1.0/companies/{company_id}/accounting/approval_delegations/{id}Revoke an approval delegation
  83. GET /rest/v1.0/companies/{company_id}/accounting/approval_rulesList approval rules
  84. POST /rest/v1.0/companies/{company_id}/accounting/approval_rulesCreate an approval rule
  85. DELETE /rest/v1.0/companies/{company_id}/accounting/approval_rules/{id}Deactivate an approval rule
  86. GET /rest/v1.0/companies/{company_id}/accounting/approvals/inboxApprovals inbox
  87. GET /rest/v1.0/companies/{company_id}/accounting/approvals/self_approvedSelf-approved documents
  88. GET /rest/v1.0/companies/{company_id}/accounting/ar/customersList AR customers
  89. GET /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}Customer open balances net of posted receipts and reversals; paginated invoice history
  90. GET /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}/collection_notesLatest 100 collection notes for the customer in permitted entities.
  91. POST /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}/collection_notesAdd a collection note (optional invoice and promise to pay). arEnter.
  92. GET /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}/statementCustomer statement: open posted invoices, unapplied cash and balance due, with the billing contact.
  93. POST /rest/v1.0/companies/{company_id}/accounting/ar/depositsDeposit posted receipts held in UNDEPOSITED_FUNDS to a bank account as one journal (Dr bank / Cr undeposited funds). arApprove; idempotent by request_key.
  94. GET /rest/v1.0/companies/{company_id}/accounting/ar/invoicesList scoped invoices (default 100, maximum 100 per page)
  95. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoicesCreate a draft; a retry with the same request key and payload returns the original invoice
  96. GET /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}Get scoped invoice
  97. PATCH /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}Replace current draft revision; all editors are excluded from approval
  98. GET /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/attachmentsList attachments on a AR invoice
  99. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/attachmentsAttach a file to a AR invoice
  100. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/disputeFlag or clear a collections dispute on a posted invoice. Disputed invoices age in the Disputed column. arEnter.
  101. GET /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/pdfInvoice PDF
  102. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/reverseAppend a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.
  103. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/sendSend an invoice to the billing contact
  104. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/transitionSubmit, return to draft, independently approve, or post an invoice
  105. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/from_billingDraft an AR invoice from a non-progress billing
  106. POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/from_payment_applicationBill a certified owner pay app in AR (once per pay app)
  107. GET /rest/v1.0/companies/{company_id}/accounting/ar/payment_applications/{id}/pdfG702/G703 PDF of a certified owner pay app
  108. PUT /rest/v1.0/companies/{company_id}/accounting/ar/prime_contracts/{id}/billing_methodSet a prime contract's billing method
  109. GET /rest/v1.0/companies/{company_id}/accounting/ar/prime_contracts/{id}/closeoutGet a prime contract's closeout documents
  110. PUT /rest/v1.0/companies/{company_id}/accounting/ar/prime_contracts/{id}/closeoutSet a prime contract's closeout documents
  111. GET /rest/v1.0/companies/{company_id}/accounting/ar/receiptsReceipt history, 50 per page
  112. POST /rest/v1.0/companies/{company_id}/accounting/ar/receiptsRecord a fully allocated draft; matching request-key retries return the original receipt
  113. GET /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}Receipt detail and immutable applications
  114. POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/applicationsApply a posted receipt's unapplied cash to open invoice lines, or transfer its allocations between lines. arApprove; idempotent by request_key.
  115. GET /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/attachmentsList attachments on a AR receipt
  116. POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/attachmentsAttach a file to a AR receipt
  117. POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/reverseAppend a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.
  118. POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/transitionIndependently approve or post; balances are revalidated under the company lock
  119. GET /rest/v1.0/companies/{company_id}/accounting/ar/receipts/open_itemsOpen original AR distributions for one customer/entity; pages over open invoices only, oldest due first
  120. GET /rest/v1.0/companies/{company_id}/accounting/assetsList fixed assets
  121. POST /rest/v1.0/companies/{company_id}/accounting/assetsAdd a fixed asset
  122. GET /rest/v1.0/companies/{company_id}/accounting/assets/{id}Show a fixed asset
  123. PATCH /rest/v1.0/companies/{company_id}/accounting/assets/{id}Update a fixed asset
  124. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/adjustmentsPost an asset adjustment
  125. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/disposeDispose of a fixed asset
  126. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/meter_readingsRecord a UOP meter reading
  127. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/undo_disposalUndo a disposal
  128. POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/voidVoid an asset added in error
  129. POST /rest/v1.0/companies/{company_id}/accounting/assets/capitalizeCapitalize an AP bill line
  130. GET /rest/v1.0/companies/{company_id}/accounting/assets/classesList asset classes
  131. POST /rest/v1.0/companies/{company_id}/accounting/assets/classesAdd an asset class
  132. GET /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsList depreciation runs
  133. POST /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runsPreview or post a depreciation run
  134. GET /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}Show a depreciation run
  135. POST /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}/reverseReverse a depreciation run
  136. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_logsPost approved equipment logs
  137. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesList equipment internal rates
  138. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_ratesAdd an equipment internal rate
  139. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_recoveryEquipment recovery vs cost
  140. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesList equipment usage charges
  141. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usagesCharge equipment usage to a job
  142. POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages/{id}/voidVoid equipment usage
  143. GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_utilizationEquipment utilization
  144. POST /rest/v1.0/companies/{company_id}/accounting/assets/importImport the fixed asset register
  145. GET /rest/v1.0/companies/{company_id}/accounting/attachments/{id}Download an attachment
  146. GET /rest/v1.0/companies/{company_id}/accounting/banking/accountsList bank and card accounts
  147. POST /rest/v1.0/companies/{company_id}/accounting/banking/accountsCreate a bank account
  148. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}Show a bank account
  149. PATCH /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}Update a bank account
  150. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/bank_changeApprove or reject a pending bank number change
  151. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inboxMatching inbox
  152. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inbox/accept_highAccept all High matches
  153. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/outstandingOutstanding items
  154. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_payGenerate a positive pay file
  155. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batchesList positive pay batches
  156. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batches/{batch_id}/regenerateRegenerate a positive pay batch
  157. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliationsList reconciliations
  158. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliationsStart a reconciliation
  159. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/registerAccount register
  160. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/revealReveal bank numbers
  161. GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_importsList statement imports
  162. POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_importsImport a statement
  163. GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_forecastCash forecast
  164. GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_positionCash position
  165. GET /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}Show a reconciliation
  166. PATCH /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}Tick lines / change the statement balance
  167. DELETE /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}Cancel an in-progress reconciliation
  168. POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/finishFinish a reconciliation
  169. POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/reviewReview a finished reconciliation
  170. POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/undoUndo a reconciliation
  171. GET /rest/v1.0/companies/{company_id}/accounting/banking/rulesList bank rules
  172. POST /rest/v1.0/companies/{company_id}/accounting/banking/rulesCreate a bank rule
  173. PATCH /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}Update a bank rule
  174. DELETE /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}Delete a bank rule
  175. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/create_transactionCreate from a statement line
  176. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/ignoreIgnore a statement line
  177. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/matchMatch a statement line
  178. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/restoreRestore an ignored statement line
  179. POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/unmatchUnmatch a statement line
  180. GET /rest/v1.0/companies/{company_id}/accounting/banking/transactionsList cash documents
  181. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactionsRecord and post a cash document
  182. GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}Show a cash document
  183. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/approveRelease or approve a pending cash document
  184. GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/attachmentsList attachments on a bank transaction
  185. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/attachmentsAttach a file to a bank transaction
  186. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/check_printCheck print data
  187. POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/voidVoid a cash document
  188. GET /rest/v1.0/companies/{company_id}/accounting/budgetsList GL budgets
  189. POST /rest/v1.0/companies/{company_id}/accounting/budgetsImport a GL budget from CSV
  190. GET /rest/v1.0/companies/{company_id}/accounting/budgets/{id}Show a GL budget with its lines
  191. DELETE /rest/v1.0/companies/{company_id}/accounting/budgets/{id}Delete a GL budget version
  192. POST /rest/v1.0/companies/{company_id}/accounting/cecl_allowancePost the CECL allowance adjustment
  193. POST /rest/v1.0/companies/{company_id}/accounting/current_portion_reclassPost the current-portion reclass
  194. GET /rest/v1.0/companies/{company_id}/accounting/debt_schedulesList debt and lease schedules
  195. POST /rest/v1.0/companies/{company_id}/accounting/debt_schedulesCreate a debt or lease schedule
  196. DELETE /rest/v1.0/companies/{company_id}/accounting/debt_schedules/{id}Deactivate a debt or lease schedule
  197. GET /rest/v1.0/companies/{company_id}/accounting/entitiesList legal entities
  198. POST /rest/v1.0/companies/{company_id}/accounting/entitiesCreate a legal entity
  199. GET /rest/v1.0/companies/{company_id}/accounting/entities/{id}Show a legal entity
  200. PATCH /rest/v1.0/companies/{company_id}/accounting/entities/{id}Update a legal entity
  201. POST /rest/v1.0/companies/{company_id}/accounting/fiscal_yearsGenerate a fiscal year
  202. POST /rest/v1.0/companies/{company_id}/accounting/fiscal_years/{id}/year_end_closePost the year-end close
  203. POST /rest/v1.0/companies/{company_id}/accounting/fiscal_years/{id}/year_end_close/reverseReverse the year-end close
  204. GET /rest/v1.0/companies/{company_id}/accounting/general_ledgerGeneral ledger detail
  205. GET /rest/v1.0/companies/{company_id}/accounting/grantsList accounting access
  206. PATCH /rest/v1.0/companies/{company_id}/accounting/grants/{id}Set a member's accounting access
  207. GET /rest/v1.0/companies/{company_id}/accounting/integrations/connectionsList ERP connections with health and recent sync runs
  208. POST /rest/v1.0/companies/{company_id}/accounting/integrations/connectionsCreate an ERP connection (manageIntegrations)
  209. POST /rest/v1.0/companies/{company_id}/accounting/integrations/connections/{id}/syncQueue a sync pull (live API connections); it stages coa, vendors and open_ap import runs
  210. GET /rest/v1.0/companies/{company_id}/accounting/integrations/exports/journalsExport posted journals as an ERP import file
  211. GET /rest/v1.0/companies/{company_id}/accounting/integrations/importsList imports
  212. POST /rest/v1.0/companies/{company_id}/accounting/integrations/importsUpload CSV and persist validation preview
  213. GET /rest/v1.0/companies/{company_id}/accounting/integrations/imports/{id}Read preview, results and history
  214. POST /rest/v1.0/companies/{company_id}/accounting/integrations/imports/{id}Map, reconcile, approve/apply or reverse an imported entry
  215. GET /rest/v1.0/companies/{company_id}/accounting/integrations/inboxIntegration error inbox: sync run errors and blocked or failed import runs
  216. GET /rest/v1.0/companies/{company_id}/accounting/integrations/sync_runs/{id}Get a sync run
  217. GET /rest/v1.0/companies/{company_id}/accounting/job_cost_entriesList job cost entries
  218. GET /rest/v1.0/companies/{company_id}/accounting/job_tax_profiles/{id}Get a job tax profile
  219. PUT /rest/v1.0/companies/{company_id}/accounting/job_tax_profiles/{id}Set a job tax profile
  220. GET /rest/v1.0/companies/{company_id}/accounting/jobcost/forecastReview a tenant/entity-scoped forecast from dated sources
  221. PUT /rest/v1.0/companies/{company_id}/accounting/jobcost/forecastSave a dated PM cost-to-complete input (jobForecastEdit permission; PM grants only on projects they belong to). With no PM input a cost code's EAC is max(revised budget, actual + remaining commitments) (flag unforecast_budget when the budget is higher); a null cost_to_complete selects actual + remaining commitments explicitly and, like any input, needs approval before WIP reads it. Saving clears any approval; saving on a later date than the carried-forward input adds a new dated input. Frozen forecasts dated on or after the input are superseded (kept, with supersededAt), never deleted; the audit lists their ids. Refused (409) in a soft- or hard-closed job cost period and on or before the latest posted WIP period end for the entity.
  222. POST /rest/v1.0/companies/{company_id}/accounting/jobcost/forecast/approveApprove the PM input shown for a cost code on the worksheet date (approveJournal permission; the last editor cannot approve). Only approved inputs may feed WIP. Approving the last pending input for the date freezes the forecast there, superseding (not deleting) an earlier freeze on the same date. Refused (409) in a hard-closed period or on or before the latest posted WIP period end; allowed in a soft-closed period, so a month-end approval freezes at the period end.
  223. GET /rest/v1.0/companies/{company_id}/accounting/jobcost/scopeList accessible projects, entities and source assignments
  224. POST /rest/v1.0/companies/{company_id}/accounting/jobcost/scopeAssign a project's sources to one entity and base currency (unrestricted manageCoa permission)
  225. PATCH /rest/v1.0/companies/{company_id}/accounting/jobcost/scopeSet a job's WIP contract terms (manageCoa): revenue method (cost_to_cost, or as_invoiced for T&M / cost-plus jobs: revenue equals billings, ASC 606-10-55-18) and/or whether retainage is conditional (WIP presents it as a contract asset, ASC 606-10-45-3). Audited with the reason.
  226. GET /rest/v1.0/companies/{company_id}/accounting/jobcost/wipList WIP snapshots (newest period end and revision first, at most 100).
  227. POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wipCompute the next WIP revision for an entity at an ended period (postJournal and viewLedger). Contract = executed prime SOV + approved prime COs; cost = posted job cost; billed = posted AR; EAC = the forecast frozen at the period end (PM approval or soft close) plus job cost posted since the freeze, else the approved live forecast, unless overridden with a reason. Each job uses its revenue method (cost_to_cost or as_invoiced); pending prime COs are the memo column (pendingChangeOrders) and enter the transaction price only through overrides[].change_orders; retainage receivable comes from AR (retainageContractAsset when the job's retainage is conditional); each row records settings.loss_provision_unit; cash position is AR receipts less AP payments on the job (payroll and other direct cash costs are not included). A job whose inputs fail is a compute_failed exception (the other jobs still compute) and blocks approval. Rows are read without the company posting lock; the insert refuses with 409 if job cost or billings were posted, or job forecast inputs changed, meanwhile. Supports Idempotency-Key.
  228. GET /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}Get a WIP snapshot with its job rows; format=csv returns the rows as CSV
  229. POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}/approveApprove a draft snapshot (approveJournal; the preparer cannot approve). A snapshot with exceptions needs exceptions_note; compute_failed exceptions cannot be acknowledged. Idempotent; a rejected snapshot is refused.
  230. POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}/postPost an approved snapshot on journal WIP at the period end with autoReverseDate the next day; idempotent on (snapshot, revision). Supersedes an earlier posted revision for the period.
  231. POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}/rejectReject a draft or approved snapshot (approveJournal; terminal, compute a new revision), or with return_to_draft send an approved one back to draft (approval and acknowledgment cleared). Audited with the reason.
  232. GET /rest/v1.0/companies/{company_id}/accounting/journal_entriesList journal entries
  233. POST /rest/v1.0/companies/{company_id}/accounting/journal_entriesCreate a draft journal entry
  234. GET /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}Show a journal entry
  235. PATCH /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}Update a draft journal entry
  236. DELETE /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}Delete a draft journal entry
  237. POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/approveApprove a journal entry
  238. GET /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/attachmentsList attachments on a journal entry
  239. POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/attachmentsAttach a file to a journal entry
  240. POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/postPost a journal entry
  241. POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/rejectReject a journal entry (return to the preparer)
  242. POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/reverseReverse a posted journal entry
  243. POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/submitSubmit a journal entry for approval
  244. GET /rest/v1.0/companies/{company_id}/accounting/leasesList leases
  245. POST /rest/v1.0/companies/{company_id}/accounting/leasesAdd a lease
  246. GET /rest/v1.0/companies/{company_id}/accounting/leases/{id}Show a lease
  247. POST /rest/v1.0/companies/{company_id}/accounting/leases/{id}/voidVoid a lease
  248. GET /rest/v1.0/companies/{company_id}/accounting/leases/disclosuresLease disclosures
  249. GET /rest/v1.0/companies/{company_id}/accounting/leases/runsList lease runs
  250. POST /rest/v1.0/companies/{company_id}/accounting/leases/runsPreview or post a lease run
  251. GET /rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}Show a lease run
  252. POST /rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}/reverseReverse a lease run
  253. GET /rest/v1.0/companies/{company_id}/accounting/party_profilesList party profiles
  254. POST /rest/v1.0/companies/{company_id}/accounting/party_profilesCreate a party profile
  255. GET /rest/v1.0/companies/{company_id}/accounting/party_profiles/{id}Show a party profile
  256. PATCH /rest/v1.0/companies/{company_id}/accounting/party_profiles/{id}Update a party profile
  257. POST /rest/v1.0/companies/{company_id}/accounting/party_profiles/{id}/sensitive_changeApprove or reject a bank/TIN change
  258. POST /rest/v1.0/companies/{company_id}/accounting/payroll/accrualPost the month-end payroll accrual
  259. POST /rest/v1.0/companies/{company_id}/accounting/payroll/burden_true_upPost the standard-rate burden true-up
  260. GET /rest/v1.0/companies/{company_id}/accounting/payroll/certified_payrollCertified payroll (WH-347)
  261. POST /rest/v1.0/companies/{company_id}/accounting/payroll/checks/{id}/reissueReissue a printed paper check under a new number
  262. POST /rest/v1.0/companies/{company_id}/accounting/payroll/checks/{id}/voidVoid one check of a posted run
  263. GET /rest/v1.0/companies/{company_id}/accounting/payroll/codesList payroll codes
  264. POST /rest/v1.0/companies/{company_id}/accounting/payroll/codesCreate a code
  265. GET /rest/v1.0/companies/{company_id}/accounting/payroll/employeesList employees
  266. POST /rest/v1.0/companies/{company_id}/accounting/payroll/employeesCreate an employee
  267. GET /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}Show an employee
  268. PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}Update an employee
  269. POST /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}/deductionsAdd a deduction, match or garnishment
  270. DELETE /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}/deductions/{deduction_id}End a deduction
  271. POST /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}/revealReveal an employee SSN and bank numbers
  272. GET /rest/v1.0/companies/{company_id}/accounting/payroll/employersList payroll employer entities
  273. PUT /rest/v1.0/companies/{company_id}/accounting/payroll/employers/{entity_id}Set an employer entity's payroll identity
  274. POST /rest/v1.0/companies/{company_id}/accounting/payroll/filingsMark a payroll return period filed
  275. POST /rest/v1.0/companies/{company_id}/accounting/payroll/futa_overrideRequest or approve a provisional FUTA credit reduction override
  276. POST /rest/v1.0/companies/{company_id}/accounting/payroll/manual_checksEnter a manual (handwritten) check
  277. GET /rest/v1.0/companies/{company_id}/accounting/payroll/pay_groupsList pay groups
  278. POST /rest/v1.0/companies/{company_id}/accounting/payroll/pay_groupsCreate a pay group
  279. PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/pay_groups/{id}Update a pay group
  280. POST /rest/v1.0/companies/{company_id}/accounting/payroll/pii_rotationRotate payroll PII encryption
  281. GET /rest/v1.0/companies/{company_id}/accounting/payroll/rate_changesList pay-rate changes
  282. POST /rest/v1.0/companies/{company_id}/accounting/payroll/rate_changes/{id}Approve or reject a pay-rate change
  283. GET /rest/v1.0/companies/{company_id}/accounting/payroll/remittancesList payroll liability remittances
  284. POST /rest/v1.0/companies/{company_id}/accounting/payroll/remittancesRemit a payroll liability
  285. POST /rest/v1.0/companies/{company_id}/accounting/payroll/remittances/{id}/{decision}Release or reject a pending bank remittance
  286. GET /rest/v1.0/companies/{company_id}/accounting/payroll/reports/{report}Payroll tax and remittance data
  287. GET /rest/v1.0/companies/{company_id}/accounting/payroll/runsList pay runs
  288. POST /rest/v1.0/companies/{company_id}/accounting/payroll/runsCreate a pay run
  289. GET /rest/v1.0/companies/{company_id}/accounting/payroll/runs/{id}Show a pay run
  290. GET /rest/v1.0/companies/{company_id}/accounting/payroll/runs/{id}/{action}Pay run outputs
  291. POST /rest/v1.0/companies/{company_id}/accounting/payroll/runs/{id}/{action}Pay run workflow step
  292. GET /rest/v1.0/companies/{company_id}/accounting/payroll/setupShow payroll setup
  293. PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/setupUpdate payroll setup
  294. GET /rest/v1.0/companies/{company_id}/accounting/payroll/union_localsList union locals
  295. POST /rest/v1.0/companies/{company_id}/accounting/payroll/union_localsCreate a union local
  296. PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/union_locals/{id}Update a union local
  297. POST /rest/v1.0/companies/{company_id}/accounting/payroll/union_ratesAdd a CBA rate
  298. GET /rest/v1.0/companies/{company_id}/accounting/payroll/wage_determinationsList wage determinations
  299. POST /rest/v1.0/companies/{company_id}/accounting/payroll/wage_determinationsCreate a wage determination
  300. GET /rest/v1.0/companies/{company_id}/accounting/payroll/wc_classesList workers' comp classes
  301. POST /rest/v1.0/companies/{company_id}/accounting/payroll/wc_classesCreate a wc class
  302. GET /rest/v1.0/companies/{company_id}/accounting/periodsList fiscal periods
  303. GET /rest/v1.0/companies/{company_id}/accounting/periods/{id}Show a fiscal period
  304. POST /rest/v1.0/companies/{company_id}/accounting/periods/{id}/closeClose or soft-close a period
  305. POST /rest/v1.0/companies/{company_id}/accounting/periods/{id}/eliminate_intercompanyEliminate intercompany at a period end
  306. POST /rest/v1.0/companies/{company_id}/accounting/periods/{id}/reopenReopen a period
  307. POST /rest/v1.0/companies/{company_id}/accounting/periods/rebuild_balancesRebuild period balance snapshots
  308. POST /rest/v1.0/companies/{company_id}/accounting/pii_rotationRotate vendor and bank PII encryption
  309. GET /rest/v1.0/companies/{company_id}/accounting/recurring_journalsList recurring journals
  310. POST /rest/v1.0/companies/{company_id}/accounting/recurring_journalsCreate a recurring journal
  311. GET /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}Show a recurring journal
  312. PATCH /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}Update a recurring journal
  313. DELETE /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}Delete a recurring journal
  314. POST /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}/approveApprove a recurring journal
  315. GET /rest/v1.0/companies/{company_id}/accounting/reportsReport library
  316. GET /rest/v1.0/companies/{company_id}/accounting/reports/{report_key}Run a report
  317. GET /rest/v1.0/companies/{company_id}/accounting/reports/{report_key}/exportExport a report
  318. GET /rest/v1.0/companies/{company_id}/accounting/settingsShow accounting settings
  319. PATCH /rest/v1.0/companies/{company_id}/accounting/settingsUpdate accounting settings
  320. GET /rest/v1.0/companies/{company_id}/accounting/tax_codesList tax codes
  321. POST /rest/v1.0/companies/{company_id}/accounting/tax_codesCreate a tax code
  322. PATCH /rest/v1.0/companies/{company_id}/accounting/tax_codes/{id}Update a tax code
  323. GET /rest/v1.0/companies/{company_id}/accounting/tax_exemption_certificatesList customer tax exemption certificates
  324. POST /rest/v1.0/companies/{company_id}/accounting/tax_exemption_certificatesRecord a customer tax exemption certificate
  325. PATCH /rest/v1.0/companies/{company_id}/accounting/tax_exemption_certificates/{id}Change a certificate expiry
  326. GET /rest/v1.0/companies/{company_id}/accounting/termsList payment terms
  327. POST /rest/v1.0/companies/{company_id}/accounting/termsCreate a payment term
  328. PATCH /rest/v1.0/companies/{company_id}/accounting/terms/{id}Update a payment term
  329. GET /rest/v1.0/companies/{company_id}/accounting/trial_balanceTrial balance
GET /rest/v1.0/companies/{company_id}/accounting/accounts

List GL accounts

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • search
    stringquery
  • filters[type]
    stringquery
  • filters[is_active]
    anyquery
  • filters[is_postable]
    anyquery
  • page
    integerquery
  • per_page
    integerquery
  • updated_since
    string (date-time)query
  • cursor
    stringquery

Response · 200 · Account[]

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • type
    anyrequired
  • subtype
    string | nullrequired
  • normal_balance
    anyrequired
  • parent_id
    integer | nullrequired
  • is_postable
    booleanrequired
  • is_active
    booleanrequired
  • system_role
    string | nullrequired
  • is_control
    booleanrequired
  • require_project
    booleanrequired
  • require_cost_code
    booleanrequired
  • job_cost_type
    anyrequired
  • currency
    stringrequired
  • cash_flow_category
    anyrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/accounts

Create a GL account

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • account
    objectrequired

Response · 201 · Account

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • type
    anyrequired
  • subtype
    string | nullrequired
  • normal_balance
    anyrequired
  • parent_id
    integer | nullrequired
  • is_postable
    booleanrequired
  • is_active
    booleanrequired
  • system_role
    string | nullrequired
  • is_control
    booleanrequired
  • require_project
    booleanrequired
  • require_cost_code
    booleanrequired
  • job_cost_type
    anyrequired
  • currency
    stringrequired
  • cash_flow_category
    anyrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/accounts/{id}

Show a GL account

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · Account

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • type
    anyrequired
  • subtype
    string | nullrequired
  • normal_balance
    anyrequired
  • parent_id
    integer | nullrequired
  • is_postable
    booleanrequired
  • is_active
    booleanrequired
  • system_role
    string | nullrequired
  • is_control
    booleanrequired
  • require_project
    booleanrequired
  • require_cost_code
    booleanrequired
  • job_cost_type
    anyrequired
  • currency
    stringrequired
  • cash_flow_category
    anyrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
PATCH /rest/v1.0/companies/{company_id}/accounting/accounts/{id}

Update a GL account

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • account
    objectrequired

Response · 200 · Account

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • type
    anyrequired
  • subtype
    string | nullrequired
  • normal_balance
    anyrequired
  • parent_id
    integer | nullrequired
  • is_postable
    booleanrequired
  • is_active
    booleanrequired
  • system_role
    string | nullrequired
  • is_control
    booleanrequired
  • require_project
    booleanrequired
  • require_cost_code
    booleanrequired
  • job_cost_type
    anyrequired
  • currency
    stringrequired
  • cash_flow_category
    anyrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/accounts/apply_template

Apply the construction chart of accounts

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • template
    objectrequired

Response · 200 · object

  • template
    anyrequired
  • accounts_created
    integerrequired
  • accounts_total
    integerrequired
GET /rest/v1.0/companies/{company_id}/accounting/accounts/tree

Chart of accounts tree

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · AccountNode[]

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • type
    anyrequired
  • subtype
    string | nullrequired
  • normal_balance
    anyrequired
  • parent_id
    integer | nullrequired
  • is_postable
    booleanrequired
  • is_active
    booleanrequired
  • system_role
    string | nullrequired
  • is_control
    booleanrequired
  • require_project
    booleanrequired
  • require_cost_code
    booleanrequired
  • job_cost_type
    anyrequired
  • currency
    stringrequired
  • cash_flow_category
    anyrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • children
    AccountNode[]required
GET /rest/v1.0/companies/{company_id}/accounting/ach/monitoring

ACH fraud-monitoring evidence

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • from
    string (date)queryrequired
  • to
    string (date)queryrequired

Response · 200 · object

  • from
    string (date)required
  • to
    string (date)required
  • controls
    objectrequired
  • bank_changes
    object[]required
  • accounts
    object[]required
  • returns
    objectrequired
  • nocs
    objectrequired
  • notices
    AchNotice[]required
GET /rest/v1.0/companies/{company_id}/accounting/ach/notices

ACH returns and NOCs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • status
    anyquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · AchNotice[]

  • id
    integerrequired
  • kind
    stringrequired
  • code
    stringrequired
  • original_trace
    stringrequired
  • trace_number
    string | null
  • id_number
    stringrequired
  • amount
    stringrequired
  • received_date
    string (date)required
  • due_date
    string | null (date)
  • party_kind
    string | null
  • party_id
    integer | null
  • ap_payment_id
    integer | null
  • pay_check_id
    integer | null
  • entry_id
    integer | null
  • status
    stringrequired
  • message
    string | null
  • applied_at
    string | null (date-time)
  • applied_by_id
    integer | null
  • imported_by_id
    integer
POST /rest/v1.0/companies/{company_id}/accounting/ach/notices

Import an ACH return/NOC file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • ach_import
    objectrequired

Response · 201 · object

  • notices
    object[]required
  • skipped
    integerrequired
POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/{id}/resolve

Resolve a manual NOC

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • resolve
    objectrequired

Response · 200 · object

  • id
    integerrequired
POST /rest/v1.0/companies/{company_id}/accounting/ach/notices/apply_nocs

Apply NOCs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • apply
    objectrequired

Response · 200 · object

  • applied
    integer[]required
POST /rest/v1.0/companies/{company_id}/accounting/ach/prenotes

Generate a prenote file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • prenote
    objectrequired

Response · 200 · string

No documented fields.

POST /rest/v1.0/companies/{company_id}/accounting/allocation_runs

Post an allocation run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • date
    string (date)required
  • memo
    stringrequired
  • entity_id
    integer | null
  • basis
    anyrequired
  • amount
    stringrequired
  • pool_account_id
    integerrequired
  • target_account_id
    integerrequired
  • auto_reverse_date
    string | null (date)
  • targets
    object[]required

Response · 201 · object

  • journal_entry
    JournalEntryShow
  • allocation
    object
  • pending_approval
    boolean
POST /rest/v1.0/companies/{company_id}/accounting/allocation_runs/{id}/reverse

Reverse an allocation run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired

Response · 201 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/aging

AP aging as of a date

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • as_of
    string (date)query
  • basis
    stringquery

Response · 200 · ApAging

  • as_of
    string (date)required
  • basis
    stringrequired
  • bucket_labels
    string[]required
  • rows
    object[]required
  • totals
    objectrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/backup_notices

List CP2100 B notices

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • vendor_id
    integerquery

Response · 200 · BackupNotice[]

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • notice_number
    integerrequired
  • notice_date
    string (date)required
  • tax_year
    integer | nullrequired
  • letter_due_by
    string (date)required
  • withhold_from
    string (date)required
  • letter_sent_at
    string | null (date)required
  • cured_at
    string | null (date)required
  • cure_kind
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/backup_notices

Record a CP2100 B notice

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • backup_notice
    objectrequired

Response · 201 · BackupNotice

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • notice_number
    integerrequired
  • notice_date
    string (date)required
  • tax_year
    integer | nullrequired
  • letter_due_by
    string (date)required
  • withhold_from
    string (date)required
  • letter_sent_at
    string | null (date)required
  • cured_at
    string | null (date)required
  • cure_kind
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
PATCH /rest/v1.0/companies/{company_id}/accounting/ap/backup_notices/{id}

Mark a B notice letter sent or record the cure

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • backup_notice
    objectrequired

Response · 200 · BackupNotice

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • notice_number
    integerrequired
  • notice_date
    string (date)required
  • tax_year
    integer | nullrequired
  • letter_due_by
    string (date)required
  • withhold_from
    string (date)required
  • letter_sent_at
    string | null (date)required
  • cured_at
    string | null (date)required
  • cure_kind
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/ap/backup_notices/{id}/letter

B notice letter

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • filename
    stringrequired
  • text
    stringrequired
  • envelope
    stringrequired
  • letter_due_by
    string (date)required
  • notice_number
    integerrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/bills

List bills and vendor credits

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[status]
    stringquery
  • filters[kind]
    stringquery
  • vendor_id
    integerquery
  • project_id
    integerquery
  • due_by
    string (date)query
  • search
    stringquery
  • updated_since
    string (date-time)query
  • cursor
    stringquery

Response · 200 · ApBill[]

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills

Create a draft bill or vendor credit

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • bill
    objectrequired

Response · 201 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}

Show a bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
PATCH /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}

Edit a draft or pending bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • bill
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
DELETE /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}

Delete a draft bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/apply_credit

Apply a vendor credit to a bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • application
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/approve

Approve a bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • approve
    object

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/attachments

List attachments on a bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/attachments

Attach a file to a bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/override_hold

Override a hold

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • override
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/reject

Reject a bill (return to the preparer)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reject
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/release_retainage

Release retainage payable

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • release
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/submit

Submit a bill for approval

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/unapply_credit

Undo a vendor credit application

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • application
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/{id}/void

Void a posted bill

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • void
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/bills/from_source

Draft a bill from a requisition or direct cost

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • source
    objectrequired

Response · 201 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/checks/{id}/reprint

Reprint a check under a new number

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reprint
    objectrequired

Response · 201 · object

  • id
    integerrequired
  • check_number
    stringrequired
  • ap_payment_id
    integerrequired
  • amount
    stringrequired
  • status
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/compliance_requirements

List compliance requirements

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • vendor_id
    integerquery

Response · 200 · ApComplianceRequirement[]

  • id
    integerrequired
  • kind
    stringrequired
  • vendor_id
    integer | nullrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • notes
    string | nullrequired
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/compliance_requirements

Require a compliance document

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • compliance_requirement
    objectrequired

Response · 201 · ApComplianceRequirement

  • id
    integerrequired
  • kind
    stringrequired
  • vendor_id
    integer | nullrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • notes
    string | nullrequired
  • created_at
    string (date-time)required
DELETE /rest/v1.0/companies/{company_id}/accounting/ap/compliance_requirements/{id}

Drop a compliance requirement

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/accounting/ap/form_1099

1099 review

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • year
    integerquery
  • entity_id
    integerquery

Response · 200 · ApForm1099

  • year
    integerrequired
  • forms
    object[]required
  • explain
    objectrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/form_1099/iris

Export 1099s as IRIS Taxpayer Portal CSV files

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • iris
    objectrequired

Response · 200 · object

  • year
    integerrequired
  • form
    stringrequired
  • files
    object[]required
  • warnings
    string[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/form_1099/pub1220

Export 1099s as an IRS Pub 1220 file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • pub1220
    objectrequired

Response · 200 · string

No documented fields.

GET /rest/v1.0/companies/{company_id}/accounting/ap/form_945

Form 945 data

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • year
    integerquery
  • entity_id
    integerqueryrequired
  • lookback_liability
    stringquery

Response · 200 · object

  • year
    integerrequired
  • entity_id
    integerrequired
  • lines
    objectrequired
  • line_7
    object | nullrequired
  • form_945a_required
    booleanrequired
  • schedule
    stringrequired
  • lookback_liability
    stringrequired
  • may_pay_with_return
    booleanrequired
  • liability_by_date
    object[]required
  • deposits
    object[]required
  • ledger_withheld
    stringrequired
  • warnings
    string[]required
  • explain
    objectrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/form_945/eftps

EFTPS 945 deposits

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • form_945
    objectrequired

Response · 200 · object

  • year
    integerrequired
  • entity_id
    integerrequired
  • deposits
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs

List payment runs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · ApPaymentRun[]

  • id
    integerrequired
  • number
    stringrequired
  • status
    stringrequired
  • pay_date
    string (date)required
  • cash_account_id
    integerrequired
  • memo
    string | nullrequired
  • prepared_by_id
    integerrequired
  • released_by_id
    integer | nullrequired
  • released_at
    string | null (date-time)required
  • ach_generated_at
    string | null (date-time)required
  • ach_file_id_modifier
    string | nullrequired
  • total
    stringrequired
  • payment_count
    integerrequired
  • payments
    ApPayment[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs

Create a draft payment run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • payment_run
    objectrequired

Response · 201 · ApPaymentRunCreated

  • id
    integerrequired
  • number
    stringrequired
  • status
    stringrequired
  • pay_date
    string (date)required
  • cash_account_id
    integerrequired
  • memo
    string | nullrequired
  • prepared_by_id
    integerrequired
  • released_by_id
    integer | nullrequired
  • released_at
    string | null (date-time)required
  • total
    stringrequired
  • payment_count
    integerrequired
  • payments
    ApPayment[]required
  • created_at
    string (date-time)required
  • held
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}

Show a payment run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ApPaymentRun

  • id
    integerrequired
  • number
    stringrequired
  • status
    stringrequired
  • pay_date
    string (date)required
  • cash_account_id
    integerrequired
  • memo
    string | nullrequired
  • prepared_by_id
    integerrequired
  • released_by_id
    integer | nullrequired
  • released_at
    string | null (date-time)required
  • ach_generated_at
    string | null (date-time)required
  • ach_file_id_modifier
    string | nullrequired
  • total
    stringrequired
  • payment_count
    integerrequired
  • payments
    ApPayment[]required
  • created_at
    string (date-time)required
DELETE /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}

Delete a draft run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/checks

Check print data

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • format
    stringquery

Response · 200 · ApCheck[]

  • payment_id
    integerrequired
  • check_number
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • amount_words
    stringrequired
  • payee_line
    stringrequired
  • memo
    string | nullrequired
  • micr
    stringrequired
  • stub
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/nacha

ACH (NACHA) file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · string

No documented fields.

POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/nacha

Re-send the ACH (NACHA) file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • resend
    objectrequired

Response · 200 · string

No documented fields.

GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/positive_pay

Positive pay file (CSV)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · string

No documented fields.

POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/reject

Reject a payment run release

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reject
    objectrequired

Response · 200 · ApPaymentRun

  • id
    integerrequired
  • number
    stringrequired
  • status
    stringrequired
  • pay_date
    string (date)required
  • cash_account_id
    integerrequired
  • memo
    string | nullrequired
  • prepared_by_id
    integerrequired
  • released_by_id
    integer | nullrequired
  • released_at
    string | null (date-time)required
  • ach_generated_at
    string | null (date-time)required
  • ach_file_id_modifier
    string | nullrequired
  • total
    stringrequired
  • payment_count
    integerrequired
  • payments
    ApPayment[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/payment_runs/{id}/release

Release (approve) and post a payment run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • approve
    object

Response · 200 · ApPaymentRun

  • id
    integerrequired
  • number
    stringrequired
  • status
    stringrequired
  • pay_date
    string (date)required
  • cash_account_id
    integerrequired
  • memo
    string | nullrequired
  • prepared_by_id
    integerrequired
  • released_by_id
    integer | nullrequired
  • released_at
    string | null (date-time)required
  • ach_generated_at
    string | null (date-time)required
  • ach_file_id_modifier
    string | nullrequired
  • total
    stringrequired
  • payment_count
    integerrequired
  • payments
    ApPayment[]required
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/ap/payment_selection

Payment selection

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • pay_date
    string (date)query
  • due_by
    string (date)query

Response · 200 · ApPaymentCandidate[]

  • bill_id
    integerrequired
  • number
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • invoice_number
    string | nullrequired
  • due_date
    string (date)required
  • open_amount
    stringrequired
  • payable_amount
    stringrequired
  • discount
    stringrequired
  • holds
    ApHold[]required
  • payable
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/payments

List payments

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • vendor_id
    integerquery
  • filters[status]
    stringquery
  • updated_since
    string (date-time)query
  • cursor
    stringquery

Response · 200 · ApPayment[]

  • id
    integerrequired
  • run_id
    integer | nullrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • method
    stringrequired
  • check_number
    string | nullrequired
  • payment_date
    string (date)required
  • cash_account_id
    integerrequired
  • amount
    stringrequired
  • discount_amount
    stringrequired
  • withholding_amount
    stringrequired
  • joint_payees
    object[]required
  • customer_id
    integer | nullrequired
  • status
    stringrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • ach_trace_number
    string | nullrequired
  • applications
    object[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/payments

Create one manual payment

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • payment
    objectrequired

Response · 201 · ApPaymentRun

  • id
    integerrequired
  • number
    stringrequired
  • status
    stringrequired
  • pay_date
    string (date)required
  • cash_account_id
    integerrequired
  • memo
    string | nullrequired
  • prepared_by_id
    integerrequired
  • released_by_id
    integer | nullrequired
  • released_at
    string | null (date-time)required
  • ach_generated_at
    string | null (date-time)required
  • ach_file_id_modifier
    string | nullrequired
  • total
    stringrequired
  • payment_count
    integerrequired
  • payments
    ApPayment[]required
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/ap/payments/{id}

Show a payment

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ApPayment

  • id
    integerrequired
  • run_id
    integer | nullrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • method
    stringrequired
  • check_number
    string | nullrequired
  • payment_date
    string (date)required
  • cash_account_id
    integerrequired
  • amount
    stringrequired
  • discount_amount
    stringrequired
  • withholding_amount
    stringrequired
  • joint_payees
    object[]required
  • customer_id
    integer | nullrequired
  • status
    stringrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • ach_trace_number
    string | nullrequired
  • applications
    object[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/payments/{id}/void

Void a payment

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • void
    objectrequired

Response · 200 · ApPayment

  • id
    integerrequired
  • run_id
    integer | nullrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • method
    stringrequired
  • check_number
    string | nullrequired
  • payment_date
    string (date)required
  • cash_account_id
    integerrequired
  • amount
    stringrequired
  • discount_amount
    stringrequired
  • withholding_amount
    stringrequired
  • joint_payees
    object[]required
  • customer_id
    integer | nullrequired
  • status
    stringrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • ach_trace_number
    string | nullrequired
  • applications
    object[]required
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/ap/receipts

List PO receipts

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • commitment_id
    integerquery

Response · 200 · ApReceipt[]

  • id
    integerrequired
  • number
    stringrequired
  • commitment_id
    integerrequired
  • project_id
    integerrequired
  • vendor_id
    integerrequired
  • entity_id
    integer | nullrequired
  • receipt_date
    string (date)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/receipts

Receive against a purchase order

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • receipt
    objectrequired

Response · 201 · ApReceipt

  • id
    integerrequired
  • number
    stringrequired
  • commitment_id
    integerrequired
  • project_id
    integerrequired
  • vendor_id
    integerrequired
  • entity_id
    integer | nullrequired
  • receipt_date
    string (date)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/receipts/{id}/void

Void a PO receipt

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • void
    objectrequired

Response · 200 · ApReceipt

  • id
    integerrequired
  • number
    stringrequired
  • commitment_id
    integerrequired
  • project_id
    integerrequired
  • vendor_id
    integerrequired
  • entity_id
    integer | nullrequired
  • receipt_date
    string (date)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/ap/retainage_releases/{id}/void

Void a retainage release

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • void
    objectrequired

Response · 200 · ApBillShow

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • entity_id
    integerrequired
  • invoice_number
    string | nullrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • term_id
    integer | nullrequired
  • discount_percent
    string | nullrequired
  • discount_date
    string | null (date)required
  • memo
    string | nullrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • use_tax_amount
    stringrequired
  • tax_code_id
    integer | nullrequired
  • open_amount
    stringrequired
  • retainage_open
    stringrequired
  • paid_amount
    stringrequired
  • retainage_released
    stringrequired
  • commitment_type
    string | nullrequired
  • commitment_id
    integer | nullrequired
  • requisition_id
    integer | nullrequired
  • direct_cost_id
    integer | nullrequired
  • pay_when_paid_pay_app_id
    integer | nullrequired
  • pay_when_paid_mode
    string | nullrequired
  • off_rent_date
    string | null (date)required
  • billed_through
    string | null (date)required
  • match
    object | nullrequired
  • hold_overrides
    object[]required
  • revision
    integerrequired
  • prepared_by_id
    integerrequired
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • entry_id
    integer | nullrequired
  • voided_at
    string | null (date-time)required
  • void_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • lines
    ApBillLine[]required
  • holds
    ApHold[]required
  • approvals_required
    integerrequired
  • route_preview
    stringrequired
  • approvals
    object[]required
  • applications
    ApApplication[]required
  • retainage_releases
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/settings

AP settings

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · ApSettings

  • over_commitment_action
    stringrequired
  • match_tolerance_pct
    stringrequired
  • match_tolerance_amount
    stringrequired
  • receipt_accrual
    booleanrequired
  • discount_posting_mode
    stringrequired
  • bank_change_hold_days
    integerrequired
  • lien_waiver_mode
    stringrequired
  • approval_bands
    object[]required
  • rni_account_id
    integer | nullrequired
  • backup_withholding_account_id
    integer | nullrequired
  • cash_account_id
    integer | nullrequired
  • ach_company_id
    string | nullrequired
  • ach_company_name
    string | nullrequired
  • ach_destination_routing
    string | nullrequired
  • ach_destination_name
    string | nullrequired
  • prompt_pay_days
    integer | nullrequired
  • updated_at
    string (date-time)required
  • backup_withholding_policy
    stringrequired
  • ach_prenote_required
    booleanrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/ap/settings

Update AP settings

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • ap_settings
    objectrequired

Response · 200 · ApSettings

  • over_commitment_action
    stringrequired
  • match_tolerance_pct
    stringrequired
  • match_tolerance_amount
    stringrequired
  • receipt_accrual
    booleanrequired
  • discount_posting_mode
    stringrequired
  • bank_change_hold_days
    integerrequired
  • lien_waiver_mode
    stringrequired
  • approval_bands
    object[]required
  • rni_account_id
    integer | nullrequired
  • backup_withholding_account_id
    integer | nullrequired
  • cash_account_id
    integer | nullrequired
  • ach_company_id
    string | nullrequired
  • ach_company_name
    string | nullrequired
  • ach_destination_routing
    string | nullrequired
  • ach_destination_name
    string | nullrequired
  • prompt_pay_days
    integer | nullrequired
  • updated_at
    string (date-time)required
  • backup_withholding_policy
    stringrequired
  • ach_prenote_required
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/tie_out

AP subledger tie-out

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • as_of
    string (date)query

Response · 200 · ApTieOut

  • as_of
    string (date)required
  • ap
    objectrequired
  • retainage
    objectrequired
  • in_balance
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/tin_matching/export

Export an IRS bulk TIN Matching request file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · object

  • filename
    stringrequired
  • records
    integerrequired
  • text
    stringrequired
  • skipped
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/ap/tin_matching/import

Import IRS bulk TIN Matching results

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • tin_matching
    objectrequired

Response · 200 · object

  • applied
    object[]required
  • skipped
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors

List AP vendors

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • search
    stringquery

Response · 200 · ApVendor[]

  • vendor_id
    integerrequired
  • name
    string | nullrequired
  • is_1099
    booleanrequired
  • w9_status
    stringrequired
  • payment_method
    stringrequired
  • compliance_hold
    booleanrequired
  • coi_expires_at
    string | null (date)required
  • coi_expired
    booleanrequired
  • stop_pay
    booleanrequired
  • open_balance
    stringrequired
  • retainage_held
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}

Show an AP vendor

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ApVendorShow

  • vendor_id
    integerrequired
  • name
    stringrequired
  • profile_id
    integer | nullrequired
  • is_1099
    booleanrequired
  • w9_status
    string | nullrequired
  • compliance_hold
    booleanrequired
  • compliance
    ApCompliance[]required
  • lien_waivers
    ApLienWaiver[]required
  • bills
    ApBill[]required
GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/attachments

List attachments on a vendor

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/attachments

Attach a file to a vendor

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/compliance

Record a compliance document

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • compliance
    objectrequired

Response · 201 · ApCompliance

  • id
    integerrequired
  • vendor_id
    integerrequired
  • kind
    stringrequired
  • reference
    string | nullrequired
  • effective_at
    string | null (date)required
  • expires_at
    string | null (date)required
  • active
    booleanrequired
  • notes
    string | nullrequired
  • created_at
    string (date-time)required
PATCH /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/compliance/{compliance_id}

Lift or reinstate a compliance record

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • compliance_id
    integerpathrequired

Request body

  • compliance
    objectrequired

Response · 200 · ApCompliance

  • id
    integerrequired
  • vendor_id
    integerrequired
  • kind
    stringrequired
  • reference
    string | nullrequired
  • effective_at
    string | null (date)required
  • expires_at
    string | null (date)required
  • active
    booleanrequired
  • notes
    string | nullrequired
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/compliance/{compliance_id}/attachments

List attachments on a vendor compliance record (COI, W-9, license)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • compliance_id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/compliance/{compliance_id}/attachments

Attach a file to a vendor compliance record (COI, W-9, license)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • compliance_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/lien_waivers

Record a lien waiver received

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • lien_waiver
    objectrequired

Response · 201 · ApLienWaiver

  • id
    integerrequired
  • vendor_id
    integerrequired
  • project_id
    integer | nullrequired
  • party
    stringrequired
  • kind
    stringrequired
  • scope
    stringrequired
  • payment_no
    integerrequired
  • through_date
    string | null (date)required
  • amount
    string | nullrequired
  • received_at
    string (date)required
  • created_at
    string (date-time)required
  • payment_id
    integer | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/lien_waivers/{waiver_id}/attachments

List attachments on a lien waiver

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • waiver_id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ap/vendors/{id}/lien_waivers/{waiver_id}/attachments

Attach a file to a lien waiver

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • waiver_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/approval_delegations

List approval delegations

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · ApprovalDelegation[]

  • id
    integerrequired
  • from_user_id
    integerrequired
  • to_user_id
    integerrequired
  • doc_types
    any[]required
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • starts_at
    string (date-time)required
  • ends_at
    string (date-time)required
  • reason
    stringrequired
  • created_by_id
    integerrequired
  • revoked_at
    string | null (date-time)required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/approval_delegations

Create an approval delegation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • delegation
    objectrequired

Response · 201 · ApprovalDelegation

  • id
    integerrequired
  • from_user_id
    integerrequired
  • to_user_id
    integerrequired
  • doc_types
    any[]required
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • starts_at
    string (date-time)required
  • ends_at
    string (date-time)required
  • reason
    stringrequired
  • created_by_id
    integerrequired
  • revoked_at
    string | null (date-time)required
  • created_at
    string (date-time)required
DELETE /rest/v1.0/companies/{company_id}/accounting/approval_delegations/{id}

Revoke an approval delegation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/accounting/approval_rules

List approval rules

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · ApprovalRule[]

  • id
    integerrequired
  • doc_type
    anyrequired
  • name
    stringrequired
  • priority
    integerrequired
  • min_amount
    string | nullrequired
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • project_ids
    integer[]required
  • vendor_risk
    any[]required
  • steps
    object[]required
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/approval_rules

Create an approval rule

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • approval_rule
    objectrequired

Response · 201 · ApprovalRule

  • id
    integerrequired
  • doc_type
    anyrequired
  • name
    stringrequired
  • priority
    integerrequired
  • min_amount
    string | nullrequired
  • max_amount
    string | nullrequired
  • entity_ids
    integer[]required
  • project_ids
    integer[]required
  • vendor_risk
    any[]required
  • steps
    object[]required
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
DELETE /rest/v1.0/companies/{company_id}/accounting/approval_rules/{id}

Deactivate an approval rule

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

GET /rest/v1.0/companies/{company_id}/accounting/approvals/inbox

Approvals inbox

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · object

  • items
    object[]required
  • returned
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/approvals/self_approved

Self-approved documents

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • from
    string (date)query
  • to
    string (date)query

Response · 200 · object[]

  • id
    integer
  • item_type
    string
  • item_id
    integer
  • actor_id
    integer
  • summary
    string
  • reason
    string | null
  • created_at
    string (date-time)
GET /rest/v1.0/companies/{company_id}/accounting/ar/customers

List AR customers

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • search
    stringquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • has_profile
    booleanrequired
  • term_id
    integer | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}

Customer open balances net of posted receipts and reversals; paginated invoice history

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • page
    integerquery

Response · 200 · ArCustomer

  • customer
    objectrequired
  • balances
    object[]required
  • total
    integerrequired
  • invoices
    ArInvoice[]required
  • profile
    ArCustomerProfile
GET /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}/collection_notes

Latest 100 collection notes for the customer in permitted entities.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · ArCollectionNote[]

  • id
    integer
  • entity_id
    integer
  • customer_id
    integer
  • invoice_id
    integer
  • note
    string
  • promise_date
    string (date)
  • promise_amount
    string
  • created_by_id
    integer
  • created_at
    string (date-time)
POST /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}/collection_notes

Add a collection note (optional invoice and promise to pay). arEnter.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • entity_id
    integerrequired
  • invoice_id
    integer
  • note
    stringrequired
  • promise_date
    string (date)
  • promise_amount
    string

Response · 201 · ArCollectionNote

  • id
    integer
  • entity_id
    integer
  • customer_id
    integer
  • invoice_id
    integer
  • note
    string
  • promise_date
    string (date)
  • promise_amount
    string
  • created_by_id
    integer
  • created_at
    string (date-time)
GET /rest/v1.0/companies/{company_id}/accounting/ar/customers/{id}/statement

Customer statement: open posted invoices, unapplied cash and balance due, with the billing contact.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • as_of
    string (date)query

Response · 200 · ArStatement

  • customer
    object
  • profile
    object
  • as_of
    string (date)
  • invoices
    ArInvoice[]
  • open_total
    string
  • unapplied_cash
    string
  • balance_due
    string
  • open_current
    string
  • retainage_not_due
    string
  • owner_direct_credits
    string
POST /rest/v1.0/companies/{company_id}/accounting/ar/deposits

Deposit posted receipts held in UNDEPOSITED_FUNDS to a bank account as one journal (Dr bank / Cr undeposited funds). arApprove; idempotent by request_key.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • request_key
    string (uuid)required
  • entity_id
    integerrequired
  • bank_account_id
    integerrequired
  • posting_date
    string (date)required
  • receipt_ids
    integer[]required

Response · 201 · ArDeposit

  • id
    integer
  • number
    string
  • entity_id
    integer
  • bank_account_id
    integer
  • posting_date
    string (date)
  • currency
    string
  • total
    string
  • journal_entry_id
    integer
  • receipt_ids
    integer[]
GET /rest/v1.0/companies/{company_id}/accounting/ar/invoices

List scoped invoices (default 100, maximum 100 per page)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • customer_id
    integerquery
  • status
    stringquery
  • project_id
    integerquery
  • date_from
    string (date)query
  • date_to
    string (date)query
  • q
    stringquery
  • overdue
    booleanquery
  • as_of
    string (date)query
  • disputed
    booleanquery
  • sort
    stringquery
  • updated_since
    string (date-time)query
  • cursor
    stringquery

Response · 200 · ArInvoice[]

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices

Create a draft; a retry with the same request key and payload returns the original invoice

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • request_key
    string (uuid)required
  • invoice
    ArInvoiceInputrequired
  • correction
    object

Response · 200 · ArInvoice

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
GET /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}

Get scoped invoice

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ArInvoice

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
PATCH /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}

Replace current draft revision; all editors are excluded from approval

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • revision
    integerrequired
  • invoice
    ArInvoiceInputrequired

Response · 200 · ArInvoice

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
GET /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/attachments

List attachments on a AR invoice

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/attachments

Attach a file to a AR invoice

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/dispute

Flag or clear a collections dispute on a posted invoice. Disputed invoices age in the Disputed column. arEnter.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • disputed
    booleanrequired
  • reason
    string

Response · 200 · ArInvoice

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
GET /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/pdf

Invoice PDF

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · string (binary)

No documented fields.

POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/reverse

Append a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • request_key
    string (uuid)required
  • revision
    integerrequired
  • date
    string (date)required
  • reason
    stringrequired
  • nsf
    boolean

Response · 200 · ArReversal

  • id
    integerrequired
  • source_revision
    integerrequired
  • posting_date
    string (date)required
  • reason
    stringrequired
  • journal_entry_id
    integerrequired
  • actor_user_id
    integerrequired
POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/send

Send an invoice to the billing contact

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • invoice_id
    integerrequired
  • to
    stringrequired
  • email_message_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/{id}/transition

Submit, return to draft, independently approve, or post an invoice

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • revision
    integerrequired
  • action
    stringrequired
  • reason
    string

Response · 200 · ArInvoice

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/from_billing

Draft an AR invoice from a non-progress billing

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • request_key
    string (uuid)required
  • prime_contract_id
    integerrequired
  • entity_id
    integer
  • revenue_account_id
    integer
  • invoice_date
    string (date)required
  • posting_date
    string (date)
  • due_date
    string (date)
  • source_reference
    string
  • memo
    string
  • billing
    objectrequired

Response · 200 · object

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
  • calc
    object
POST /rest/v1.0/companies/{company_id}/accounting/ar/invoices/from_payment_application

Bill a certified owner pay app in AR (once per pay app)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • payment_application_id
    integerrequired
  • entity_id
    integer
  • revenue_account_id
    integer
  • invoice_date
    string (date)
  • posting_date
    string (date)
  • due_date
    string (date)

Response · 200 · ArInvoice

  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • source_reference
    stringrequired
  • invoice_date
    string (date)required
  • posting_date
    string (date)required
  • due_date
    string (date)required
  • memo
    stringrequired
  • lines
    object[]required
  • id
    integerrequired
  • number
    stringrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • revision
    integerrequired
  • status
    stringrequired
  • currency
    stringrequired
  • total
    stringrequired
  • retainage_amount
    stringrequired
  • current_amount
    stringrequired
  • open_current
    stringrequired
  • open_retainage
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • paid_current
    stringrequired
  • paid_retainage
    stringrequired
  • corrects_invoice_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • kind
    stringrequired
  • payment_application_id
    integerrequired
  • prime_contract_id
    integerrequired
  • project_id
    integerrequired
  • released_retainage
    stringrequired
  • tax_amount
    stringrequired
  • disputed
    booleanrequired
  • dispute_reason
    stringrequired
  • credited_current
    stringrequired
  • credit_reason
    stringrequired
  • cancellation_reason
    stringrequired
  • tax_override_reason
    stringrequired
  • tax_warnings
    string[]required
GET /rest/v1.0/companies/{company_id}/accounting/ar/payment_applications/{id}/pdf

G702/G703 PDF of a certified owner pay app

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · string (binary)

No documented fields.

PUT /rest/v1.0/companies/{company_id}/accounting/ar/prime_contracts/{id}/billing_method

Set a prime contract's billing method

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • billing_method
    stringrequired

Response · 200 · object

  • id
    integerrequired
  • billing_method
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/ar/prime_contracts/{id}/closeout

Get a prime contract's closeout documents

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • prime_contract_id
    integerrequired
  • required
    string[]required
  • received
    string[]required
  • missing
    string[]required
PUT /rest/v1.0/companies/{company_id}/accounting/ar/prime_contracts/{id}/closeout

Set a prime contract's closeout documents

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • required
    string[]required
  • received
    string[]

Response · 200 · object

  • prime_contract_id
    integerrequired
  • required
    string[]required
  • received
    string[]required
  • missing
    string[]required
GET /rest/v1.0/companies/{company_id}/accounting/ar/receipts

Receipt history, 50 per page

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • customer_id
    integerquery
  • per_page
    integerquery

Response · 200 · ArReceipt[]

  • id
    integerrequired
  • number
    stringrequired
  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • reference
    stringrequired
  • posting_date
    string (date)required
  • currency
    stringrequired
  • amount
    stringrequired
  • cash_account_id
    integerrequired
  • revision
    integerrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • status
    stringrequired
  • prepared_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • corrects_receipt_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • cancellation_reason
    stringrequired
  • method
    string
  • check_no
    string
  • payer
    string
  • unapplied_amount
    string
POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts

Record a fully allocated draft; matching request-key retries return the original receipt

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • request_key
    string (uuid)required
  • receipt
    objectrequired

Response · 201 · ArReceipt

  • id
    integerrequired
  • number
    stringrequired
  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • reference
    stringrequired
  • posting_date
    string (date)required
  • currency
    stringrequired
  • amount
    stringrequired
  • cash_account_id
    integerrequired
  • revision
    integerrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • status
    stringrequired
  • prepared_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • corrects_receipt_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • cancellation_reason
    stringrequired
  • method
    string
  • check_no
    string
  • payer
    string
  • unapplied_amount
    string
GET /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}

Receipt detail and immutable applications

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ArReceipt

  • id
    integerrequired
  • number
    stringrequired
  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • reference
    stringrequired
  • posting_date
    string (date)required
  • currency
    stringrequired
  • amount
    stringrequired
  • cash_account_id
    integerrequired
  • revision
    integerrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • status
    stringrequired
  • prepared_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • corrects_receipt_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • cancellation_reason
    stringrequired
  • method
    string
  • check_no
    string
  • payer
    string
  • unapplied_amount
    string
POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/applications

Apply a posted receipt's unapplied cash to open invoice lines, or transfer its allocations between lines. arApprove; idempotent by request_key.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • request_key
    string (uuid)required
  • kind
    stringrequired
  • posting_date
    string (date)required
  • applications
    object[]required

Response · 201 · ArCashApplication

  • id
    integer
  • receipt_id
    integer
  • kind
    string
  • posting_date
    string (date)
  • journal_entry_id
    integer
  • actor_user_id
    integer
  • applications
    object[]
GET /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/attachments

List attachments on a AR receipt

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/attachments

Attach a file to a AR receipt

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/reverse

Append a source-owned reversal. Independent arApprove required. Identical retries return the original reversal.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • request_key
    string (uuid)required
  • revision
    integerrequired
  • date
    string (date)required
  • reason
    stringrequired
  • nsf
    boolean

Response · 200 · ArReversal

  • id
    integerrequired
  • source_revision
    integerrequired
  • posting_date
    string (date)required
  • reason
    stringrequired
  • journal_entry_id
    integerrequired
  • actor_user_id
    integerrequired
POST /rest/v1.0/companies/{company_id}/accounting/ar/receipts/{id}/transition

Independently approve or post; balances are revalidated under the company lock

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • revision
    integerrequired
  • action
    stringrequired
  • reason
    string

Response · 200 · ArReceipt

  • id
    integerrequired
  • number
    stringrequired
  • entity_id
    integerrequired
  • customer_id
    integerrequired
  • reference
    stringrequired
  • posting_date
    string (date)required
  • currency
    stringrequired
  • amount
    stringrequired
  • cash_account_id
    integerrequired
  • revision
    integerrequired
  • source_type
    stringrequired
  • source_id
    integerrequired
  • source_revision
    integerrequired
  • status
    stringrequired
  • prepared_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • approved_by_id
    integerrequired
  • approved_at
    string (date-time)required
  • journal_entry_id
    integerrequired
  • corrects_receipt_id
    integerrequired
  • reversal
    ArReversalrequired
  • applications
    object[]required
  • cancellation_reason
    stringrequired
  • method
    string
  • check_no
    string
  • payer
    string
  • unapplied_amount
    string
GET /rest/v1.0/companies/{company_id}/accounting/ar/receipts/open_items

Open original AR distributions for one customer/entity; pages over open invoices only, oldest due first

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • entity_id
    integerqueryrequired
  • customer_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · ArOpenItems

  • total
    integerrequired
  • currency
    stringrequired
  • accounts
    object[]required
  • items
    object[]required
  • per_page
    integerrequired
GET /rest/v1.0/companies/{company_id}/accounting/assets

List fixed assets

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • filters[status]
    stringquery
  • filters[equipment_id]
    stringquery
  • search
    stringquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · FixedAsset[]

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • opening_accumulated
    stringrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
  • tax_convention
    stringrequired
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • opening_through
    string | nullrequired
  • current_cost
    stringrequired
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
  • total_units
    string | nullrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/assets

Add a fixed asset

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • fixed_asset
    objectrequired

Response · 201 · FixedAssetShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
  • tax_convention
    stringrequired
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • tax_schedule
    null | objectrequired
  • book_tax_differences
    object[]required
  • history
    object[]required
  • current_cost
    stringrequired
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
  • total_units
    string | nullrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    AssetAdjustment[]required
  • meter_readings
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/assets/{id}

Show a fixed asset

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · FixedAssetShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
  • tax_convention
    stringrequired
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • tax_schedule
    null | objectrequired
  • book_tax_differences
    object[]required
  • history
    object[]required
  • current_cost
    stringrequired
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
  • total_units
    string | nullrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    AssetAdjustment[]required
  • meter_readings
    object[]required
PATCH /rest/v1.0/companies/{company_id}/accounting/assets/{id}

Update a fixed asset

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • fixed_asset
    objectrequired

Response · 200 · FixedAssetShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
  • tax_convention
    stringrequired
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • tax_schedule
    null | objectrequired
  • book_tax_differences
    object[]required
  • history
    object[]required
  • current_cost
    stringrequired
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
  • total_units
    string | nullrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    AssetAdjustment[]required
  • meter_readings
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/adjustments

Post an asset adjustment

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • adjustment
    objectrequired

Response · 201 · AssetAdjustment

  • id
    integerrequired
  • asset_id
    integerrequired
  • kind
    stringrequired
  • date
    string (date)required
  • cost_delta
    stringrequired
  • accumulated_delta
    stringrequired
  • proceeds
    string | nullrequired
  • gain_loss
    string | nullrequired
  • from_entity_id
    integer | nullrequired
  • to_entity_id
    integer | nullrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • entry_number
    string | null
POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/dispose

Dispose of a fixed asset

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • disposal
    objectrequired

Response · 200 · Disposal

  • posted
    booleanrequired
  • asset_id
    integerrequired
  • date
    string (date)required
  • accumulated_before
    stringrequired
  • catch_up_depreciation
    stringrequired
  • catch_up_through
    stringrequired
  • adjusted_basis
    stringrequired
  • amount_realized
    stringrequired
  • gain
    stringrequired
  • loss
    stringrequired
  • tax_disposition
    null | objectrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • lines
    PreviewLine[]required
  • explain
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/meter_readings

Record a UOP meter reading

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • meter_reading
    objectrequired

Response · 201 · object

  • asset_id
    integerrequired
  • period
    stringrequired
  • units
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/undo_disposal

Undo a disposal

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired

Response · 201 · FixedAssetShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
  • tax_convention
    stringrequired
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • tax_schedule
    null | objectrequired
  • book_tax_differences
    object[]required
  • history
    object[]required
  • current_cost
    stringrequired
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
  • total_units
    string | nullrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    AssetAdjustment[]required
  • meter_readings
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/assets/{id}/void

Void an asset added in error

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired

Response · 201 · FixedAssetShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
  • tax_convention
    stringrequired
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • tax_schedule
    null | objectrequired
  • book_tax_differences
    object[]required
  • history
    object[]required
  • current_cost
    stringrequired
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
  • total_units
    string | nullrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    AssetAdjustment[]required
  • meter_readings
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/assets/capitalize

Capitalize an AP bill line

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • fixed_asset
    objectrequired

Response · 201 · FixedAssetShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • description
    string | nullrequired
  • category
    string | nullrequired
  • entity_id
    integerrequired
  • status
    stringrequired
  • equipment_id
    integer | nullrequired
  • equipment_name
    string | nullrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • acquisition_date
    string (date)required
  • in_service_date
    string (date)required
  • cost
    stringrequired
  • salvage
    stringrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • opening_accumulated
    stringrequired
  • opening_through
    string | nullrequired
  • accumulated_depreciation
    stringrequired
  • net_book_value
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • tax_system
    stringrequired
  • tax_convention
    stringrequired
  • ads_recovery_years
    string | nullrequired
  • business_use_pct
    stringrequired
  • section_179
    stringrequired
  • bonus_pct
    integerrequired
  • acquisition_entry_id
    integer | nullrequired
  • disposed_on
    string | null (date)required
  • disposal_proceeds
    string | nullrequired
  • disposal_costs
    string | nullrequired
  • disposal_gain_loss
    string | nullrequired
  • disposal_entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • book_schedule
    objectrequired
  • tax_schedule
    null | objectrequired
  • book_tax_differences
    object[]required
  • history
    object[]required
  • current_cost
    stringrequired
  • class_id
    integer | nullrequired
  • ap_bill_line_id
    integer | nullrequired
  • total_units
    string | nullrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • adjustments
    AssetAdjustment[]required
  • meter_readings
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/assets/classes

List asset classes

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · AssetClass[]

  • id
    integerrequired
  • name
    stringrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/assets/classes

Add an asset class

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • asset_class
    objectrequired

Response · 201 · AssetClass

  • id
    integerrequired
  • name
    stringrequired
  • asset_account_id
    integerrequired
  • accumulated_account_id
    integerrequired
  • expense_account_id
    integerrequired
  • book_method
    stringrequired
  • book_life_months
    integerrequired
  • book_convention
    stringrequired
  • tax_recovery_class
    string | nullrequired
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs

List depreciation runs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · DepreciationRun[]

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_amount
    stringrequired
  • asset_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs

Preview or post a depreciation run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • depreciation_run
    objectrequired

Response · 200 · DepreciationPreview

  • period_id
    integerrequired
  • period_name
    stringrequired
  • total_amount
    stringrequired
  • items
    object[]required
  • lines
    PreviewLine[]required
GET /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}

Show a depreciation run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · DepreciationRunShow

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_amount
    stringrequired
  • asset_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • lines
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/assets/depreciation_runs/{id}/reverse

Reverse a depreciation run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired

Response · 201 · DepreciationRunShow

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_amount
    stringrequired
  • asset_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • lines
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_logs

Post approved equipment logs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • equipment_logs
    objectrequired

Response · 200 · object

  • posted
    object[]required
  • skipped
    object[]required
  • total
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_rates

List equipment internal rates

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • equipment_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · EquipmentRate[]

  • id
    integerrequired
  • equipment_id
    integerrequired
  • entity_id
    integer | nullrequired
  • rate_type
    stringrequired
  • unit
    stringrequired
  • rate
    stringrequired
  • effective_from
    string (date)required
  • source
    stringrequired
  • job_cost_account_id
    integerrequired
  • recovery_account_id
    integerrequired
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_rates

Add an equipment internal rate

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • equipment_rate
    objectrequired

Response · 201 · EquipmentRate

  • id
    integerrequired
  • equipment_id
    integerrequired
  • entity_id
    integer | nullrequired
  • rate_type
    stringrequired
  • unit
    stringrequired
  • rate
    stringrequired
  • effective_from
    string (date)required
  • source
    stringrequired
  • job_cost_account_id
    integerrequired
  • recovery_account_id
    integerrequired
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_recovery

Equipment recovery vs cost

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • from
    string (date)query
  • to
    string (date)query

Response · 200 · EquipmentRecovery[]

  • equipment_id
    integerrequired
  • name
    stringrequired
  • asset_number
    string | nullrequired
  • recovery
    stringrequired
  • cost
    stringrequired
  • over_under
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages

List equipment usage charges

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • equipment_id
    integerquery
  • project_id
    integerquery
  • from
    string (date)query
  • to
    string (date)query
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · EquipmentUsage[]

  • id
    integerrequired
  • equipment_id
    integerrequired
  • project_id
    integerrequired
  • cost_code_id
    integer | nullrequired
  • date
    string (date)required
  • rate_id
    integerrequired
  • rate_type
    stringrequired
  • unit
    stringrequired
  • quantity
    stringrequired
  • rate
    stringrequired
  • amount
    stringrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • entity_id
    integer | nullrequired
  • status
    stringrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages

Charge equipment usage to a job

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • equipment_usage
    objectrequired

Response · 200 · EquipmentUsageResult

  • usage
    null | EquipmentUsagerequired
  • rate
    EquipmentRaterequired
  • amount
    stringrequired
  • lines
    PreviewLine[]required
POST /rest/v1.0/companies/{company_id}/accounting/assets/equipment_usages/{id}/void

Void equipment usage

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired

Response · 201 · EquipmentUsage

  • id
    integerrequired
  • equipment_id
    integerrequired
  • project_id
    integerrequired
  • cost_code_id
    integer | nullrequired
  • date
    string (date)required
  • rate_id
    integerrequired
  • rate_type
    stringrequired
  • unit
    stringrequired
  • quantity
    stringrequired
  • rate
    stringrequired
  • amount
    stringrequired
  • memo
    string | nullrequired
  • entry_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • entity_id
    integer | nullrequired
  • status
    stringrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/assets/equipment_utilization

Equipment utilization

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • from
    string (date)query
  • to
    string (date)query

Response · 200 · object[]

  • equipment_id
    integerrequired
  • name
    stringrequired
  • operating_hours
    stringrequired
  • idle_hours
    stringrequired
  • standby_hours
    stringrequired
  • utilization_pct
    stringrequired
  • recovery
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/assets/import

Import the fixed asset register

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • csv
    stringrequired
  • apply
    boolean
  • entity_id
    integer | null
  • as_of
    string (date)

Response · 200 · AssetImportResult

  • applied
    booleanrequired
  • rows
    integerrequired
  • cost
    stringrequired
  • opening_accumulated
    stringrequired
  • errors
    object[]required
  • tie_out
    object | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/attachments/{id}

Download an attachment

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · string (binary)

No documented fields.

GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts

List bank and card accounts

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • active
    stringquery

Response · 200 · BankAccount[]

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts

Create a bank account

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • bank_account
    objectrequired

Response · 201 · BankAccount

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}

Show a bank account

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · BankAccount

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}

Update a bank account

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • bank_account
    objectrequired

Response · 200 · BankAccount

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/bank_change

Approve or reject a pending bank number change

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • decision
    stringrequired
  • change_hash
    stringrequired

Response · 200 · BankAccount

  • id
    integerrequired
  • name
    stringrequired
  • kind
    stringrequired
  • entity_id
    integer | nullrequired
  • gl_account_id
    integerrequired
  • gl_account_number
    stringrequired
  • gl_account_name
    stringrequired
  • institution
    string | nullrequired
  • account_number_masked
    string | nullrequired
  • routing_number_masked
    string | nullrequired
  • currency
    stringrequired
  • is_active
    booleanrequired
  • next_check_number
    integer | nullrequired
  • receipt_required_over
    string | nullrequired
  • match_window_days
    integerrequired
  • low_balance_threshold
    string | nullrequired
  • has_csv_mapping
    booleanrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • pending_bank_change
    object | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inbox

Matching inbox

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • status
    stringquery

Response · 200 · Inbox

  • bank_account_id
    integerrequired
  • statement_balance
    string | nullrequired
  • statement_date
    string | null (date)required
  • counts
    objectrequired
  • lines
    object[]required
  • total
    integerrequired
  • truncated
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/inbox/accept_high

Accept all High matches

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · AcceptHighResult

  • matched
    integerrequired
  • total
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/outstanding

Outstanding items

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • as_of
    string (date)query
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · Outstanding

  • bank_account_id
    integerrequired
  • as_of
    string (date)required
  • deposits_in_transit
    OutstandingItem[]required
  • outstanding_payments
    OutstandingItem[]required
  • totals
    objectrequired
  • total
    integerrequired
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay

Generate a positive pay file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • positive_pay
    object

Response · 200 · PositivePayFile

  • batch_id
    integer | nullrequired
  • file_name
    stringrequired
  • content
    stringrequired
  • dry_run
    booleanrequired
  • item_count
    integerrequired
  • issued_count
    integerrequired
  • void_count
    integerrequired
  • issued_total
    stringrequired
  • void_total
    stringrequired
  • check_numbers
    string[]required
GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batches

List positive pay batches

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · PositivePayBatch[]

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • source
    stringrequired
  • ap_run_id
    integer | nullrequired
  • issued_count
    integerrequired
  • void_count
    integerrequired
  • issued_total
    stringrequired
  • void_total
    stringrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/positive_pay/batches/{batch_id}/regenerate

Regenerate a positive pay batch

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • batch_id
    integerpathrequired

Response · 200 · PositivePayRegenerated

  • batch_id
    integerrequired
  • file_name
    stringrequired
  • content
    stringrequired
  • item_count
    integerrequired
  • check_numbers
    string[]required
GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliations

List reconciliations

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · Reconciliation[]

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
  • beginning_balance
    stringrequired
  • status
    stringrequired
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • reviewed_by_id
    integer | nullrequired
  • reviewed_at
    string | null (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reconciliations

Start a reconciliation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reconciliation
    objectrequired

Response · 201 · ReconciliationShow

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
  • beginning_balance
    stringrequired
  • status
    stringrequired
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • lines
    ReconciliationLine[]required
  • warnings
    string[]required
  • reviewed_by_id
    integer | nullrequired
  • reviewed_at
    string | null (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/register

Account register

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • from
    string (date)query
  • to
    string (date)query
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · RegisterLine[]

  • journal_line_id
    integerrequired
  • entry_id
    integerrequired
  • entry_number
    string | nullrequired
  • date
    string (date)required
  • description
    string | nullrequired
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • bank_transaction_id
    integer | nullrequired
  • bank_transaction_number
    string | nullrequired
  • check_number
    string | nullrequired
  • amount
    stringrequired
  • deposit
    string | nullrequired
  • payment
    string | nullrequired
  • balance
    stringrequired
  • reconcile_state
    stringrequired
  • ap_payment_id
    integer | nullrequired
  • link
    string | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/reveal

Reveal bank numbers

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · RevealedNumbers

  • id
    integerrequired
  • account_number
    string | nullrequired
  • routing_number
    string | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_imports

List statement imports

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · StatementImport[]

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • format
    stringrequired
  • file_name
    string | nullrequired
  • statement_start
    string | null (date)required
  • statement_end
    string | null (date)required
  • opening_balance
    string | nullrequired
  • closing_balance
    string | nullrequired
  • line_count
    integerrequired
  • duplicate_count
    integerrequired
  • warnings
    string[]required
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/accounts/{id}/statement_imports

Import a statement

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • statement_import
    objectrequired

Response · 201 · StatementImport

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • format
    stringrequired
  • file_name
    string | nullrequired
  • statement_start
    string | null (date)required
  • statement_end
    string | null (date)required
  • opening_balance
    string | nullrequired
  • closing_balance
    string | nullrequired
  • line_count
    integerrequired
  • duplicate_count
    integerrequired
  • warnings
    string[]required
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_forecast

Cash forecast

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • as_of
    string (date)query
  • weeks
    integerquery
  • trend
    stringquery
  • open_items
    stringquery
  • ar_lag_days
    integerquery

Response · 200 · CashForecast

  • as_of
    string (date)required
  • opening
    stringrequired
  • closing
    stringrequired
  • floor
    string | nullrequired
  • trailing_net
    stringrequired
  • low_point
    object | nullrequired
  • accounts
    object[]required
  • weeks
    object[]required
  • explain
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/banking/cash_position

Cash position

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • as_of
    string (date)query

Response · 200 · CashPosition

  • as_of
    string (date)required
  • totals
    objectrequired
  • accounts
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}

Show a reconciliation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ReconciliationShow

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
  • beginning_balance
    stringrequired
  • status
    stringrequired
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • lines
    ReconciliationLine[]required
  • warnings
    string[]required
  • reviewed_by_id
    integer | nullrequired
  • reviewed_at
    string | null (date-time)required
PATCH /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}

Tick lines / change the statement balance

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reconciliation
    objectrequired

Response · 200 · ReconciliationShow

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
  • beginning_balance
    stringrequired
  • status
    stringrequired
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • lines
    ReconciliationLine[]required
  • warnings
    string[]required
  • reviewed_by_id
    integer | nullrequired
  • reviewed_at
    string | null (date-time)required
DELETE /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}

Cancel an in-progress reconciliation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/finish

Finish a reconciliation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • finish
    object

Response · 200 · ReconciliationShow

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
  • beginning_balance
    stringrequired
  • status
    stringrequired
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • lines
    ReconciliationLine[]required
  • warnings
    string[]required
  • reviewed_by_id
    integer | nullrequired
  • reviewed_at
    string | null (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/review

Review a finished reconciliation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ReconciliationShow

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
  • beginning_balance
    stringrequired
  • status
    stringrequired
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • lines
    ReconciliationLine[]required
  • warnings
    string[]required
  • reviewed_by_id
    integer | nullrequired
  • reviewed_at
    string | null (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/reconciliations/{id}/undo

Undo a reconciliation

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • undo
    objectrequired

Response · 200 · ReconciliationShow

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • statement_date
    string (date)required
  • statement_ending_balance
    stringrequired
  • beginning_balance
    stringrequired
  • status
    stringrequired
  • cleared_balance
    string | nullrequired
  • outstanding_deposits
    string | nullrequired
  • outstanding_payments
    string | nullrequired
  • book_balance
    string | nullrequired
  • adjustment_entry_id
    integer | nullrequired
  • adjustment_reason
    string | nullrequired
  • started_by_id
    integerrequired
  • finished_at
    string | null (date-time)required
  • finished_by_id
    integer | nullrequired
  • undone_at
    string | null (date-time)required
  • undone_by_id
    integer | nullrequired
  • undo_reason
    string | nullrequired
  • created_at
    string (date-time)required
  • totals
    objectrequired
  • lines
    ReconciliationLine[]required
  • warnings
    string[]required
  • reviewed_by_id
    integer | nullrequired
  • reviewed_at
    string | null (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/banking/rules

List bank rules

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · BankRule[]

  • id
    integerrequired
  • name
    stringrequired
  • bank_account_id
    integer | nullrequired
  • priority
    integerrequired
  • is_active
    booleanrequired
  • direction
    stringrequired
  • description_contains
    stringrequired
  • amount_min
    string | nullrequired
  • amount_max
    string | nullrequired
  • account_id
    integerrequired
  • project_id
    integer | nullrequired
  • cost_code_id
    integer | nullrequired
  • vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • times_applied
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/rules

Create a bank rule

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • bank_rule
    objectrequired

Response · 201 · BankRule

  • id
    integerrequired
  • name
    stringrequired
  • bank_account_id
    integer | nullrequired
  • priority
    integerrequired
  • is_active
    booleanrequired
  • direction
    stringrequired
  • description_contains
    stringrequired
  • amount_min
    string | nullrequired
  • amount_max
    string | nullrequired
  • account_id
    integerrequired
  • project_id
    integer | nullrequired
  • cost_code_id
    integer | nullrequired
  • vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • times_applied
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
PATCH /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}

Update a bank rule

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • bank_rule
    objectrequired

Response · 200 · BankRule

  • id
    integerrequired
  • name
    stringrequired
  • bank_account_id
    integer | nullrequired
  • priority
    integerrequired
  • is_active
    booleanrequired
  • direction
    stringrequired
  • description_contains
    stringrequired
  • amount_min
    string | nullrequired
  • amount_max
    string | nullrequired
  • account_id
    integerrequired
  • project_id
    integer | nullrequired
  • cost_code_id
    integer | nullrequired
  • vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • times_applied
    integerrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
DELETE /rest/v1.0/companies/{company_id}/accounting/banking/rules/{id}

Delete a bank rule

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/create_transaction

Create from a statement line

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • create
    objectrequired

Response · 201 · BankTransaction

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    BankTransactionLine[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/ignore

Ignore a statement line

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · StatementLine

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/match

Match a statement line

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • match
    objectrequired

Response · 200 · StatementLine

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/restore

Restore an ignored statement line

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · StatementLine

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
POST /rest/v1.0/companies/{company_id}/accounting/banking/statement_lines/{id}/unmatch

Unmatch a statement line

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · StatementLine

  • id
    integerrequired
  • bank_account_id
    integerrequired
  • import_id
    integerrequired
  • date
    string (date)required
  • amount
    stringrequired
  • description
    stringrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • bank_txn_id
    string | nullrequired
  • type_code
    string | nullrequired
  • status
    stringrequired
  • match_source
    string | nullrequired
  • match_confidence
    string | nullrequired
  • rule_id
    integer | nullrequired
  • matched_at
    string | null (date-time)required
  • journal_line_ids
    integer[]required
GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions

List cash documents

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • from
    string (date)query
  • to
    string (date)query
  • search
    stringquery
  • page
    integerquery
  • per_page
    integerquery
  • updated_since
    string (date-time)query
  • cursor
    stringquery

Response · 200 · BankTransaction[]

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    BankTransactionLine[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions

Record and post a cash document

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • bank_transaction
    objectrequired

Response · 201 · BankTransaction

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    BankTransactionLine[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}

Show a cash document

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · BankTransaction

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    BankTransactionLine[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/approve

Release or approve a pending cash document

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · BankTransaction

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    BankTransactionLine[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/attachments

List attachments on a bank transaction

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/attachments

Attach a file to a bank transaction

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/check_print

Check print data

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · CheckPrint

  • check_number
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • amount_numeric
    stringrequired
  • amount_words
    stringrequired
  • payee_line
    stringrequired
  • payee_address
    string[]required
  • memo
    string | nullrequired
  • legend
    string | nullrequired
  • micr
    objectrequired
  • stub
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/banking/transactions/{id}/void

Void a cash document

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • void
    objectrequired

Response · 200 · BankTransaction

  • id
    integerrequired
  • number
    stringrequired
  • kind
    stringrequired
  • status
    stringrequired
  • bank_account_id
    integerrequired
  • bank_account_name
    stringrequired
  • date
    string (date)required
  • amount
    stringrequired
  • payee
    string | nullrequired
  • payee_vendor_id
    integer | nullrequired
  • memo
    string | nullrequired
  • reference
    string | nullrequired
  • check_number
    string | nullrequired
  • to_bank_account_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_journal_entry_id
    integer | nullrequired
  • void_date
    string | null (date)required
  • void_reason
    string | nullrequired
  • voided_at
    string | null (date-time)required
  • statement_line_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | null (date-time)required
  • positive_pay_issued_at
    string | null (date-time)required
  • positive_pay_void_at
    string | null (date-time)required
  • receipt_missing
    booleanrequired
  • lines
    BankTransactionLine[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/budgets

List GL budgets

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · Budget[]

  • id
    integerrequired
  • fiscal_year
    integerrequired
  • name
    stringrequired
  • version
    integerrequired
  • line_count
    integerrequired
  • created_by_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • total
    string
  • lines
    object[]
POST /rest/v1.0/companies/{company_id}/accounting/budgets

Import a GL budget from CSV

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • budget
    objectrequired

Response · 201 · Budget

  • id
    integerrequired
  • fiscal_year
    integerrequired
  • name
    stringrequired
  • version
    integerrequired
  • line_count
    integerrequired
  • created_by_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • total
    string
  • lines
    object[]
GET /rest/v1.0/companies/{company_id}/accounting/budgets/{id}

Show a GL budget with its lines

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · Budget

  • id
    integerrequired
  • fiscal_year
    integerrequired
  • name
    stringrequired
  • version
    integerrequired
  • line_count
    integerrequired
  • created_by_id
    integer | nullrequired
  • created_at
    string (date-time)required
  • total
    string
  • lines
    object[]
DELETE /rest/v1.0/companies/{company_id}/accounting/budgets/{id}

Delete a GL budget version

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/cecl_allowance

Post the CECL allowance adjustment

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • entity_id
    integerrequired
  • as_of
    string (date)required

Response · 200 · object

  • entry
    object | nullrequired
  • adjustment
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/current_portion_reclass

Post the current-portion reclass

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • entity_id
    integerrequired
  • as_of
    string (date)required

Response · 200 · object

  • entry
    object | nullrequired
  • items
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/debt_schedules

List debt and lease schedules

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • entity_id
    integerquery

Response · 200 · object

  • debt_schedules
    DebtSchedule[]required
POST /rest/v1.0/companies/{company_id}/accounting/debt_schedules

Create a debt or lease schedule

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • debt_schedule
    objectrequired

Response · 201 · object

  • debt_schedule
    DebtSchedulerequired
DELETE /rest/v1.0/companies/{company_id}/accounting/debt_schedules/{id}

Deactivate a debt or lease schedule

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · object

  • deleted
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/entities

List legal entities

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · Entity[]

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • legal_name
    string | nullrequired
  • is_active
    booleanrequired
  • intercompany_due_to_account_id
    integer | nullrequired
  • intercompany_due_from_account_id
    integer | nullrequired
  • tax_id_last4
    string | nullrequired
  • address
    string | nullrequired
  • city
    string | nullrequired
  • state
    string | nullrequired
  • zip
    string | nullrequired
  • phone
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • is_elimination
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/entities

Create a legal entity

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • entity
    objectrequired

Response · 201 · Entity

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • legal_name
    string | nullrequired
  • is_active
    booleanrequired
  • intercompany_due_to_account_id
    integer | nullrequired
  • intercompany_due_from_account_id
    integer | nullrequired
  • tax_id_last4
    string | nullrequired
  • address
    string | nullrequired
  • city
    string | nullrequired
  • state
    string | nullrequired
  • zip
    string | nullrequired
  • phone
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • is_elimination
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/entities/{id}

Show a legal entity

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · Entity

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • legal_name
    string | nullrequired
  • is_active
    booleanrequired
  • intercompany_due_to_account_id
    integer | nullrequired
  • intercompany_due_from_account_id
    integer | nullrequired
  • tax_id_last4
    string | nullrequired
  • address
    string | nullrequired
  • city
    string | nullrequired
  • state
    string | nullrequired
  • zip
    string | nullrequired
  • phone
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • is_elimination
    booleanrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/entities/{id}

Update a legal entity

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • entity
    objectrequired

Response · 200 · Entity

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • legal_name
    string | nullrequired
  • is_active
    booleanrequired
  • intercompany_due_to_account_id
    integer | nullrequired
  • intercompany_due_from_account_id
    integer | nullrequired
  • tax_id_last4
    string | nullrequired
  • address
    string | nullrequired
  • city
    string | nullrequired
  • state
    string | nullrequired
  • zip
    string | nullrequired
  • phone
    string | nullrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • is_elimination
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/fiscal_years

Generate a fiscal year

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • fiscal_year
    objectrequired

Response · 201 · FiscalYear

  • id
    integerrequired
  • year
    integerrequired
  • start_date
    string (date)required
  • end_date
    string (date)required
  • status
    anyrequired
  • periods
    Period[]required
POST /rest/v1.0/companies/{company_id}/accounting/fiscal_years/{id}/year_end_close

Post the year-end close

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · YearEndClose

  • fiscal_year
    object
  • journal_entry
    JournalEntryShow
POST /rest/v1.0/companies/{company_id}/accounting/fiscal_years/{id}/year_end_close/reverse

Reverse the year-end close

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    object

Response · 201 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/general_ledger

General ledger detail

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • account_id
    integerquery
  • from
    string (date)query
  • to
    string (date)query
  • entity_id
    integerquery
  • project_id
    integerquery
  • department_id
    integerquery
  • cost_code_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery
  • cursor
    stringquery

Response · 200 · GeneralLedger

  • next_cursor
    string | nullrequired
  • account_id
    integer | nullrequired
  • from
    string (date)required
  • to
    string (date)required
  • opening_balance
    string | nullrequired
  • closing_balance
    string | nullrequired
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • rows
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/grants

List accounting access

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • search
    stringquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · Member[]

  • user_id
    integerrequired
  • name
    stringrequired
  • email
    stringrequired
  • is_active
    booleanrequired
  • is_admin
    booleanrequired
  • role
    anyrequired
  • effective_role
    anyrequired
  • flags
    objectrequired
  • entity_ids
    integer[]required
  • updated_at
    string | null (date-time)required
PATCH /rest/v1.0/companies/{company_id}/accounting/grants/{id}

Set a member's accounting access

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • grant
    objectrequired

Response · 200 · Member

  • user_id
    integerrequired
  • name
    stringrequired
  • email
    stringrequired
  • is_active
    booleanrequired
  • is_admin
    booleanrequired
  • role
    anyrequired
  • effective_role
    anyrequired
  • flags
    objectrequired
  • entity_ids
    integer[]required
  • updated_at
    string | null (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/integrations/connections

List ERP connections with health and recent sync runs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · Connection[]

  • id
    integerrequired
  • entity_id
    integerrequired
  • provider
    anyrequired
  • provider_label
    stringrequired
  • mode
    anyrequired
  • name
    stringrequired
  • status
    anyrequired
  • external_tenant
    string | nullrequired
  • authorized
    booleanrequired
  • config
    objectrequired
  • last_sync_at
    string | nullrequired
  • last_error
    string | nullrequired
  • health
    anyrequired
  • runs
    SyncRun[]required
POST /rest/v1.0/companies/{company_id}/accounting/integrations/connections

Create an ERP connection (manageIntegrations)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • entity_id
    integerrequired
  • provider
    anyrequired
  • name
    stringrequired
  • external_tenant
    string
  • config
    object

Response · 201 · Connection

  • id
    integerrequired
  • entity_id
    integerrequired
  • provider
    anyrequired
  • provider_label
    stringrequired
  • mode
    anyrequired
  • name
    stringrequired
  • status
    anyrequired
  • external_tenant
    string | nullrequired
  • authorized
    booleanrequired
  • config
    objectrequired
  • last_sync_at
    string | nullrequired
  • last_error
    string | nullrequired
  • health
    anyrequired
  • runs
    SyncRun[]required
POST /rest/v1.0/companies/{company_id}/accounting/integrations/connections/{id}/sync

Queue a sync pull (live API connections); it stages coa, vendors and open_ap import runs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 202 · SyncRun

  • id
    integerrequired
  • status
    anyrequired
  • started_at
    string | nullrequired
  • finished_at
    string | nullrequired
  • stats
    objectrequired
  • errors
    object[]required
  • import_run_ids
    integer[]required
  • created_at
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/integrations/exports/journals

Export posted journals as an ERP import file

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • from
    string (date)query
  • to
    string (date)query
  • format
    anyquery
  • journal
    anyquery
  • entity_id
    integerquery
  • target
    stringquery
  • since_last
    anyquery
  • batch_id
    integerquery
  • qbo_class
    anyquery

Response · 200 · string

No documented fields.

GET /rest/v1.0/companies/{company_id}/accounting/integrations/imports

List imports

v1.0Implemented

Parameters

  • company_id Import runs carry opening balances and open AP/AR documents, so project-scoped (project_manager_view) grants get 403 on every import read.
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • company_id
    stringpathrequired

Response · 200 · ImportSummary[]

  • id
    integerrequired
  • entity_id
    integerrequired
  • source_namespace
    stringrequired
  • kind
    anyrequired
  • status
    anyrequired
  • created_at
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/integrations/imports

Upload CSV and persist validation preview

v1.0Implemented

Parameters

  • company_id Import runs carry opening balances and open AP/AR documents, so project-scoped (project_manager_view) grants get 403 on every import read.
    integerpathrequired
  • company_id
    stringpathrequired

Request body

  • entity_id
    integerrequired
  • source_namespace
    stringrequired
  • kind
    anyrequired
  • as_of
    string (date)
  • file
    string (binary)required
  • profile
    any

Response · 201 · ImportRun

  • id
    integerrequired
  • entity_id
    integerrequired
  • source_namespace
    stringrequired
  • kind
    anyrequired
  • status
    anyrequired
  • created_at
    stringrequired
  • as_of
    string | nullrequired
  • source_hash
    stringrequired
  • preview_hash
    stringrequired
  • mapping
    objectrequired
  • preview
    objectrequired
  • prepared_by_id
    integerrequired
  • reconciled_by_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • applied_at
    string | nullrequired
  • last_error
    string | nullrequired
  • items
    object[]required
  • history
    object[]required
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • revision
    integerrequired
  • background
    booleanrequired
  • row_count
    integerrequired
  • chunk_count
    integerrequired
  • chunks_done
    integerrequired
  • item_count
    integerrequired
  • job
    null | objectrequired
GET /rest/v1.0/companies/{company_id}/accounting/integrations/imports/{id}

Read preview, results and history

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · ImportRun

  • id
    integerrequired
  • entity_id
    integerrequired
  • source_namespace
    stringrequired
  • kind
    anyrequired
  • status
    anyrequired
  • created_at
    stringrequired
  • as_of
    string | nullrequired
  • source_hash
    stringrequired
  • preview_hash
    stringrequired
  • mapping
    objectrequired
  • preview
    objectrequired
  • prepared_by_id
    integerrequired
  • reconciled_by_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • applied_at
    string | nullrequired
  • last_error
    string | nullrequired
  • items
    object[]required
  • history
    object[]required
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • revision
    integerrequired
  • background
    booleanrequired
  • row_count
    integerrequired
  • chunk_count
    integerrequired
  • chunks_done
    integerrequired
  • item_count
    integerrequired
  • job
    null | objectrequired
POST /rest/v1.0/companies/{company_id}/accounting/integrations/imports/{id}

Map, reconcile, approve/apply or reverse an imported entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • action
    anyrequired
  • preview_hash
    stringrequired
  • mapping
    objectrequired

Response · 200 · ImportRun

  • id
    integerrequired
  • entity_id
    integerrequired
  • source_namespace
    stringrequired
  • kind
    anyrequired
  • status
    anyrequired
  • created_at
    stringrequired
  • as_of
    string | nullrequired
  • source_hash
    stringrequired
  • preview_hash
    stringrequired
  • mapping
    objectrequired
  • preview
    objectrequired
  • prepared_by_id
    integerrequired
  • reconciled_by_id
    integer | nullrequired
  • approved_by_id
    integer | nullrequired
  • applied_at
    string | nullrequired
  • last_error
    string | nullrequired
  • items
    object[]required
  • history
    object[]required
  • last_edited_by_id
    integerrequired
  • contributor_ids
    integer[]required
  • revision
    integerrequired
  • background
    booleanrequired
  • row_count
    integerrequired
  • chunk_count
    integerrequired
  • chunks_done
    integerrequired
  • item_count
    integerrequired
  • job
    null | objectrequired
GET /rest/v1.0/companies/{company_id}/accounting/integrations/inbox

Integration error inbox: sync run errors and blocked or failed import runs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · InboxItem[]

  • key
    stringrequired
  • source
    stringrequired
  • sync_run_id
    integer | nullrequired
  • import_id
    integer | nullrequired
  • message
    stringrequired
  • at
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/integrations/sync_runs/{id}

Get a sync run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · SyncRun

  • id
    integerrequired
  • status
    anyrequired
  • started_at
    string | nullrequired
  • finished_at
    string | nullrequired
  • stats
    objectrequired
  • errors
    object[]required
  • import_run_ids
    integer[]required
  • created_at
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/job_cost_entries

List job cost entries

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • filters[project_id]
    stringquery
  • filters[cost_code_id]
    stringquery
  • filters[cost_type]
    stringquery
  • filters[kind]
    stringquery
  • from
    string (date)query
  • to
    string (date)query
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · JobCostEntry[]

  • id
    integerrequired
  • project_id
    integerrequired
  • cost_code_id
    integer | nullrequired
  • cost_type
    anyrequired
  • cost_type_id
    integer | nullrequired
  • kind
    anyrequired
  • amount
    stringrequired
  • hours
    string | nullrequired
  • quantity
    string | nullrequired
  • date
    string (date)required
  • period_id
    integer | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • journal_line_id
    integer | nullrequired
  • memo
    string | nullrequired
  • created_at
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/job_tax_profiles/{id}

Get a job tax profile

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • as_of
    string (date)query

Response · 200 · JobTaxProfile

  • project_id
    integerrequired
  • state_code
    stringrequired
  • contract_type
    stringrequired
  • sales_tax_code_id
    integerrequired
  • use_tax_code_id
    integerrequired
  • as_of
    string (date)required
  • model
    stringrequired
  • charge_customer
    booleanrequired
  • accrue_use_tax
    booleanrequired
  • fixtures
    stringrequired
PUT /rest/v1.0/companies/{company_id}/accounting/job_tax_profiles/{id}

Set a job tax profile

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • tax_profile
    objectrequired

Response · 200 · JobTaxProfile

  • project_id
    integerrequired
  • state_code
    stringrequired
  • contract_type
    stringrequired
  • sales_tax_code_id
    integerrequired
  • use_tax_code_id
    integerrequired
  • as_of
    string (date)required
  • model
    stringrequired
  • charge_customer
    booleanrequired
  • accrue_use_tax
    booleanrequired
  • fixtures
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/jobcost/forecast

Review a tenant/entity-scoped forecast from dated sources

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • project_id
    integerqueryrequired
  • entity_id
    integerqueryrequired
  • as_of
    string (date)queryrequired

Response · 200 · Forecast

  • project
    objectrequired
  • entity
    objectrequired
  • asOf
    string (date)required
  • currency
    stringrequired
  • basis
    stringrequired
  • totals
    Totalsrequired
  • lines
    object[]required
PUT /rest/v1.0/companies/{company_id}/accounting/jobcost/forecast

Save a dated PM cost-to-complete input (jobForecastEdit permission; PM grants only on projects they belong to). With no PM input a cost code's EAC is max(revised budget, actual + remaining commitments) (flag unforecast_budget when the budget is higher); a null cost_to_complete selects actual + remaining commitments explicitly and, like any input, needs approval before WIP reads it. Saving clears any approval; saving on a later date than the carried-forward input adds a new dated input. Frozen forecasts dated on or after the input are superseded (kept, with supersededAt), never deleted; the audit lists their ids. Refused (409) in a soft- or hard-closed job cost period and on or before the latest posted WIP period end for the entity.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • entity_id
    integerrequired
  • cost_code_id
    integerrequired
  • as_of
    string (date)required
  • cost_to_complete
    stringrequired
  • reason
    stringrequired
  • revision
    integerrequired

Response · 200

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/jobcost/forecast/approve

Approve the PM input shown for a cost code on the worksheet date (approveJournal permission; the last editor cannot approve). Only approved inputs may feed WIP. Approving the last pending input for the date freezes the forecast there, superseding (not deleting) an earlier freeze on the same date. Refused (409) in a hard-closed period or on or before the latest posted WIP period end; allowed in a soft-closed period, so a month-end approval freezes at the period end.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • entity_id
    integerrequired
  • cost_code_id
    integerrequired
  • as_of
    string (date)required
  • revision
    integerrequired

Response · 200 · object

  • id
    integerrequired
  • revision
    integerrequired
  • approvedAt
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/jobcost/scope

List accessible projects, entities and source assignments

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/jobcost/scope

Assign a project's sources to one entity and base currency (unrestricted manageCoa permission)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • entity_id
    integerrequired
  • currency
    stringrequired
  • reason
    stringrequired
  • confirm_project_sources
    booleanrequired

Response · 201

No response body.

PATCH /rest/v1.0/companies/{company_id}/accounting/jobcost/scope

Set a job's WIP contract terms (manageCoa): revenue method (cost_to_cost, or as_invoiced for T&M / cost-plus jobs: revenue equals billings, ASC 606-10-55-18) and/or whether retainage is conditional (WIP presents it as a contract asset, ASC 606-10-45-3). Audited with the reason.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • project_id
    integerrequired
  • revenue_method
    any
  • retainage_conditional
    boolean
  • reason
    stringrequired

Response · 200

No response body.

GET /rest/v1.0/companies/{company_id}/accounting/jobcost/wip

List WIP snapshots (newest period end and revision first, at most 100).

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • entity_id
    integerquery
  • period_id
    integerquery

Response · 200 · WipSnapshot[]

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • period_end
    string (date)required
  • revision
    integerrequired
  • status
    anyrequired
  • revised_contract
    Money
  • earned_to_date
    Money
  • billed_to_date
    Money
  • underbillings
    Moneyrequired
  • overbillings
    Moneyrequired
  • loss_provision
    Moneyrequired
  • prepared_by_id
    integer
  • approved_by_id
    integer
  • approved_at
    string (date-time)
  • journal_entry_id
    integer
  • journal_entry_number
    string
  • posted_at
    string (date-time)
  • exceptions
    object[]
  • exceptions_acknowledged_by_id
    integer
  • exceptions_acknowledged_at
    string (date-time)
  • exceptions_note
    string
  • rows
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wip

Compute the next WIP revision for an entity at an ended period (postJournal and viewLedger). Contract = executed prime SOV + approved prime COs; cost = posted job cost; billed = posted AR; EAC = the forecast frozen at the period end (PM approval or soft close) plus job cost posted since the freeze, else the approved live forecast, unless overridden with a reason. Each job uses its revenue method (cost_to_cost or as_invoiced); pending prime COs are the memo column (pendingChangeOrders) and enter the transaction price only through overrides[].change_orders; retainage receivable comes from AR (retainageContractAsset when the job's retainage is conditional); each row records settings.loss_provision_unit; cash position is AR receipts less AP payments on the job (payroll and other direct cash costs are not included). A job whose inputs fail is a compute_failed exception (the other jobs still compute) and blocks approval. Rows are read without the company posting lock; the insert refuses with 409 if job cost or billings were posted, or job forecast inputs changed, meanwhile. Supports Idempotency-Key.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • entity_id
    integerrequired
  • period_id
    integerrequired
  • overrides
    object[]

Response · 201 · WipSnapshot

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • period_end
    string (date)required
  • revision
    integerrequired
  • status
    anyrequired
  • revised_contract
    Money
  • earned_to_date
    Money
  • billed_to_date
    Money
  • underbillings
    Moneyrequired
  • overbillings
    Moneyrequired
  • loss_provision
    Moneyrequired
  • prepared_by_id
    integer
  • approved_by_id
    integer
  • approved_at
    string (date-time)
  • journal_entry_id
    integer
  • journal_entry_number
    string
  • posted_at
    string (date-time)
  • exceptions
    object[]
  • exceptions_acknowledged_by_id
    integer
  • exceptions_acknowledged_at
    string (date-time)
  • exceptions_note
    string
  • rows
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}

Get a WIP snapshot with its job rows; format=csv returns the rows as CSV

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • format
    anyquery

Response · 200 · WipSnapshot

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • period_end
    string (date)required
  • revision
    integerrequired
  • status
    anyrequired
  • revised_contract
    Money
  • earned_to_date
    Money
  • billed_to_date
    Money
  • underbillings
    Moneyrequired
  • overbillings
    Moneyrequired
  • loss_provision
    Moneyrequired
  • prepared_by_id
    integer
  • approved_by_id
    integer
  • approved_at
    string (date-time)
  • journal_entry_id
    integer
  • journal_entry_number
    string
  • posted_at
    string (date-time)
  • exceptions
    object[]
  • exceptions_acknowledged_by_id
    integer
  • exceptions_acknowledged_at
    string (date-time)
  • exceptions_note
    string
  • rows
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}/approve

Approve a draft snapshot (approveJournal; the preparer cannot approve). A snapshot with exceptions needs exceptions_note; compute_failed exceptions cannot be acknowledged. Idempotent; a rejected snapshot is refused.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • exceptions_note
    string

Response · 200 · WipSnapshot

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • period_end
    string (date)required
  • revision
    integerrequired
  • status
    anyrequired
  • revised_contract
    Money
  • earned_to_date
    Money
  • billed_to_date
    Money
  • underbillings
    Moneyrequired
  • overbillings
    Moneyrequired
  • loss_provision
    Moneyrequired
  • prepared_by_id
    integer
  • approved_by_id
    integer
  • approved_at
    string (date-time)
  • journal_entry_id
    integer
  • journal_entry_number
    string
  • posted_at
    string (date-time)
  • exceptions
    object[]
  • exceptions_acknowledged_by_id
    integer
  • exceptions_acknowledged_at
    string (date-time)
  • exceptions_note
    string
  • rows
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}/post

Post an approved snapshot on journal WIP at the period end with autoReverseDate the next day; idempotent on (snapshot, revision). Supersedes an earlier posted revision for the period.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · WipSnapshot

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • period_end
    string (date)required
  • revision
    integerrequired
  • status
    anyrequired
  • revised_contract
    Money
  • earned_to_date
    Money
  • billed_to_date
    Money
  • underbillings
    Moneyrequired
  • overbillings
    Moneyrequired
  • loss_provision
    Moneyrequired
  • prepared_by_id
    integer
  • approved_by_id
    integer
  • approved_at
    string (date-time)
  • journal_entry_id
    integer
  • journal_entry_number
    string
  • posted_at
    string (date-time)
  • exceptions
    object[]
  • exceptions_acknowledged_by_id
    integer
  • exceptions_acknowledged_at
    string (date-time)
  • exceptions_note
    string
  • rows
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/jobcost/wip/{id}/reject

Reject a draft or approved snapshot (approveJournal; terminal, compute a new revision), or with return_to_draft send an approved one back to draft (approval and acknowledgment cleared). Audited with the reason.

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reason
    stringrequired
  • return_to_draft
    boolean

Response · 200 · WipSnapshot

  • id
    integerrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • period_end
    string (date)required
  • revision
    integerrequired
  • status
    anyrequired
  • revised_contract
    Money
  • earned_to_date
    Money
  • billed_to_date
    Money
  • underbillings
    Moneyrequired
  • overbillings
    Moneyrequired
  • loss_provision
    Moneyrequired
  • prepared_by_id
    integer
  • approved_by_id
    integer
  • approved_at
    string (date-time)
  • journal_entry_id
    integer
  • journal_entry_number
    string
  • posted_at
    string (date-time)
  • exceptions
    object[]
  • exceptions_acknowledged_by_id
    integer
  • exceptions_acknowledged_at
    string (date-time)
  • exceptions_note
    string
  • rows
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/journal_entries

List journal entries

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • filters[status]
    stringquery
  • filters[journal]
    stringquery
  • filters[source_type]
    stringquery
  • filters[entity_id]
    stringquery
  • filters[period_id]
    stringquery
  • filters[account_id]
    stringquery
  • filters[project_id]
    stringquery
  • from
    string (date)query
  • to
    string (date)query
  • search
    stringquery
  • page
    integerquery
  • per_page
    integerquery
  • updated_since
    string (date-time)query
  • cursor
    stringquery

Response · 200 · JournalEntry[]

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/journal_entries

Create a draft journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • journal_entry
    objectrequired

Response · 201 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}

Show a journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}

Update a draft journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • journal_entry
    objectrequired

Response · 200 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
DELETE /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}

Delete a draft journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/approve

Approve a journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • approve
    object

Response · 200 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/attachments

List attachments on a journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · AcctAttachment[]

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/attachments

Attach a file to a journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • file
    string (binary)required

Response · 201 · AcctAttachment

  • id
    integerrequired
  • doc_type
    stringrequired
  • doc_id
    integerrequired
  • name
    stringrequired
  • content_type
    stringrequired
  • size_bytes
    integerrequired
  • sha256
    stringrequired
  • uploaded_by
    objectrequired
  • created_at
    string (date-time)required
  • download_url
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/post

Post a journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/reject

Reject a journal entry (return to the preparer)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reject
    objectrequired

Response · 200 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/reverse

Reverse a posted journal entry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired

Response · 201 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/journal_entries/{id}/submit

Submit a journal entry for approval

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · JournalEntryShow

  • id
    integerrequired
  • number
    string | nullrequired
  • status
    anyrequired
  • journal
    anyrequired
  • entity_id
    integerrequired
  • period_id
    integerrequired
  • posting_date
    string (date)required
  • document_date
    string | null (date)required
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • total_amount
    stringrequired
  • currency
    stringrequired
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • posted_by_id
    integer | nullrequired
  • posted_at
    string | null (date-time)required
  • reverses_id
    integer | nullrequired
  • reversed_by_id
    integer | nullrequired
  • auto_reverse_date
    string | null (date)required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • exchange_rate
    stringrequired
  • is_closing_entry
    booleanrequired
  • batch_id
    integer | nullrequired
  • recurring_id
    integer | nullrequired
  • submitted_at
    string | null (date-time)required
  • approved_at
    string | null (date-time)required
  • total_debit
    stringrequired
  • total_credit
    stringrequired
  • balanced
    booleanrequired
  • lines
    JournalLine[]required
  • is_noncash
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/leases

List leases

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · Lease[]

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/leases

Add a lease

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • lease
    objectrequired

Response · 201 · LeaseShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • schedule
    object[]required
  • history
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/leases/{id}

Show a lease

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · LeaseShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • schedule
    object[]required
  • history
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/leases/{id}/void

Void a lease

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • void
    objectrequired

Response · 201 · LeaseShow

  • id
    integerrequired
  • number
    stringrequired
  • name
    stringrequired
  • lessor
    string | nullrequired
  • asset_class
    stringrequired
  • entity_id
    integerrequired
  • classification
    stringrequired
  • short_term
    booleanrequired
  • commencement_date
    string (date)required
  • term_months
    integerrequired
  • payment
    stringrequired
  • escalation_pct
    stringrequired
  • payment_timing
    stringrequired
  • discount_rate
    stringrequired
  • rate_source
    stringrequired
  • initial_direct_costs
    stringrequired
  • incentives
    stringrequired
  • purchase_option_price
    stringrequired
  • rou_account_id
    integer | nullrequired
  • liability_account_id
    integer | nullrequired
  • current_liability_account_id
    integer | nullrequired
  • cost_account_id
    integerrequired
  • interest_account_id
    integer | nullrequired
  • payment_account_id
    integerrequired
  • commencement_entry_id
    integer | nullrequired
  • status
    stringrequired
  • voided_on
    string | null (date)required
  • void_reason
    string | nullrequired
  • void_entry_id
    integer | nullrequired
  • initial_liability
    stringrequired
  • initial_rou
    stringrequired
  • total_payments
    stringrequired
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • schedule
    object[]required
  • history
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/leases/disclosures

Lease disclosures

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • from
    string (date)query
  • to
    string (date)query

Response · 200 · LeaseDisclosures

  • from
    string (date)required
  • to
    string (date)required
  • lease_count
    integerrequired
  • lease_cost
    objectrequired
  • cash_paid
    objectrequired
  • rou_obtained_for_new_liabilities
    objectrequired
  • operating
    LeaseClassTotalsrequired
  • finance
    LeaseClassTotalsrequired
GET /rest/v1.0/companies/{company_id}/accounting/leases/runs

List lease runs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · LeaseRun[]

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_cost
    stringrequired
  • lease_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/leases/runs

Preview or post a lease run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • lease_run
    objectrequired

Response · 200 · LeaseRunPreview

  • period_id
    integerrequired
  • period_name
    stringrequired
  • total_cost
    stringrequired
  • items
    object[]required
  • lines
    PreviewLine[]required
GET /rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}

Show a lease run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · LeaseRunShow

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_cost
    stringrequired
  • lease_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • lines
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/leases/runs/{id}/reverse

Reverse a lease run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reversal
    objectrequired

Response · 201 · LeaseRunShow

  • id
    integerrequired
  • period_id
    integerrequired
  • period_name
    string | nullrequired
  • posting_date
    string (date)required
  • total_cost
    stringrequired
  • lease_count
    integerrequired
  • entry_id
    integer | nullrequired
  • entry_number
    string | nullrequired
  • entry_status
    string | nullrequired
  • created_by_id
    integerrequired
  • created_at
    string (date-time)required
  • lines
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/party_profiles

List party profiles

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • filters[role]
    anyquery
  • search
    stringquery
  • page
    integerquery
  • per_page
    integerquery
  • updated_since
    string (date-time)query
  • cursor
    stringquery

Response · 200 · PartyProfile[]

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • is_vendor
    booleanrequired
  • is_customer
    booleanrequired
  • tax_id_masked
    string | nullrequired
  • tax_id_type
    string | nullrequired
  • is_1099
    booleanrequired
  • form_1099_type
    string | nullrequired
  • form_1099_box
    string | nullrequired
  • tax_classification
    string | nullrequired
  • w9_status
    anyrequired
  • w9_received_at
    string | null (date)required
  • term_id
    integer | nullrequired
  • remit_to_name
    string | nullrequired
  • remit_to_address
    string | nullrequired
  • remit_to_city
    string | nullrequired
  • remit_to_state
    string | nullrequired
  • remit_to_zip
    string | nullrequired
  • default_expense_account_id
    integer | nullrequired
  • payment_method
    anyrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | nullrequired
  • has_bank_routing
    booleanrequired
  • retainage_percent
    string | nullrequired
  • compliance_hold
    booleanrequired
  • compliance_hold_reason
    string | nullrequired
  • credit_limit
    string | nullrequired
  • billing_contact_name
    string | nullrequired
  • billing_email
    string | null (email)required
  • billing_address
    string | nullrequired
  • pending_sensitive_change
    object | nullrequired
  • revealed
    object
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • tin_match_code
    integer | nullrequired
  • tin_matched_at
    string | null (date)required
  • bank_account_ownership
    string | null
POST /rest/v1.0/companies/{company_id}/accounting/party_profiles

Create a party profile

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • party_profile
    objectrequired

Response · 201 · PartyProfile

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • is_vendor
    booleanrequired
  • is_customer
    booleanrequired
  • tax_id_masked
    string | nullrequired
  • tax_id_type
    string | nullrequired
  • is_1099
    booleanrequired
  • form_1099_type
    string | nullrequired
  • form_1099_box
    string | nullrequired
  • tax_classification
    string | nullrequired
  • w9_status
    anyrequired
  • w9_received_at
    string | null (date)required
  • term_id
    integer | nullrequired
  • remit_to_name
    string | nullrequired
  • remit_to_address
    string | nullrequired
  • remit_to_city
    string | nullrequired
  • remit_to_state
    string | nullrequired
  • remit_to_zip
    string | nullrequired
  • default_expense_account_id
    integer | nullrequired
  • payment_method
    anyrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | nullrequired
  • has_bank_routing
    booleanrequired
  • retainage_percent
    string | nullrequired
  • compliance_hold
    booleanrequired
  • compliance_hold_reason
    string | nullrequired
  • credit_limit
    string | nullrequired
  • billing_contact_name
    string | nullrequired
  • billing_email
    string | null (email)required
  • billing_address
    string | nullrequired
  • pending_sensitive_change
    object | nullrequired
  • revealed
    object
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • tin_match_code
    integer | nullrequired
  • tin_matched_at
    string | null (date)required
  • bank_account_ownership
    string | null
GET /rest/v1.0/companies/{company_id}/accounting/party_profiles/{id}

Show a party profile

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • reveal
    anyquery

Response · 200 · PartyProfile

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • is_vendor
    booleanrequired
  • is_customer
    booleanrequired
  • tax_id_masked
    string | nullrequired
  • tax_id_type
    string | nullrequired
  • is_1099
    booleanrequired
  • form_1099_type
    string | nullrequired
  • form_1099_box
    string | nullrequired
  • tax_classification
    string | nullrequired
  • w9_status
    anyrequired
  • w9_received_at
    string | null (date)required
  • term_id
    integer | nullrequired
  • remit_to_name
    string | nullrequired
  • remit_to_address
    string | nullrequired
  • remit_to_city
    string | nullrequired
  • remit_to_state
    string | nullrequired
  • remit_to_zip
    string | nullrequired
  • default_expense_account_id
    integer | nullrequired
  • payment_method
    anyrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | nullrequired
  • has_bank_routing
    booleanrequired
  • retainage_percent
    string | nullrequired
  • compliance_hold
    booleanrequired
  • compliance_hold_reason
    string | nullrequired
  • credit_limit
    string | nullrequired
  • billing_contact_name
    string | nullrequired
  • billing_email
    string | null (email)required
  • billing_address
    string | nullrequired
  • pending_sensitive_change
    object | nullrequired
  • revealed
    object
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • tin_match_code
    integer | nullrequired
  • tin_matched_at
    string | null (date)required
  • bank_account_ownership
    string | null
PATCH /rest/v1.0/companies/{company_id}/accounting/party_profiles/{id}

Update a party profile

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • party_profile
    objectrequired

Response · 200 · PartyProfile

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • is_vendor
    booleanrequired
  • is_customer
    booleanrequired
  • tax_id_masked
    string | nullrequired
  • tax_id_type
    string | nullrequired
  • is_1099
    booleanrequired
  • form_1099_type
    string | nullrequired
  • form_1099_box
    string | nullrequired
  • tax_classification
    string | nullrequired
  • w9_status
    anyrequired
  • w9_received_at
    string | null (date)required
  • term_id
    integer | nullrequired
  • remit_to_name
    string | nullrequired
  • remit_to_address
    string | nullrequired
  • remit_to_city
    string | nullrequired
  • remit_to_state
    string | nullrequired
  • remit_to_zip
    string | nullrequired
  • default_expense_account_id
    integer | nullrequired
  • payment_method
    anyrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | nullrequired
  • has_bank_routing
    booleanrequired
  • retainage_percent
    string | nullrequired
  • compliance_hold
    booleanrequired
  • compliance_hold_reason
    string | nullrequired
  • credit_limit
    string | nullrequired
  • billing_contact_name
    string | nullrequired
  • billing_email
    string | null (email)required
  • billing_address
    string | nullrequired
  • pending_sensitive_change
    object | nullrequired
  • revealed
    object
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • tin_match_code
    integer | nullrequired
  • tin_matched_at
    string | null (date)required
  • bank_account_ownership
    string | null
POST /rest/v1.0/companies/{company_id}/accounting/party_profiles/{id}/sensitive_change

Approve or reject a bank/TIN change

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • decision
    anyrequired
  • change_hash
    stringrequired

Response · 200 · PartyProfile

  • id
    integerrequired
  • vendor_id
    integerrequired
  • vendor_name
    string | nullrequired
  • is_vendor
    booleanrequired
  • is_customer
    booleanrequired
  • tax_id_masked
    string | nullrequired
  • tax_id_type
    string | nullrequired
  • is_1099
    booleanrequired
  • form_1099_type
    string | nullrequired
  • form_1099_box
    string | nullrequired
  • tax_classification
    string | nullrequired
  • w9_status
    anyrequired
  • w9_received_at
    string | null (date)required
  • term_id
    integer | nullrequired
  • remit_to_name
    string | nullrequired
  • remit_to_address
    string | nullrequired
  • remit_to_city
    string | nullrequired
  • remit_to_state
    string | nullrequired
  • remit_to_zip
    string | nullrequired
  • default_expense_account_id
    integer | nullrequired
  • payment_method
    anyrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | nullrequired
  • has_bank_routing
    booleanrequired
  • retainage_percent
    string | nullrequired
  • compliance_hold
    booleanrequired
  • compliance_hold_reason
    string | nullrequired
  • credit_limit
    string | nullrequired
  • billing_contact_name
    string | nullrequired
  • billing_email
    string | null (email)required
  • billing_address
    string | nullrequired
  • pending_sensitive_change
    object | nullrequired
  • revealed
    object
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • tin_match_code
    integer | nullrequired
  • tin_matched_at
    string | null (date)required
  • bank_account_ownership
    string | null
POST /rest/v1.0/companies/{company_id}/accounting/payroll/accrual

Post the month-end payroll accrual

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • month
    stringrequired

Response · 200 · object

No documented fields.

POST /rest/v1.0/companies/{company_id}/accounting/payroll/burden_true_up

Post the standard-rate burden true-up

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • month
    string

Response · 200 · object

No documented fields.

GET /rest/v1.0/companies/{company_id}/accounting/payroll/certified_payroll

Certified payroll (WH-347)

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • project_id
    integerquery
  • week_ending
    stringquery
  • format
    stringquery

Response · 200 · object

  • projects
    object[]required
  • weeks
    string[]required
POST /rest/v1.0/companies/{company_id}/accounting/payroll/checks/{id}/reissue

Reissue a printed paper check under a new number

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reason
    stringrequired
  • date
    string (date)

Response · 200 · object

  • check
    Checkrequired
  • voided_check_number
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/checks/{id}/void

Void one check of a posted run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reason
    stringrequired
  • date
    string (date)
  • confirm_paid
    boolean
  • reissue
    boolean
  • reissue_pay_date
    string (date)

Response · 200 · object

  • check
    Checkrequired
  • reissue_run
    PayRun | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/codes

List payroll codes

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · PayrollCode[]

  • id
    integerrequired
  • kind
    stringrequired
  • code
    stringrequired
  • name
    stringrequired
  • tax_treatment
    string | nullrequired
  • calc_method
    stringrequired
  • rate
    string | nullrequired
  • is_active
    booleanrequired
  • include_in_regular_rate
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/codes

Create a code

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • code
    objectrequired

Response · 201 · PayrollCode

  • id
    integerrequired
  • kind
    stringrequired
  • code
    stringrequired
  • name
    stringrequired
  • tax_treatment
    string | nullrequired
  • calc_method
    stringrequired
  • rate
    string | nullrequired
  • is_active
    booleanrequired
  • include_in_regular_rate
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/employees

List employees

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • search
    stringquery

Response · 200 · Employee[]

  • id
    integerrequired
  • number
    stringrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • middle_initial
    string | null
  • user_id
    integer | null
  • workforce_person_id
    integer | null
  • status
    string
  • hire_date
    string | null
  • term_date
    string | null
  • pay_group_id
    integerrequired
  • pay_group_code
    string | null
  • pay_type
    stringrequired
  • hourly_rate
    string | null
  • salary_per_period
    string | null
  • salary_allocation
    array | null
  • union_local_id
    integer | null
  • home_local_code
    string | null
  • classification
    string | null
  • worker_type
    string
  • apprentice_level
    string | null
  • plan_credit_per_hour
    string | null
  • wc_class_code
    string | null
  • resident_state
    string
  • work_state
    string
  • w4
    object | null
  • state_w4
    object | null
  • birth_year
    integer | null
  • address
    string | null
  • city
    string | null
  • state
    string | null
  • zip
    string | null
  • payment_method
    string
  • ssn_masked
    string | nullrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | null
  • has_bank_routing
    boolean
  • deductions
    Deduction[]
  • revealed
    object
  • resident_locality
    string | null
  • reciprocity_states
    string[]
  • pending_rate_change_id
    integer | null
  • pending_bank_change_id
    integer | null
  • flsa_exempt
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/employees

Create an employee

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • employee
    objectrequired

Response · 201 · Employee

  • id
    integerrequired
  • number
    stringrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • middle_initial
    string | null
  • user_id
    integer | null
  • workforce_person_id
    integer | null
  • status
    string
  • hire_date
    string | null
  • term_date
    string | null
  • pay_group_id
    integerrequired
  • pay_group_code
    string | null
  • pay_type
    stringrequired
  • hourly_rate
    string | null
  • salary_per_period
    string | null
  • salary_allocation
    array | null
  • union_local_id
    integer | null
  • home_local_code
    string | null
  • classification
    string | null
  • worker_type
    string
  • apprentice_level
    string | null
  • plan_credit_per_hour
    string | null
  • wc_class_code
    string | null
  • resident_state
    string
  • work_state
    string
  • w4
    object | null
  • state_w4
    object | null
  • birth_year
    integer | null
  • address
    string | null
  • city
    string | null
  • state
    string | null
  • zip
    string | null
  • payment_method
    string
  • ssn_masked
    string | nullrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | null
  • has_bank_routing
    boolean
  • deductions
    Deduction[]
  • revealed
    object
  • resident_locality
    string | null
  • reciprocity_states
    string[]
  • pending_rate_change_id
    integer | null
  • pending_bank_change_id
    integer | null
  • flsa_exempt
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}

Show an employee

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • reveal
    booleanquery

Response · 200 · Employee

  • id
    integerrequired
  • number
    stringrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • middle_initial
    string | null
  • user_id
    integer | null
  • workforce_person_id
    integer | null
  • status
    string
  • hire_date
    string | null
  • term_date
    string | null
  • pay_group_id
    integerrequired
  • pay_group_code
    string | null
  • pay_type
    stringrequired
  • hourly_rate
    string | null
  • salary_per_period
    string | null
  • salary_allocation
    array | null
  • union_local_id
    integer | null
  • home_local_code
    string | null
  • classification
    string | null
  • worker_type
    string
  • apprentice_level
    string | null
  • plan_credit_per_hour
    string | null
  • wc_class_code
    string | null
  • resident_state
    string
  • work_state
    string
  • w4
    object | null
  • state_w4
    object | null
  • birth_year
    integer | null
  • address
    string | null
  • city
    string | null
  • state
    string | null
  • zip
    string | null
  • payment_method
    string
  • ssn_masked
    string | nullrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | null
  • has_bank_routing
    boolean
  • deductions
    Deduction[]
  • revealed
    object
  • resident_locality
    string | null
  • reciprocity_states
    string[]
  • pending_rate_change_id
    integer | null
  • pending_bank_change_id
    integer | null
  • flsa_exempt
    booleanrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}

Update an employee

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • employee
    objectrequired

Response · 200 · Employee

  • id
    integerrequired
  • number
    stringrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • middle_initial
    string | null
  • user_id
    integer | null
  • workforce_person_id
    integer | null
  • status
    string
  • hire_date
    string | null
  • term_date
    string | null
  • pay_group_id
    integerrequired
  • pay_group_code
    string | null
  • pay_type
    stringrequired
  • hourly_rate
    string | null
  • salary_per_period
    string | null
  • salary_allocation
    array | null
  • union_local_id
    integer | null
  • home_local_code
    string | null
  • classification
    string | null
  • worker_type
    string
  • apprentice_level
    string | null
  • plan_credit_per_hour
    string | null
  • wc_class_code
    string | null
  • resident_state
    string
  • work_state
    string
  • w4
    object | null
  • state_w4
    object | null
  • birth_year
    integer | null
  • address
    string | null
  • city
    string | null
  • state
    string | null
  • zip
    string | null
  • payment_method
    string
  • ssn_masked
    string | nullrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | null
  • has_bank_routing
    boolean
  • deductions
    Deduction[]
  • revealed
    object
  • resident_locality
    string | null
  • reciprocity_states
    string[]
  • pending_rate_change_id
    integer | null
  • pending_bank_change_id
    integer | null
  • flsa_exempt
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}/deductions

Add a deduction, match or garnishment

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • deduction
    objectrequired

Response · 201 · Deduction

  • id
    integerrequired
  • kind
    stringrequired
  • code
    stringrequired
  • type
    stringrequired
  • amount
    string | nullrequired
  • pct_of_gross
    string | nullrequired
  • params
    object | nullrequired
  • is_active
    booleanrequired
DELETE /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}/deductions/{deduction_id}

End a deduction

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • deduction_id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/payroll/employees/{id}/reveal

Reveal an employee SSN and bank numbers

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reason
    stringrequired

Response · 200 · Employee

  • id
    integerrequired
  • number
    stringrequired
  • first_name
    stringrequired
  • last_name
    stringrequired
  • middle_initial
    string | null
  • user_id
    integer | null
  • workforce_person_id
    integer | null
  • status
    string
  • hire_date
    string | null
  • term_date
    string | null
  • pay_group_id
    integerrequired
  • pay_group_code
    string | null
  • pay_type
    stringrequired
  • hourly_rate
    string | null
  • salary_per_period
    string | null
  • salary_allocation
    array | null
  • union_local_id
    integer | null
  • home_local_code
    string | null
  • classification
    string | null
  • worker_type
    string
  • apprentice_level
    string | null
  • plan_credit_per_hour
    string | null
  • wc_class_code
    string | null
  • resident_state
    string
  • work_state
    string
  • w4
    object | null
  • state_w4
    object | null
  • birth_year
    integer | null
  • address
    string | null
  • city
    string | null
  • state
    string | null
  • zip
    string | null
  • payment_method
    string
  • ssn_masked
    string | nullrequired
  • bank_account_masked
    string | nullrequired
  • bank_account_type
    string | null
  • has_bank_routing
    boolean
  • deductions
    Deduction[]
  • revealed
    object
  • resident_locality
    string | null
  • reciprocity_states
    string[]
  • pending_rate_change_id
    integer | null
  • pending_bank_change_id
    integer | null
  • flsa_exempt
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/employers

List payroll employer entities

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · PayrollEmployer[]

  • entity_id
    integerrequired
  • state_account_ids
    objectrequired
  • ach_odfi_routing
    string | nullrequired
  • ach_bank_name
    string | nullrequired
  • ach_account_masked
    string | nullrequired
PUT /rest/v1.0/companies/{company_id}/accounting/payroll/employers/{entity_id}

Set an employer entity's payroll identity

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • entity_id
    integerpathrequired

Request body

  • employer
    objectrequired

Response · 200 · PayrollEmployer

  • entity_id
    integerrequired
  • state_account_ids
    objectrequired
  • ach_odfi_routing
    string | nullrequired
  • ach_bank_name
    string | nullrequired
  • ach_account_masked
    string | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/filings

Mark a payroll return period filed

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • period
    stringrequired
  • filed
    boolean

Response · 200 · object

  • filed_periods
    string[]required
POST /rest/v1.0/companies/{company_id}/accounting/payroll/futa_override

Request or approve a provisional FUTA credit reduction override

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • action
    stringrequired
  • year
    integerrequired
  • reason
    string

Response · 200 · object

  • year
    integer
  • rates
    object
  • reason
    string
  • requested_by_id
    integer
  • approved_by_id
    integer | null
  • approved_at
    string | null
  • status
    string
POST /rest/v1.0/companies/{company_id}/accounting/payroll/manual_checks

Enter a manual (handwritten) check

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • manual_check
    objectrequired

Response · 201 · PayRun

  • id
    integerrequired
  • number
    stringrequired
  • pay_group_id
    integerrequired
  • pay_group_code
    string | nullrequired
  • period_start
    stringrequired
  • period_end
    stringrequired
  • pay_date
    stringrequired
  • status
    stringrequired
  • revision
    integerrequired
  • gross_total
    stringrequired
  • employee_taxes
    stringrequired
  • deductions_total
    stringrequired
  • net_total
    stringrequired
  • employer_cost
    stringrequired
  • check_count
    integer | nullrequired
  • exceptions
    RunException[]required
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | nullrequired
  • posted_at
    string | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • run_type
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/pay_groups

List pay groups

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · PayGroup[]

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • frequency
    stringrequired
  • ot_rule_set
    stringrequired
  • is_active
    booleanrequired
  • employee_count
    integer | nullrequired
  • ot_method
    stringrequired
  • workweek_anchor
    string | null (date)required
  • entity_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/pay_groups

Create a pay group

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • pay_group
    objectrequired

Response · 201 · PayGroup

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • frequency
    stringrequired
  • ot_rule_set
    stringrequired
  • is_active
    booleanrequired
  • employee_count
    integer | nullrequired
  • ot_method
    stringrequired
  • workweek_anchor
    string | null (date)required
  • entity_id
    integer | nullrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/pay_groups/{id}

Update a pay group

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • pay_group
    object

Response · 200 · PayGroup

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • frequency
    stringrequired
  • ot_rule_set
    stringrequired
  • is_active
    booleanrequired
  • employee_count
    integer | nullrequired
  • ot_method
    stringrequired
  • workweek_anchor
    string | null (date)required
  • entity_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/pii_rotation

Rotate payroll PII encryption

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · object

  • rotated
    integerrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/rate_changes

List pay-rate changes

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • employee_id
    integerquery
  • status
    stringquery
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · RateChange[]

  • id
    integerrequired
  • employee_id
    integerrequired
  • kind
    stringrequired
  • changes
    objectrequired
  • status
    stringrequired
  • requested_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • decided_at
    string | nullrequired
  • reason
    string | nullrequired
  • created_at
    stringrequired
  • effective_date
    string | null
POST /rest/v1.0/companies/{company_id}/accounting/payroll/rate_changes/{id}

Approve or reject a pay-rate change

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • approve
    boolean
  • reason
    string | null

Response · 200 · RateChange

  • id
    integerrequired
  • employee_id
    integerrequired
  • kind
    stringrequired
  • changes
    objectrequired
  • status
    stringrequired
  • requested_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • decided_at
    string | nullrequired
  • reason
    string | nullrequired
  • created_at
    stringrequired
  • effective_date
    string | null
GET /rest/v1.0/companies/{company_id}/accounting/payroll/remittances

List payroll liability remittances

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · PayrollRemittance[]

  • id
    integerrequired
  • request_key
    stringrequired
  • account_key
    stringrequired
  • account_id
    integerrequired
  • entity_id
    integerrequired
  • method
    stringrequired
  • bank_account_id
    integer | null
  • ap_bill_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • amount
    stringrequired
  • through_date
    stringrequired
  • paid_date
    stringrequired
  • memo
    string | null
  • created_at
    string
  • status
    stringrequired
  • created_by_id
    integer
  • approved_by_id
    integer | null
  • approved_at
    string | null
POST /rest/v1.0/companies/{company_id}/accounting/payroll/remittances

Remit a payroll liability

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • remittance
    objectrequired

Response · 201 · PayrollRemittance

  • id
    integerrequired
  • request_key
    stringrequired
  • account_key
    stringrequired
  • account_id
    integerrequired
  • entity_id
    integerrequired
  • method
    stringrequired
  • bank_account_id
    integer | null
  • ap_bill_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • amount
    stringrequired
  • through_date
    stringrequired
  • paid_date
    stringrequired
  • memo
    string | null
  • created_at
    string
  • status
    stringrequired
  • created_by_id
    integer
  • approved_by_id
    integer | null
  • approved_at
    string | null
POST /rest/v1.0/companies/{company_id}/accounting/payroll/remittances/{id}/{decision}

Release or reject a pending bank remittance

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • decision
    stringpathrequired

Response · 200 · PayrollRemittance

  • id
    integerrequired
  • request_key
    stringrequired
  • account_key
    stringrequired
  • account_id
    integerrequired
  • entity_id
    integerrequired
  • method
    stringrequired
  • bank_account_id
    integer | null
  • ap_bill_id
    integer | nullrequired
  • journal_entry_id
    integer | nullrequired
  • amount
    stringrequired
  • through_date
    stringrequired
  • paid_date
    stringrequired
  • memo
    string | null
  • created_at
    string
  • status
    stringrequired
  • created_by_id
    integer
  • approved_by_id
    integer | null
  • approved_at
    string | null
GET /rest/v1.0/companies/{company_id}/accounting/payroll/reports/{report}

Payroll tax and remittance data

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • report
    stringpathrequired
  • year
    integerquery
  • quarter
    integerquery
  • month
    stringquery
  • format
    stringquery
  • bso_user_id
    stringquery
  • contact_name
    stringquery
  • contact_phone
    stringquery
  • contact_email
    string (email)query
  • state
    stringquery
  • employer_entity_id
    integerquery

Response · 200 · object | object[]

No documented fields.

GET /rest/v1.0/companies/{company_id}/accounting/payroll/runs

List pay runs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · PayRun[]

  • id
    integerrequired
  • number
    stringrequired
  • pay_group_id
    integerrequired
  • pay_group_code
    string | nullrequired
  • period_start
    stringrequired
  • period_end
    stringrequired
  • pay_date
    stringrequired
  • status
    stringrequired
  • revision
    integerrequired
  • gross_total
    stringrequired
  • employee_taxes
    stringrequired
  • deductions_total
    stringrequired
  • net_total
    stringrequired
  • employer_cost
    stringrequired
  • check_count
    integer | nullrequired
  • exceptions
    RunException[]required
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | nullrequired
  • posted_at
    string | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • run_type
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/runs

Create a pay run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • pay_run
    objectrequired

Response · 201 · PayRun

  • id
    integerrequired
  • number
    stringrequired
  • pay_group_id
    integerrequired
  • pay_group_code
    string | nullrequired
  • period_start
    stringrequired
  • period_end
    stringrequired
  • pay_date
    stringrequired
  • status
    stringrequired
  • revision
    integerrequired
  • gross_total
    stringrequired
  • employee_taxes
    stringrequired
  • deductions_total
    stringrequired
  • net_total
    stringrequired
  • employer_cost
    stringrequired
  • check_count
    integer | nullrequired
  • exceptions
    RunException[]required
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | nullrequired
  • posted_at
    string | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • run_type
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/runs/{id}

Show a pay run

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • explain
    booleanquery

Response · 200 · PayRunShow

  • id
    integerrequired
  • number
    stringrequired
  • pay_group_id
    integerrequired
  • pay_group_code
    string | nullrequired
  • period_start
    stringrequired
  • period_end
    stringrequired
  • pay_date
    stringrequired
  • status
    stringrequired
  • revision
    integerrequired
  • gross_total
    stringrequired
  • employee_taxes
    stringrequired
  • deductions_total
    stringrequired
  • net_total
    stringrequired
  • employer_cost
    stringrequired
  • check_count
    integer | nullrequired
  • exceptions
    RunException[]required
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | nullrequired
  • posted_at
    string | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • run_type
    stringrequired
  • checks
    Check[]required
  • time
    TimeLine[]required
GET /rest/v1.0/companies/{company_id}/accounting/payroll/runs/{id}/{action}

Pay run outputs

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • action
    stringpathrequired
  • format
    stringquery

Response · 200 · Preview | object[]

  • posting_date
    stringrequired
  • journal
    stringrequired
  • memo
    string | nullrequired
  • source_type
    stringrequired
  • source_id
    integer | nullrequired
  • source_revision
    integerrequired
  • lines
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/payroll/runs/{id}/{action}

Pay run workflow step

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired
  • action
    stringpathrequired

Response · 200 · PayRun

  • id
    integerrequired
  • number
    stringrequired
  • pay_group_id
    integerrequired
  • pay_group_code
    string | nullrequired
  • period_start
    stringrequired
  • period_end
    stringrequired
  • pay_date
    stringrequired
  • status
    stringrequired
  • revision
    integerrequired
  • gross_total
    stringrequired
  • employee_taxes
    stringrequired
  • deductions_total
    stringrequired
  • net_total
    stringrequired
  • employer_cost
    stringrequired
  • check_count
    integer | nullrequired
  • exceptions
    RunException[]required
  • prepared_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • approved_at
    string | nullrequired
  • posted_at
    string | nullrequired
  • journal_entry_id
    integer | nullrequired
  • void_reason
    string | nullrequired
  • run_type
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/setup

Show payroll setup

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · Setup

  • tax_provider
    stringrequired
  • tax_providers
    string[]required
  • burden_method
    stringrequired
  • default_ot_rule_set
    stringrequired
  • suta_state
    string | nullrequired
  • suta_rate
    string | nullrequired
  • suta_wage_base
    string | nullrequired
  • state_flat_rates
    objectrequired
  • state_account_ids
    objectrequired
  • account_map
    object[]required
  • employer_ein_masked
    string | nullrequired
  • employer_name
    string | nullrequired
  • employer_address
    string | nullrequired
  • employer_city
    string | nullrequired
  • employer_state
    string | nullrequired
  • employer_zip
    string | nullrequired
  • ach_odfi_routing
    string | nullrequired
  • ach_bank_name
    string | nullrequired
  • ach_account_masked
    string | nullrequired
  • local_flat_rates
    objectrequired
  • sdi_rates
    objectrequired
  • standard_burden_rate
    string | nullrequired
  • burden_true_up_to
    stringrequired
  • per_diem_accountable
    booleanrequired
  • per_diem_federal_rate
    string | nullrequired
  • suta_rates
    object
  • filed_periods
    string[]
PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/setup

Update payroll setup

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • payroll_setup
    objectrequired

Response · 200 · Setup

  • tax_provider
    stringrequired
  • tax_providers
    string[]required
  • burden_method
    stringrequired
  • default_ot_rule_set
    stringrequired
  • suta_state
    string | nullrequired
  • suta_rate
    string | nullrequired
  • suta_wage_base
    string | nullrequired
  • state_flat_rates
    objectrequired
  • state_account_ids
    objectrequired
  • account_map
    object[]required
  • employer_ein_masked
    string | nullrequired
  • employer_name
    string | nullrequired
  • employer_address
    string | nullrequired
  • employer_city
    string | nullrequired
  • employer_state
    string | nullrequired
  • employer_zip
    string | nullrequired
  • ach_odfi_routing
    string | nullrequired
  • ach_bank_name
    string | nullrequired
  • ach_account_masked
    string | nullrequired
  • local_flat_rates
    objectrequired
  • sdi_rates
    objectrequired
  • standard_burden_rate
    string | nullrequired
  • burden_true_up_to
    stringrequired
  • per_diem_accountable
    booleanrequired
  • per_diem_federal_rate
    string | nullrequired
  • suta_rates
    object
  • filed_periods
    string[]
GET /rest/v1.0/companies/{company_id}/accounting/payroll/union_locals

List union locals

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · UnionLocal[]

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • remit_to
    string | nullrequired
  • cba_rules
    object | nullrequired
  • rates
    UnionRate[]required
POST /rest/v1.0/companies/{company_id}/accounting/payroll/union_locals

Create a union local

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • union_local
    objectrequired

Response · 201 · UnionLocal

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • remit_to
    string | nullrequired
  • cba_rules
    object | nullrequired
  • rates
    UnionRate[]required
PATCH /rest/v1.0/companies/{company_id}/accounting/payroll/union_locals/{id}

Update a union local

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • union_local
    objectrequired

Response · 200 · UnionLocal

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • remit_to
    string | nullrequired
  • cba_rules
    object | nullrequired
  • rates
    UnionRate[]required
POST /rest/v1.0/companies/{company_id}/accounting/payroll/union_rates

Add a CBA rate

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • union_rate
    objectrequired

Response · 201 · UnionRate

  • id
    integerrequired
  • local_id
    integerrequired
  • classification
    stringrequired
  • zone
    string | nullrequired
  • effective_from
    stringrequired
  • effective_to
    string | nullrequired
  • wage
    stringrequired
  • benefits
    object[]required
  • apprentice_ratio
    string | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/wage_determinations

List wage determinations

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · WageDetermination[]

  • id
    integerrequired
  • project_id
    integerrequired
  • wd_number
    stringrequired
  • county
    string | nullrequired
  • classification
    stringrequired
  • bhr
    stringrequired
  • fringe
    stringrequired
  • effective_from
    stringrequired
  • effective_to
    string | nullrequired
  • apprentice_ratio
    string | nullrequired
  • dir_project_id
    string | nullrequired
  • awarding_body
    string | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/wage_determinations

Create a wage determination

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • wage_determination
    objectrequired

Response · 201 · WageDetermination

  • id
    integerrequired
  • project_id
    integerrequired
  • wd_number
    stringrequired
  • county
    string | nullrequired
  • classification
    stringrequired
  • bhr
    stringrequired
  • fringe
    stringrequired
  • effective_from
    stringrequired
  • effective_to
    string | nullrequired
  • apprentice_ratio
    string | nullrequired
  • dir_project_id
    string | nullrequired
  • awarding_body
    string | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/payroll/wc_classes

List workers' comp classes

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · WcClass[]

  • id
    integerrequired
  • state
    stringrequired
  • code
    stringrequired
  • name
    stringrequired
  • rate_per_100
    string | nullrequired
  • rate_per_hour
    string | nullrequired
  • exclude_ot_premium
    booleanrequired
  • effective_from
    stringrequired
POST /rest/v1.0/companies/{company_id}/accounting/payroll/wc_classes

Create a wc class

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • wc_class
    objectrequired

Response · 201 · WcClass

  • id
    integerrequired
  • state
    stringrequired
  • code
    stringrequired
  • name
    stringrequired
  • rate_per_100
    string | nullrequired
  • rate_per_hour
    string | nullrequired
  • exclude_ot_premium
    booleanrequired
  • effective_from
    stringrequired
GET /rest/v1.0/companies/{company_id}/accounting/periods

List fiscal periods

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • filters[fiscal_year]
    integerquery
  • filters[status]
    stringquery

Response · 200 · Period[]

  • id
    integerrequired
  • fiscal_year_id
    integerrequired
  • fiscal_year
    integer | nullrequired
  • number
    integerrequired
  • name
    stringrequired
  • start_date
    string (date)required
  • end_date
    string (date)required
  • status
    anyrequired
  • module_status
    objectrequired
  • closed_at
    string | null (date-time)required
  • closed_by_id
    integer | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/periods/{id}

Show a fiscal period

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · Period

  • id
    integerrequired
  • fiscal_year_id
    integerrequired
  • fiscal_year
    integer | nullrequired
  • number
    integerrequired
  • name
    stringrequired
  • start_date
    string (date)required
  • end_date
    string (date)required
  • status
    anyrequired
  • module_status
    objectrequired
  • closed_at
    string | null (date-time)required
  • closed_by_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/periods/{id}/close

Close or soft-close a period

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • close
    objectrequired

Response · 200 · Period

  • id
    integerrequired
  • fiscal_year_id
    integerrequired
  • fiscal_year
    integer | nullrequired
  • number
    integerrequired
  • name
    stringrequired
  • start_date
    string (date)required
  • end_date
    string (date)required
  • status
    anyrequired
  • module_status
    objectrequired
  • closed_at
    string | null (date-time)required
  • closed_by_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/periods/{id}/eliminate_intercompany

Eliminate intercompany at a period end

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · EliminationRun

  • journal_entry
    JournalEntryShow | nullrequired
  • created
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/periods/{id}/reopen

Reopen a period

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • reopen
    objectrequired

Response · 200 · Period

  • id
    integerrequired
  • fiscal_year_id
    integerrequired
  • fiscal_year
    integer | nullrequired
  • number
    integerrequired
  • name
    stringrequired
  • start_date
    string (date)required
  • end_date
    string (date)required
  • status
    anyrequired
  • module_status
    objectrequired
  • closed_at
    string | null (date-time)required
  • closed_by_id
    integer | nullrequired
POST /rest/v1.0/companies/{company_id}/accounting/periods/rebuild_balances

Rebuild period balance snapshots

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • reason
    stringrequired

Response · 200 · object

  • corrected
    integerrequired
  • rows
    integerrequired
POST /rest/v1.0/companies/{company_id}/accounting/pii_rotation

Rotate vendor and bank PII encryption

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · object

  • rotated
    integerrequired
GET /rest/v1.0/companies/{company_id}/accounting/recurring_journals

List recurring journals

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · RecurringJournal[]

  • id
    integerrequired
  • entity_id
    integerrequired
  • name
    stringrequired
  • memo
    string | nullrequired
  • journal
    stringrequired
  • frequency
    anyrequired
  • interval
    integerrequired
  • day_of_month
    integer | nullrequired
  • start_date
    string (date)required
  • end_date
    string | null (date)required
  • next_run_date
    string (date)required
  • last_run_date
    string | null (date)required
  • reverse_after_days
    integer | nullrequired
  • auto_post
    booleanrequired
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • total_amount
    stringrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • last_error
    string | nullrequired
  • last_error_at
    string | null (date-time)required
POST /rest/v1.0/companies/{company_id}/accounting/recurring_journals

Create a recurring journal

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • recurring_journal
    objectrequired

Response · 201 · RecurringJournal

  • id
    integerrequired
  • entity_id
    integerrequired
  • name
    stringrequired
  • memo
    string | nullrequired
  • journal
    stringrequired
  • frequency
    anyrequired
  • interval
    integerrequired
  • day_of_month
    integer | nullrequired
  • start_date
    string (date)required
  • end_date
    string | null (date)required
  • next_run_date
    string (date)required
  • last_run_date
    string | null (date)required
  • reverse_after_days
    integer | nullrequired
  • auto_post
    booleanrequired
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • total_amount
    stringrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • last_error
    string | nullrequired
  • last_error_at
    string | null (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}

Show a recurring journal

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · RecurringJournal

  • id
    integerrequired
  • entity_id
    integerrequired
  • name
    stringrequired
  • memo
    string | nullrequired
  • journal
    stringrequired
  • frequency
    anyrequired
  • interval
    integerrequired
  • day_of_month
    integer | nullrequired
  • start_date
    string (date)required
  • end_date
    string | null (date)required
  • next_run_date
    string (date)required
  • last_run_date
    string | null (date)required
  • reverse_after_days
    integer | nullrequired
  • auto_post
    booleanrequired
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • total_amount
    stringrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • last_error
    string | nullrequired
  • last_error_at
    string | null (date-time)required
PATCH /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}

Update a recurring journal

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • recurring_journal
    objectrequired

Response · 200 · RecurringJournal

  • id
    integerrequired
  • entity_id
    integerrequired
  • name
    stringrequired
  • memo
    string | nullrequired
  • journal
    stringrequired
  • frequency
    anyrequired
  • interval
    integerrequired
  • day_of_month
    integer | nullrequired
  • start_date
    string (date)required
  • end_date
    string | null (date)required
  • next_run_date
    string (date)required
  • last_run_date
    string | null (date)required
  • reverse_after_days
    integer | nullrequired
  • auto_post
    booleanrequired
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • total_amount
    stringrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • last_error
    string | nullrequired
  • last_error_at
    string | null (date-time)required
DELETE /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}

Delete a recurring journal

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 204

No response body.

POST /rest/v1.0/companies/{company_id}/accounting/recurring_journals/{id}/approve

Approve a recurring journal

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Response · 200 · RecurringJournal

  • id
    integerrequired
  • entity_id
    integerrequired
  • name
    stringrequired
  • memo
    string | nullrequired
  • journal
    stringrequired
  • frequency
    anyrequired
  • interval
    integerrequired
  • day_of_month
    integer | nullrequired
  • start_date
    string (date)required
  • end_date
    string | null (date)required
  • next_run_date
    string (date)required
  • last_run_date
    string | null (date)required
  • reverse_after_days
    integer | nullrequired
  • auto_post
    booleanrequired
  • is_active
    booleanrequired
  • created_by_id
    integerrequired
  • approved_by_id
    integer | nullrequired
  • total_amount
    stringrequired
  • lines
    object[]required
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • last_error
    string | nullrequired
  • last_error_at
    string | null (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/reports

Report library

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · ReportDef[]

  • key
    anyrequired
  • title
    stringrequired
  • group
    stringrequired
  • description
    stringrequired
  • params
    any[]required
GET /rest/v1.0/companies/{company_id}/accounting/reports/{report_key}

Run a report

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • report_key
    anypathrequired
  • as_of
    string (date)query
  • from
    string (date)query
  • to
    string (date)query
  • adj_from
    string (date)query
  • compare
    anyquery
  • budget_id
    integerquery
  • columns
    anyquery
  • entity_id
    integerquery
  • project_id
    integerquery
  • department_id
    integerquery
  • account_id
    integerquery
  • journal
    anyquery
  • basis
    anyquery
  • include_zero
    anyquery
  • jtd
    stringquery
  • actor_id
    integerquery
  • item_type
    stringquery
  • action
    stringquery
  • rollup
    stringquery

Response · 200 · ReportDoc

  • key
    anyrequired
  • title
    stringrequired
  • subtitle
    stringrequired
  • params
    objectrequired
  • columns
    object[]required
  • rows
    object[]required
  • checks
    object[]required
  • notes
    string[]required
  • explain
    object[]required
  • generatedAt
    string (date-time)required
GET /rest/v1.0/companies/{company_id}/accounting/reports/{report_key}/export

Export a report

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • report_key
    anypathrequired
  • format
    anyquery
  • as_of
    string (date)query
  • from
    string (date)query
  • to
    string (date)query
  • adj_from
    string (date)query
  • compare
    anyquery
  • budget_id
    integerquery
  • columns
    anyquery
  • entity_id
    integerquery
  • project_id
    integerquery
  • department_id
    integerquery
  • account_id
    integerquery
  • journal
    anyquery
  • basis
    anyquery
  • include_zero
    anyquery
  • jtd
    stringquery
  • actor_id
    integerquery
  • item_type
    stringquery
  • action
    stringquery
  • rollup
    stringquery

Response · 200 · string

No documented fields.

GET /rest/v1.0/companies/{company_id}/accounting/settings

Show accounting settings

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · Settings

  • company_id
    integerrequired
  • base_currency
    stringrequired
  • fiscal_year_start_month
    integerrequired
  • default_entity_id
    integer | nullrequired
  • posting_method
    anyrequired
  • require_approval_above
    string | nullrequired
  • recon_adjustment_limit
    string | nullrequired
  • timezone
    stringrequired
  • control_accounts
    object[]required
  • updated_at
    string (date-time)required
  • loss_provision_unit
    stringrequired
  • finance_charge_monthly_pct
    string | nullrequired
  • finance_charge_grace_days
    integerrequired
  • finance_charge_account_id
    integer | nullrequired
  • cecl_policy
    object | nullrequired
  • sod_mode
    anyrequired
  • scheduler_user_id
    integer | nullrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/settings

Update accounting settings

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • settings
    objectrequired

Response · 200 · Settings

  • company_id
    integerrequired
  • base_currency
    stringrequired
  • fiscal_year_start_month
    integerrequired
  • default_entity_id
    integer | nullrequired
  • posting_method
    anyrequired
  • require_approval_above
    string | nullrequired
  • recon_adjustment_limit
    string | nullrequired
  • timezone
    stringrequired
  • control_accounts
    object[]required
  • updated_at
    string (date-time)required
  • loss_provision_unit
    stringrequired
  • finance_charge_monthly_pct
    string | nullrequired
  • finance_charge_grace_days
    integerrequired
  • finance_charge_account_id
    integer | nullrequired
  • cecl_policy
    object | nullrequired
  • sod_mode
    anyrequired
  • scheduler_user_id
    integer | nullrequired
GET /rest/v1.0/companies/{company_id}/accounting/tax_codes

List tax codes

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · TaxCode[]

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • kind
    anyrequired
  • is_active
    booleanrequired
  • total_rate
    stringrequired
  • components
    object[]required
POST /rest/v1.0/companies/{company_id}/accounting/tax_codes

Create a tax code

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • tax_code
    objectrequired

Response · 201 · TaxCode

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • kind
    anyrequired
  • is_active
    booleanrequired
  • total_rate
    stringrequired
  • components
    object[]required
PATCH /rest/v1.0/companies/{company_id}/accounting/tax_codes/{id}

Update a tax code

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • tax_code
    objectrequired

Response · 200 · TaxCode

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • kind
    anyrequired
  • is_active
    booleanrequired
  • total_rate
    stringrequired
  • components
    object[]required
GET /rest/v1.0/companies/{company_id}/accounting/tax_exemption_certificates

List customer tax exemption certificates

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • customer_id
    integerquery

Response · 200 · TaxExemptionCertificate[]

  • id
    integerrequired
  • customer_id
    integerrequired
  • state_code
    stringrequired
  • certificate_number
    stringrequired
  • reason
    stringrequired
  • effective_from
    string (date)required
  • expires_on
    string (date)required
POST /rest/v1.0/companies/{company_id}/accounting/tax_exemption_certificates

Record a customer tax exemption certificate

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Request body

  • certificate
    objectrequired

Response · 201 · TaxExemptionCertificate

  • id
    integerrequired
  • customer_id
    integerrequired
  • state_code
    stringrequired
  • certificate_number
    stringrequired
  • reason
    stringrequired
  • effective_from
    string (date)required
  • expires_on
    string (date)required
PATCH /rest/v1.0/companies/{company_id}/accounting/tax_exemption_certificates/{id}

Change a certificate expiry

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • certificate
    objectrequired

Response · 200 · TaxExemptionCertificate

  • id
    integerrequired
  • customer_id
    integerrequired
  • state_code
    stringrequired
  • certificate_number
    stringrequired
  • reason
    stringrequired
  • effective_from
    string (date)required
  • expires_on
    string (date)required
GET /rest/v1.0/companies/{company_id}/accounting/terms

List payment terms

v1.0Implemented

Parameters

  • company_id
    integerpathrequired

Response · 200 · Term[]

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • due_days
    integerrequired
  • discount_percent
    string | nullrequired
  • discount_days
    integer | nullrequired
  • is_active
    booleanrequired
POST /rest/v1.0/companies/{company_id}/accounting/terms

Create a payment term

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • Idempotency-Key
    stringheader

Request body

  • term
    objectrequired

Response · 201 · Term

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • due_days
    integerrequired
  • discount_percent
    string | nullrequired
  • discount_days
    integer | nullrequired
  • is_active
    booleanrequired
PATCH /rest/v1.0/companies/{company_id}/accounting/terms/{id}

Update a payment term

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • id
    integerpathrequired

Request body

  • term
    objectrequired

Response · 200 · Term

  • id
    integerrequired
  • code
    stringrequired
  • name
    stringrequired
  • due_days
    integerrequired
  • discount_percent
    string | nullrequired
  • discount_days
    integer | nullrequired
  • is_active
    booleanrequired
GET /rest/v1.0/companies/{company_id}/accounting/trial_balance

Trial balance

v1.0Implemented

Parameters

  • company_id
    integerpathrequired
  • as_of
    string (date)query
  • from
    string (date)query
  • entity_id
    integerquery
  • project_id
    integerquery
  • department_id
    integerquery
  • group_by
    anyquery
  • include_zero
    anyquery

Response · 200 · TrialBalance

  • as_of
    string (date)required
  • from
    string | null (date)required
  • entity_id
    integer | nullrequired
  • group_by
    anyrequired
  • rows
    object[]required
  • totals
    objectrequired

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file