Recipients commands

The recipients command lets you add, update, and remove invoice recipients for a client.

Create a recipient

This command adds an email recipient to a client. Use this when a client should receive invoices by email.

neetoinvoice recipients create \
  --client 59dad05d64c302e59a02 \
  --name "Jane Doe" \
  --email [email protected] \
  --user-email [email protected]

Required flags:

• --client - Client identifier

• --name - Recipient name

• --email - Recipient email

• --user-email - Email of the acting organization user

Optional flags:

• --subdomain <name> - Target a specific logged-in workspace

• --json - Return JSON envelope output

• --quiet - Return raw payload only

• --toon - Return TOON output

Sample output:

{
  "data": {
    "notice_code": "thumbs_up",
    "recipient": {
      "id": "c755efb9-0ed8-4815-a509-04f362cc327f",
      "name": "CLI Doc Recipient",
      "email": "[email protected]"
    }
  }
}

Update a recipient

This command updates a recipient's name or email. Use this when contact details change.

neetoinvoice recipients update c755efb9-0ed8-4815-a509-04f362cc327f \
  --client 59dad05d64c302e59a02 \
  --name "Jane Doe (Billing)"

Required flags:

• --client - Client identifier

Required argument:

• <recipient-id> - Recipient record UUID. Refer to Getting the Recipient ID section for detailed instructions.

Optional flags:

• --name - Recipient name

• --email - Recipient email

• --subdomain <name> - Target a specific logged-in workspace

• --json - Return JSON envelope output

• --quiet - Return raw payload only

• --toon - Return TOON output

Sample output:

{
  "data": {
    "notice_code": "thumbs_up",
    "recipient": {
      "name": "CLI Doc Recipient Updated",
      "email": "[email protected]"
    }
  }
}

Delete a recipient

This command removes a recipient from a client. Use this when someone should no longer receive invoices.

neetoinvoice recipients delete c755efb9-0ed8-4815-a509-04f362cc327f \
  --client 59dad05d64c302e59a02

Required flags:

• --client - Client identifier

Required argument:

• <recipient-id> - Recipient record UUID. Refer to Getting the Recipient ID section for detailed instructions.

Optional flags:

• --subdomain <name> - Target a specific logged-in workspace

• --json - Return JSON envelope output

• --quiet - Return raw payload only

• --toon - Return TOON output

Sample output:

{"message":"Recipient deleted."}