The people and companies you bill, and how to add one.

• A key limited to certain businesses still sees every customer: customers belong to your account, not to one business.
• In search, % and _ are wildcards, because the match runs as a SQL ilike.
• To read the next page, pass the previous response's nextCursor. A null there means you already have everything.

Needs the customers:read permission. A Read only key has it.

curl "https://www.numm.io/api/v1/customers?search=Acme" \
  -H "Authorization: Bearer nmo_live_REPLACE_WITH_YOUR_KEY"

{
  "customers": [
    {
      "id": "0190a1b2-c3d4-7e5f-9a9b-0c1d2e3f1005",
      "name": "Acme Co",
      "email": "ap@acme.example",
      "currency": "USD",
      "paymentTermsDays": 30
    }
  ],
  "nextCursor": null
}

• If a customer with this name already exists, that one is returned and nothing is changed: created is false and the other fields you sent are ignored.
• The match ignores case and skips archived customers.
• A customer that was created answers 201. One that already existed answers 200.

Needs the customers:write permission. Only a Read and write key has it.

curl -X POST "https://www.numm.io/api/v1/customers" \
  -H "Authorization: Bearer nmo_live_REPLACE_WITH_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 0190a1b2-c3d4-7e5f-8a9b-0c1d2e3fee00" \
  -d '{
  "name": "Acme Co",
  "email": "ap@acme.example"
}'

{
  "id": "0190a1b2-c3d4-7e5f-9a9b-0c1d2e3f1005",
  "created": true
}

• 200 A customer with this name already exists, so nothing was created.
• 201 A customer was created.

This call takes an optional Idempotency-Key header. Repeat the same request with the same key within 24 hours and you get the first response back, with an idempotent-replayed: true header, and the work does not run twice. The same key with a different request is refused. See Idempotency and safe retries.