FreeAgent
Accounting and invoicing software for small businesses
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.freeagent.com/ | link | — | — | — |
Actions (31)
Invoices · 25
- Convert invoice to credit notePUT /v2/invoices/{id}/transitions/convert_to_credit_note
Convert a draft negative invoice into a credit note.
documented - Create invoicePOST /v2/invoices
Create a new invoice (defaults to Draft).
documented - Delete default additional textDELETE /v2/invoices/default_additional_text
Remove the default additional text setting.
documented - Delete default additional textDELETE /v2/invoices/default_additional_text
Delete the default additional text setting.
documented - Delete invoiceDELETE /v2/invoices/{id}
Delete an invoice.
documented - Duplicate invoicePOST /v2/invoices/{id}/duplicate
Create a copy of an existing invoice (as Draft).
documented - Email invoicePOST /v2/invoices/{id}/send_email
Send the invoice by email using a template or custom body.
documented - Get default additional textGET /v2/invoices/default_additional_text
Retrieve the default text shown on all invoices.
documented - Get default additional textGET /v2/invoices/default_additional_text
Retrieve the default text shown on invoices.
documented - Get invoiceGET /v2/invoices/{id}
Retrieve a single invoice by ID.
documented - Get invoice PDFGET /v2/invoices/{id}/pdf
Retrieve the invoice as a PDF (base64 payload).
documented - Get invoice timelineGET /v2/invoices/timeline
Retrieve the timeline of invoice events.
documented - List invoicesGET /v2/invoices
Return all invoices (with various view filters).
documented - List invoices by contactGET /v2/invoices?contact={contact_url}
List invoices related to a specific contact.
documented - List invoices by projectGET /v2/invoices?project={project_url}
List invoices related to a specific project.
documented - List invoices with nested invoice itemsGET /v2/invoices?nested_invoice_items=true
List invoices including their nested invoice items.
documented - Mark invoice as cancelledPUT /v2/invoices/{id}/transitions/mark_as_cancelled
Transition invoice status to Cancelled.
documented - Mark invoice as draftPUT /v2/invoices/{id}/transitions/mark_as_draft
Transition invoice status to Draft.
documented - Mark invoice as scheduledPUT /v2/invoices/{id}/transitions/mark_as_scheduled
Transition invoice status to Scheduled.
documented - Mark invoice as sentPUT /v2/invoices/{id}/transitions/mark_as_sent
Transition invoice status to Sent.
documented - Take payment via GoCardless Direct DebitPOST /v2/invoices/{id}/direct_debit
Initiate a GoCardless Direct Debit payment for the invoice.
documented - Update default additional textPUT /v2/invoices/default_additional_text
Set the default additional text for invoices.
documented - Update default additional textPUT /v2/invoices/default_additional_text
Update the default text shown on invoices.
documented - Update invoicePUT /v2/invoices/{id}
Update an existing invoice (transitions available for status changes).
documented - Update invoice itemsPUT /v2/invoices/{id}
Update the list of invoice items for an invoice (nested within the invoice payload).
documented
Contacts · 5
- Create contactPOST /v2/contacts
Create a new contact.
documented - Delete contactDELETE /v2/contacts/{id}
Delete a contact.
documented - Get contactGET /v2/contacts/{id}
Retrieve a single contact by its ID.
documented - List contactsGET /v2/contacts
Return a list of contacts (clients, suppliers, and others).
documented - Update contactPUT /v2/contacts/{id}
Update an existing contact.
documented