Skip to main content
New to Corsair? See API access, authentication, and error handling.

Company

businessCategories

company.businessCategories List the documented business categories for company profiles Risk: read
Input: empty object Output

get

company.get Get the authenticated company profile Risk: read
Input: empty object Output

taxTimeline

company.taxTimeline List upcoming tax events and due dates for the company Risk: read
Input: empty object Output

Contacts

create

contacts.create Create a contact using documented contact fields Risk: write
Input
Output

delete

contacts.delete Delete a contact Risk: destructive
Input Output: object \| undefined

get

contacts.get Get a contact by its FreeAgent ID Risk: read
Input Output

list

contacts.list List contacts with documented filters and pagination Risk: read
Input FreeAgent paginates collections with a default of 25 records and a maximum per_page of 100. The result includes pagination.link and pagination.total_count, preserving the Link header and X-Total-Count header value respectively.
Output

update

contacts.update Update documented fields on a contact Risk: write
Input
Output: object \| undefined

Email Addresses

list

emailAddresses.list List verified sender email addresses for the company Risk: read
Input Returns the company’s verified sender email addresses. The result includes pagination.link and pagination.total_count from FreeAgent’s collection headers.
Output

Invoices

convertToCreditNote

invoices.convertToCreditNote Convert a draft negative invoice into a credit note Risk: destructive
Input Output

create

invoices.create Create an invoice in Draft status Risk: write
Input FreeAgent creates new invoices in Draft status. Use an explicit status-transition operation to mark an invoice sent; this plugin currently exposes markSent.
Output

delete

invoices.delete Delete an invoice Risk: destructive
Input Output: object \| undefined

deleteDefaultAdditionalText

invoices.deleteDefaultAdditionalText Remove the default additional text from company invoices Risk: write
Input: empty object Output: object \| undefined

directDebit

invoices.directDebit Take payment using an eligible GoCardless mandate Risk: destructive
Input This requests a real GoCardless payment and is available only for sent invoices with an enabled pre-authorised mandate and no previous payment. Output: object \| undefined

duplicate

invoices.duplicate Duplicate an invoice as a new draft using the next reference Risk: write
Input Output

get

invoices.get Get an invoice by its FreeAgent ID Risk: read
Input Output

getDefaultAdditionalText

invoices.getDefaultAdditionalText Get the default additional text for company invoices Risk: read
Input: empty object Output

list

invoices.list List invoices with documented filters and pagination Risk: read
Input
Output

markCancelled

invoices.markCancelled Cancel and write off an eligible sent invoice Risk: destructive
Input Output: object \| undefined

markDraft

invoices.markDraft Return an invoice to Draft status Risk: destructive
Input Output: object \| undefined

markScheduled

invoices.markScheduled Schedule an invoice to be emailed Risk: destructive
Input Output: object \| undefined

markSent

invoices.markSent Mark an invoice as sent or reopen a cancelled invoice Risk: destructive
Input Output: object \| undefined

pdf

invoices.pdf Get the invoice PDF as base64 encoded JSON content Risk: read
Input FreeAgent returns PDF bytes as base64 in pdf.content; decode that value to obtain the PDF file. Output

sendEmail

invoices.sendEmail Send an invoice email to its recipient Risk: destructive
Input Sending an invoice email is a separate action from marking the invoice sent. The operation accepts the documented template flag, message fields, and base64 attachments up to 5 MiB each.
Output: object \| undefined

timeline

invoices.timeline List invoice timeline entries Risk: read
Input: empty object Output

update

invoices.update Update an invoice without changing its status Risk: write
Input
Output: object \| undefined

updateDefaultAdditionalText

invoices.updateDefaultAdditionalText Update the default additional text for company invoices Risk: write
Input Output

Projects

create

projects.create Create a project with documented project fields Risk: write
Input
Output

delete

projects.delete Delete a project Risk: destructive
Input Output: object \| undefined

get

projects.get Get a project by its FreeAgent ID Risk: read
Input Output

list

projects.list List projects with documented filters and pagination Risk: read
Input
Output

update

projects.update Update documented fields on a project Risk: write
Input
Output: object \| undefined

Recurring Invoices

get

recurringInvoices.get Get a recurring invoice by its FreeAgent ID Risk: read
Input Output

list

recurringInvoices.list List recurring invoices with documented filters and pagination Risk: read
Input Supports the documented draft, active, or inactive view filter and a contact URL filter. Collection pagination uses the standard page and per_page parameters.
Output

Tracking Groups

get

trackingGroups.get Get a tracking group and its labels by FreeAgent ID Risk: read
Input Output

list

trackingGroups.list List tracking groups with documented filters and pagination Risk: read
Input Hidden groups and labels are omitted by default. Use include_hidden, order_by, and reverse as documented; collection pagination uses page and per_page.
Output