Company
businessCategories
company.businessCategories
List the documented business categories for company profiles
Risk: read
get
company.get
Get the authenticated company profile
Risk: read
taxTimeline
company.taxTimeline
List upcoming tax events and due dates for the company
Risk: read
timeline_items full type
timeline_items full type
Contacts
create
contacts.create
Create a contact using documented contact fields
Risk: write
contact full type
contact full type
contact full type
contact full type
delete
contacts.delete
Delete a contact
Risk: destructive
object \| undefined
Output full type
Output full type
get
contacts.get
Get a contact by its FreeAgent ID
Risk: read
contact full type
contact full type
list
contacts.list
List contacts with documented filters and pagination
Risk: read
query full type
query full type
contacts full type
contacts full type
pagination full type
pagination full type
update
contacts.update
Update documented fields on a contact
Risk: write
contact full type
contact full type
object \| undefined
Output full type
Output full type
Email Addresses
list
emailAddresses.list
List verified sender email addresses for the company
Risk: read
query full type
query full type
pagination full type
pagination full type
Invoices
convertToCreditNote
invoices.convertToCreditNote
Convert a draft negative invoice into a credit note
Risk: destructive
credit_note full type
credit_note full type
create
invoices.create
Create an invoice in Draft status
Risk: write
invoice full type
invoice full type
invoice full type
invoice full type
delete
invoices.delete
Delete an invoice
Risk: destructive
object \| undefined
Output full type
Output full type
deleteDefaultAdditionalText
invoices.deleteDefaultAdditionalText
Remove the default additional text from company invoices
Risk: write
object \| undefined
Output full type
Output full type
directDebit
invoices.directDebit
Take payment using an eligible GoCardless mandate
Risk: destructive
object \| undefined
Output full type
Output full type
duplicate
invoices.duplicate
Duplicate an invoice as a new draft using the next reference
Risk: write
invoice full type
invoice full type
get
invoices.get
Get an invoice by its FreeAgent ID
Risk: read
invoice full type
invoice full type
getDefaultAdditionalText
invoices.getDefaultAdditionalText
Get the default additional text for company invoices
Risk: read
list
invoices.list
List invoices with documented filters and pagination
Risk: read
query full type
query full type
invoices full type
invoices full type
pagination full type
pagination full type
markCancelled
invoices.markCancelled
Cancel and write off an eligible sent invoice
Risk: destructive
object \| undefined
Output full type
Output full type
markDraft
invoices.markDraft
Return an invoice to Draft status
Risk: destructive
object \| undefined
Output full type
Output full type
markScheduled
invoices.markScheduled
Schedule an invoice to be emailed
Risk: destructive
object \| undefined
Output full type
Output full type
markSent
invoices.markSent
Mark an invoice as sent or reopen a cancelled invoice
Risk: destructive
object \| undefined
Output full type
Output full type
invoices.pdf
Get the invoice PDF as base64 encoded JSON content
Risk: read
pdf full type
pdf full type
sendEmail
invoices.sendEmail
Send an invoice email to its recipient
Risk: destructive
email full type
email full type
object \| undefined
Output full type
Output full type
timeline
invoices.timeline
List invoice timeline entries
Risk: read
invoice_timeline_items full type
invoice_timeline_items full type
update
invoices.update
Update an invoice without changing its status
Risk: write
invoice full type
invoice full type
object \| undefined
Output full type
Output full type
updateDefaultAdditionalText
invoices.updateDefaultAdditionalText
Update the default additional text for company invoices
Risk: write
Projects
create
projects.create
Create a project with documented project fields
Risk: write
project full type
project full type
project full type
project full type
delete
projects.delete
Delete a project
Risk: destructive
object \| undefined
Output full type
Output full type
get
projects.get
Get a project by its FreeAgent ID
Risk: read
project full type
project full type
list
projects.list
List projects with documented filters and pagination
Risk: read
query full type
query full type
projects full type
projects full type
pagination full type
pagination full type
update
projects.update
Update documented fields on a project
Risk: write
project full type
project full type
object \| undefined
Output full type
Output full type
Recurring Invoices
get
recurringInvoices.get
Get a recurring invoice by its FreeAgent ID
Risk: read
recurring_invoice full type
recurring_invoice full type
list
recurringInvoices.list
List recurring invoices with documented filters and pagination
Risk: read
query full type
query full type
recurring_invoices full type
recurring_invoices full type
pagination full type
pagination full type
Tracking Groups
get
trackingGroups.get
Get a tracking group and its labels by FreeAgent ID
Risk: read
tracking_group full type
tracking_group full type
list
trackingGroups.list
List tracking groups with documented filters and pagination
Risk: read
query full type
query full type
tracking_groups full type
tracking_groups full type
pagination full type
pagination full type