@corsair-dev/clientary

Clientary plugin for Corsair.

Install

pnpm add @corsair-dev/clientary

Endpoints

Operation	Operation ID	Risk	Description
clients.create	clientary.api.clients.create	write	Create a client
clients.delete	clientary.api.clients.delete	destructive	Delete a client and all associated projects, invoices, estimates, and contacts [DESTRUCTIVE]
clients.get	clientary.api.clients.get	read	Get a client by ID
clients.list	clientary.api.clients.list	read	List clients
clients.update	clientary.api.clients.update	write	Update a client
contacts.create	clientary.api.contacts.create	write	Create a contact
contacts.delete	clientary.api.contacts.delete	destructive	Delete a contact [DESTRUCTIVE]
contacts.get	clientary.api.contacts.get	read	Get a contact by ID
contacts.list	clientary.api.contacts.list	read	List contacts
contacts.listForClient	clientary.api.contacts.listForClient	read	List contacts belonging to a client
contacts.update	clientary.api.contacts.update	write	Update a contact
estimates.create	clientary.api.estimates.create	write	Create an estimate
estimates.delete	clientary.api.estimates.delete	destructive	Delete an estimate [DESTRUCTIVE]
estimates.get	clientary.api.estimates.get	read	Get an estimate by ID
estimates.list	clientary.api.estimates.list	read	List estimates
estimates.listForClient	clientary.api.estimates.listForClient	read	List estimates belonging to a client
estimates.listForProject	clientary.api.estimates.listForProject	read	List estimates belonging to a project
estimates.send	clientary.api.estimates.send	write	Send an estimate via email
estimates.update	clientary.api.estimates.update	write	Update an estimate
expenses.create	clientary.api.expenses.create	write	Create an expense
expenses.delete	clientary.api.expenses.delete	destructive	Delete an expense [DESTRUCTIVE]
expenses.get	clientary.api.expenses.get	read	Get an expense by ID
expenses.list	clientary.api.expenses.list	read	List expenses
expenses.listForClient	clientary.api.expenses.listForClient	read	List expenses belonging to a client
expenses.listForProject	clientary.api.expenses.listForProject	read	List expenses belonging to a project
expenses.update	clientary.api.expenses.update	write	Update an expense
hours.create	clientary.api.hours.create	write	Log hours to a project
hours.delete	clientary.api.hours.delete	destructive	Delete an hours entry [DESTRUCTIVE]
hours.get	clientary.api.hours.get	read	Get an hours entry by ID
hours.listForProject	clientary.api.hours.listForProject	read	List hours logged against a project
hours.update	clientary.api.hours.update	write	Update an hours entry
invoices.create	clientary.api.invoices.create	write	Create an invoice
invoices.delete	clientary.api.invoices.delete	destructive	Delete an invoice [DESTRUCTIVE]
invoices.get	clientary.api.invoices.get	read	Get an invoice by ID
invoices.list	clientary.api.invoices.list	read	List invoices
invoices.listForClient	clientary.api.invoices.listForClient	read	List invoices belonging to a client
invoices.listForProject	clientary.api.invoices.listForProject	read	List invoices belonging to a project
invoices.listForRecurring	clientary.api.invoices.listForRecurring	read	List invoices generated by a recurring schedule
invoices.send	clientary.api.invoices.send	write	Send an invoice via email
invoices.update	clientary.api.invoices.update	write	Update an invoice
leads.create	clientary.api.leads.create	write	Create a lead
leads.delete	clientary.api.leads.delete	destructive	Delete a lead [DESTRUCTIVE]
leads.get	clientary.api.leads.get	read	Get a lead by ID
leads.list	clientary.api.leads.list	read	List leads
leads.update	clientary.api.leads.update	write	Update a lead
paymentProfiles.create	clientary.api.paymentProfiles.create	write	Create a payment profile for a client
paymentProfiles.delete	clientary.api.paymentProfiles.delete	destructive	Delete a payment profile [DESTRUCTIVE]
paymentProfiles.listForClient	clientary.api.paymentProfiles.listForClient	read	List payment profiles for a client
payments.create	clientary.api.payments.create	write	Record a payment
payments.delete	clientary.api.payments.delete	destructive	Delete (void) a payment [DESTRUCTIVE]
payments.list	clientary.api.payments.list	read	List payments
projects.create	clientary.api.projects.create	write	Create a project
projects.delete	clientary.api.projects.delete	destructive	Delete a project [DESTRUCTIVE]
projects.get	clientary.api.projects.get	read	Get a project by ID
projects.list	clientary.api.projects.list	read	List projects
projects.listForClient	clientary.api.projects.listForClient	read	List projects belonging to a client
projects.update	clientary.api.projects.update	write	Update a project
recurring.create	clientary.api.recurring.create	write	Create a recurring schedule
recurring.delete	clientary.api.recurring.delete	destructive	Delete a recurring schedule [DESTRUCTIVE]
recurring.get	clientary.api.recurring.get	read	Get a recurring schedule by ID
recurring.list	clientary.api.recurring.list	read	List recurring schedules
recurring.update	clientary.api.recurring.update	write	Update a recurring schedule
staff.get	clientary.api.staff.get	read	Get a staff member by ID
staff.list	clientary.api.staff.list	read	List staff members
tasks.create	clientary.api.tasks.create	write	Create a task
tasks.delete	clientary.api.tasks.delete	destructive	Delete a task [DESTRUCTIVE]
tasks.get	clientary.api.tasks.get	read	Get a task by ID
tasks.list	clientary.api.tasks.list	read	List tasks
tasks.listForProject	clientary.api.tasks.listForProject	read	List tasks belonging to a project
tasks.update	clientary.api.tasks.update	write	Update a task

Auth

Auth: API key. Corsair prompts your tenant for credentials on first use.

Webhooks

No webhooks.

Reference

Full docs, types, and examples: https://docs.corsair.dev/plugins/clientary

License

Apache-2.0