Skip to content
Zulu

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 plans

Quickstart

  1. 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.

  2. Make your first request

    Send the key and business ID with every request. This one returns your business's details.

    Terminal
    curl https://api.zulu.ie/v1/business \
      -H "Authorization: Bearer $ZULU_API_KEY" \
      -H "Zulu-Business-Id: $ZULU_BUSINESS_ID"
  3. 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

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 after for the next page.
  • Every error looks the same: a code to check and a message to show.
Read the basics