API coverage

This reference lists FreeAgent API resources implemented in the SDK today. It reflects actual code, not planned work.

For how resources relate to each other and a suggested implementation order, see the API entity map.

Implemented resources

Resource SDK entry point FreeAgent docs
Company client.Company Company
Contacts client.Contacts Contacts
Categories client.Categories Categories
Users client.Users Users
Projects client.Projects Projects
Invoices client.Invoices Invoices
Estimates client.Estimates Estimates
Recurring invoices client.RecurringInvoices Recurring invoices
Credit notes client.CreditNotes Credit notes
Credit note reconciliations client.CreditNoteReconciliations Credit note reconciliations
Stock items client.StockItems Stock items
Price list items client.PriceListItems Price list items
Tasks client.ProjectTasks Tasks
Timeslips client.Timeslips Timeslips
Notes client.Notes Notes
Email addresses client.EmailAddresses Email addresses
OAuth FreeAgentOAuthClient OAuth
Currency code CurrencyCode enum Currencies

Not yet implemented

Resources described in the API entity map but not yet implemented in the SDK are tracked via GitHub Issues.


Table of contents


Copyright © Mark Heydon. Distributed under the MIT licence.

This site uses Just the Docs, a documentation theme for Jekyll.