Recipients

A recipient is a contact an invoice is emailed to. Recipients belong to a client, so every command here takes --client <client-identifier>. For fields and response details, see the API reference. To list a client’s recipients, run clients show.

Create a recipient

Add a recipient to a client. --user-email identifies the acting organization user.

neetoinvoice recipients create \
  --client 7c1f5e2a9b \
  --name "Sam Smith" \
  --email sam@example.com \
  --user-email oliver@example.com

Flag	Type	Required	Description
`--client`	`string`	Yes	Client identifier
`--email`	`string`	Yes	Recipient email
`--name`	`string`	Yes	Recipient name
`--user-email`	`string`	Yes	Email of the acting organization user

Sample output (--json)

{
  "data": {
    "notice_code": "thumbs_up",
    "recipient": {
      "id": "128c1dfc-b29f-4fda-9a05-8a90e197b81b",
      "name": "Sam Smith",
      "email": "sam@example.com"
    }
  },
  "breadcrumbs": [
    { "label": "Client", "command": "neetoinvoice clients show <client-id>" }
  ]
}

Update a recipient

Change a recipient’s name or email. Only the flags you pass are changed.

neetoinvoice recipients update 128c1dfc-b29f-4fda-9a05-8a90e197b81b \
  --client 7c1f5e2a9b \
  --email accounts@example.com

Required arguments:

<recipient-id> - The recipient’s record ID. See Getting the recipient ID.

Flag	Type	Required	Description
`--client`	`string`	Yes	Client identifier
`--email`	`string`	No	Recipient email
`--name`	`string`	No	Recipient name

Sample output (--json)

{
  "data": {
    "notice_code": "thumbs_up",
    "recipient": {
      "id": "128c1dfc-b29f-4fda-9a05-8a90e197b81b",
      "name": "Sam Smith",
      "email": "accounts@example.com"
    }
  },
  "breadcrumbs": [
    { "label": "Client", "command": "neetoinvoice clients show <client-id>" }
  ]
}

Delete a recipient

Remove a recipient from a client.

neetoinvoice recipients delete 128c1dfc-b29f-4fda-9a05-8a90e197b81b --client 7c1f5e2a9b

Required arguments:

<recipient-id> - The recipient’s record ID.

Flag	Type	Required	Default	Description
`--client`	`string`	Yes		Client identifier

Sample output

Recipient deleted.

Getting started

Commands

Create a recipient

Update a recipient

Delete a recipient

​Create a recipient

​Update a recipient

​Delete a recipient

Create a recipient

Update a recipient

Delete a recipient