{"info":{"title":"ac-co.ai Public API","description":"Client-facing API gateway for ac-co.ai — legal entities, businesses, landlord/assets, accounting, banking (read-only), document vault, billing (read-only), and periods/obligations. A restricted `hmrc.*` subtree is forwarded to the HMRC service (see its section below).","version":"1.0.0"},"servers":[{"url":"https://api.ac-co.ai/api/rpc","description":"Public API"}],"openapi":"3.1.1","paths":{"/legalEntity/getLegalEntities":{"get":{"operationId":"legalEntity.getLegalEntities","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/legalEntity/getLegalEntity":{"get":{"operationId":"legalEntity.getLegalEntity","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/legalEntity/createLegalEntity":{"post":{"operationId":"legalEntity.createLegalEntity","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/legalEntity/updateLegalEntity":{"post":{"operationId":"legalEntity.updateLegalEntity","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/list":{"get":{"operationId":"businesses.list","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/get":{"get":{"operationId":"businesses.get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/businessPnl":{"get":{"operationId":"businesses.businessPnl","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/create":{"post":{"operationId":"businesses.create","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/update":{"post":{"operationId":"businesses.update","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/archive":{"post":{"operationId":"businesses.archive","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/setStatus":{"post":{"operationId":"businesses.setStatus","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/businesses/syncHmrcBusiness":{"post":{"operationId":"businesses.syncHmrcBusiness","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/listPortfolios":{"get":{"operationId":"assets.listPortfolios","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/getPortfolio":{"get":{"operationId":"assets.getPortfolio","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/listAccounts":{"get":{"operationId":"assets.listAccounts","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/getAccount":{"get":{"operationId":"assets.getAccount","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/listInstruments":{"get":{"operationId":"assets.listInstruments","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/searchInstruments":{"get":{"operationId":"assets.searchInstruments","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/listPositions":{"get":{"operationId":"assets.listPositions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/listTransactions":{"get":{"operationId":"assets.listTransactions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/listIncomeEvents":{"get":{"operationId":"assets.listIncomeEvents","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/createPortfolio":{"post":{"operationId":"assets.createPortfolio","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/updatePortfolio":{"post":{"operationId":"assets.updatePortfolio","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/createAccount":{"post":{"operationId":"assets.createAccount","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/updateAccount":{"post":{"operationId":"assets.updateAccount","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/assets/createTransaction":{"post":{"operationId":"assets.createTransaction","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/getDashboardSummary":{"get":{"operationId":"landlord.getDashboardSummary","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listProperties":{"get":{"operationId":"landlord.listProperties","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listLinkedTransactions":{"get":{"operationId":"landlord.listLinkedTransactions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/getProperty":{"get":{"operationId":"landlord.getProperty","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listTenants":{"get":{"operationId":"landlord.listTenants","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listTenancies":{"get":{"operationId":"landlord.listTenancies","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listMortgages":{"get":{"operationId":"landlord.listMortgages","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listPropertyUnits":{"get":{"operationId":"landlord.listPropertyUnits","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listPropertyValuations":{"get":{"operationId":"landlord.listPropertyValuations","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/listCertificates":{"get":{"operationId":"landlord.listCertificates","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/propertyPnl":{"get":{"operationId":"landlord.propertyPnl","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/createProperty":{"post":{"operationId":"landlord.createProperty","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/updateProperty":{"post":{"operationId":"landlord.updateProperty","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/createTenant":{"post":{"operationId":"landlord.createTenant","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/createTenancy":{"post":{"operationId":"landlord.createTenancy","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/createMortgage":{"post":{"operationId":"landlord.createMortgage","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/createPropertyUnit":{"post":{"operationId":"landlord.createPropertyUnit","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/updatePropertyUnit":{"post":{"operationId":"landlord.updatePropertyUnit","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/createPropertyValuation":{"post":{"operationId":"landlord.createPropertyValuation","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/createCertificate":{"post":{"operationId":"landlord.createCertificate","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/updateCertificate":{"post":{"operationId":"landlord.updateCertificate","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/landlord/deleteCertificate":{"post":{"operationId":"landlord.deleteCertificate","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/invoices":{"get":{"operationId":"accounting.listInvoices","summary":"List invoices for the org","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"post":{"operationId":"accounting.createInvoice","summary":"Create a system invoice","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/clients":{"get":{"operationId":"accounting.listClients","summary":"List billing clients for the org","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"post":{"operationId":"accounting.createClient","summary":"Create a billing client","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/institutions":{"get":{"operationId":"banking.listInstitutions","summary":"List GoCardless institutions","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/accounts/:accountId":{"get":{"operationId":"banking.getAccountDetails","summary":"Get bank account details","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/accounts/:accountId/transactions":{"get":{"operationId":"banking.getTransactions","summary":"Get bank account transactions from database","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/folders":{"get":{"operationId":"vault.getFolders","summary":"Get folders for organization","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"post":{"operationId":"vault.createFolder","summary":"Create a new folder","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/folders/:folderId/documents":{"get":{"operationId":"vault.getFolderDocuments","summary":"Get documents in a specific folder","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId/download":{"get":{"operationId":"vault.getDocumentDownloadUrl","summary":"Get a temporary download URL for a document","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/recent":{"get":{"operationId":"vault.getRecentDocuments","summary":"Get recently accessed documents","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/starred":{"get":{"operationId":"vault.getStarredDocuments","summary":"Get starred documents","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/root":{"get":{"operationId":"vault.getOrganizationDocuments","summary":"Get documents in the root directory","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/search":{"post":{"operationId":"vault.searchDocuments","summary":"Hybrid text/vector search over organization documents","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/failed-count":{"get":{"operationId":"vault.countFailedDocuments","summary":"Count documents whose latest parse attempt failed","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId/temporal-link":{"post":{"operationId":"vault.generateTemporalLink","summary":"Generate a temporal or permanent link","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents":{"post":{"operationId":"vault.createDocumentRecord","summary":"Create a document record and get upload URL","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/folders/:folderId/name":{"patch":{"operationId":"vault.updateFolderName","summary":"Rename a folder","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/folders/:folderId":{"delete":{"operationId":"vault.deleteFolder","summary":"Delete a folder and its contents","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId":{"delete":{"operationId":"vault.deleteDocument","summary":"Delete a document","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}},"patch":{"operationId":"vault.updateDocument","summary":"Update a document's name, folder, or starred status in one call","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId/star":{"patch":{"operationId":"vault.toggleDocumentStar","summary":"Toggle a document's star status","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId/folder":{"patch":{"operationId":"vault.updateDocumentFolder","summary":"Move a document to a different folder","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/folders/:folderId/parent":{"patch":{"operationId":"vault.updateFolderParent","summary":"Move a folder to a different parent","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId/thumbnail":{"patch":{"operationId":"vault.setDocumentThumbnailUrl","summary":"Set a document's thumbnail URL","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId/cache-thumbnail":{"post":{"operationId":"vault.generateAndCacheThumbnail","summary":"Generate and cache a thumbnail for a document","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/:documentId/contract":{"patch":{"operationId":"vault.updateDocumentContractId","summary":"Update a document with a contract ID","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/vault/documents/bulk-move":{"patch":{"operationId":"vault.bulkMoveDocuments","summary":"Move multiple documents to a folder in one call","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/billing/balance":{"get":{"operationId":"billing.getBalance","summary":"Get credit balance for the current organization","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/billing/ledger":{"get":{"operationId":"billing.getLedger","summary":"Get credit transaction history","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/billing/usage":{"get":{"operationId":"billing.getUsageSummary","summary":"Get daily usage summary","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/billing/plans":{"get":{"operationId":"billing.getPlans","summary":"Get available billing plans","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/billing/costs":{"get":{"operationId":"billing.getOperationCosts","summary":"Get credit costs per operation","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/periods/list":{"get":{"operationId":"periods.list","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/periods/get":{"get":{"operationId":"periods.get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/obligations/list":{"get":{"operationId":"obligations.list","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/obligations/get":{"get":{"operationId":"obligations.get","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/vat/getObligations":{"get":{"operationId":"vat.getObligations","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/vat/getLiabilities":{"get":{"operationId":"vat.getLiabilities","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/vat/getPayments":{"get":{"operationId":"vat.getPayments","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/vat/getVatReturn":{"get":{"operationId":"vat.getVatReturn","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/itsaStatus/get":{"get":{"operationId":"itsaStatus.get","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/itsaObligations/list":{"get":{"operationId":"itsaObligations.list","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/itsaCalculations/list":{"get":{"operationId":"itsaCalculations.list","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/itsaCalculations/get":{"get":{"operationId":"itsaCalculations.get","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/selfAssessment/listTaxYears":{"get":{"operationId":"selfAssessment.listTaxYears","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}},"/hmrc/selfAssessment/getFilingSummary":{"get":{"operationId":"selfAssessment.getFilingSummary","description":"RESTRICTED: requires hmrc:* scope granted after manual approval. HMRC compliance (fraud prevention headers, vendor terms) is the API client's responsibility.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"anyOf":[{},{"not":{}}]}}}}}}}},"security":[{"oauth2":[]},{"apiKey":[]}],"components":{"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://auth.ac-co.ai/api/auth/oauth2/authorize","tokenUrl":"https://auth.ac-co.ai/api/auth/oauth2/token","scopes":{"openid":"Verify who you are so you can sign in.","entities:read":"View your legal entities and activities.","entities:write":"Create and update your legal entities and activities.","accounting:read":"View invoices, quotes, counterparties, transactions, and reports.","accounting:write":"Create and update invoices, quotes, counterparties, and transactions.","banking:read":"View connected bank accounts and their transactions.","vault:read":"View documents stored in your document vault.","vault:write":"Upload and update documents in your document vault.","billing:read":"View billing, subscription, and credits information.","periods:read":"View accounting period status and close state.","hmrc:read":"View HMRC filing status and submissions. Restricted — requires manual approval; HMRC compliance obligations apply.","hmrc:write":"Submit filings to HMRC on your behalf. Restricted — requires manual approval; HMRC compliance obligations apply."}}}},"apiKey":{"type":"http","scheme":"bearer","description":"A self-service `ac_…` API key created in Settings → Developers."}}}}