API docs
Connect your software to Zulu
The Zulu API lets your accounting software, online shop or scripts create invoices, keep customers in step and download PDFs, with the same rules as the app.
API keys come with the Scale plan. Already on Scale? Create a key in Settings.
See plansQuickstart
Create an API key
In Zulu, open Settings → API keys and choose New key. Give it the smallest role that does the job. Copy the key, which is shown once, and your business ID, shown on the same page.
Make your first request
Send the key and business ID with every request. This one returns your business's details.
Terminalcurl https://api.zulu.ie/v1/business \ -H "Authorization: Bearer $ZULU_API_KEY" \ -H "Zulu-Business-Id: $ZULU_BUSINESS_ID"Create an invoice
Add the customer and the items, then send it. Zulu works out the totals and VAT, and emails the customer a PDF. See the invoices reference
What you can do
47 endpoints, grouped by what they're for
- InvoicesCreate invoices and credit notes, issue and email them, download PDFs.11 endpoints
- CustomersThe people and companies you invoice, with their emails, phones and addresses.16 endpoints
- ItemsYour saved products and services, with their prices and VAT rates.4 endpoints
- VAT ratesThe VAT rates your items and invoice lines use.4 endpoints
- Bank accountsThe accounts shown on invoices so customers know where to pay.4 endpoints
- ExportDownload invoices, invoice lines and customers as CSV, and invoices as PDFs.2 endpoints
- Your businessRead your business's details, logo, plan and usage, team, roles and activity log.6 endpoints
Good to know
- Money is a string, like
"120.50", so amounts stay exact. - PATCH changes only what you send. Leave a field out to keep it.
- Lists come a page at a time. Pass the last id as
afterfor the next page. - Every error looks the same: a
codeto check and amessageto show.