Clients

A client is a billed entity in a workspace. Each one owns its projects and its invoice recipients. For fields and response details, see the API reference.

A client is addressed by its identifier, the short hex string returned by clients list and clients show. The record id (a UUID) works too, and is what projects create --client-id expects.

List clients

Find a client’s identifier by name or status. Start here when you have a name and need an ID for another command.

neetoinvoice clients list --name acme

Flag	Type	Required	Default	Description
`--name`	`string`	No		Filter by name (substring match)
`--page`	`int`	No	unset	Page number
`--page-size`	`int`	No	unset	Items per page (max 100)
`--status`	`string`	No		Filter by status: active or archived

Without --page or --page-size, the command returns every record. With either flag, the result is paginated. The envelope always has a pagination object. See Pagination.

Sample output (--json)

{
  "data": [
    {
      "id": "3f0c0f87-ddc7-45f4-ad7a-c3690fa04963",
      "identifier": "7c1f5e2a9b",
      "name": "Acme Corp",
      "secondary_name": "Acme Holdings",
      "status": "active",
      "currency": "USD",
      "default_invoice_due_in_days": 30
    }
  ],
  "breadcrumbs": [
    { "label": "Show", "command": "neetoinvoice clients show <client-id>" }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page_number": 1,
    "page_size": 30
  }
}

Show a client

Show one client together with its invoice recipients.

neetoinvoice clients show 7c1f5e2a9b

Required arguments:

<client-id> - The client’s identifier.

Sample output (--json)

{
  "data": {
    "client": {
      "id": "3f0c0f87-ddc7-45f4-ad7a-c3690fa04963",
      "identifier": "7c1f5e2a9b",
      "name": "Acme Corp",
      "status": "active",
      "currency": "USD"
    },
    "recipients": [
      {
        "id": "128c1dfc-b29f-4fda-9a05-8a90e197b81b",
        "name": "Sam Smith",
        "email": "sam@example.com"
      }
    ]
  },
  "breadcrumbs": [
    {
      "label": "Update",
      "command": "neetoinvoice clients update <client-id> --name <name>"
    },
    {
      "label": "Add recipient",
      "command": "neetoinvoice recipients create --client <client-id> --name <name> --email <email> --user-email <email>"
    }
  ]
}

Create a client

Create a client. Only --name is required; the rest can be filled in later with clients update.

neetoinvoice clients create \
  --name "Acme Corp" \
  --secondary-name "Acme Holdings" \
  --address "1 Market St, San Francisco, CA" \
  --due-in-days 30

Flag	Type	Required	Default	Description
`--address`	`string`	No		Full address
`--due-in-days`	`int`	No	`0`	Default invoice due in days
`--internal-notes`	`string`	No		Internal notes
`--name`	`string`	Yes		Client name
`--secondary-name`	`string`	No		Secondary name
`--status`	`string`	No		Status (active/archived)

Sample output (--json)

{
  "data": {
    "notice_code": "thumbs_up",
    "client_id": "3f0c0f87-ddc7-45f4-ad7a-c3690fa04963"
  },
  "breadcrumbs": [
    { "label": "Show", "command": "neetoinvoice clients show <client-id>" }
  ]
}

With --quiet the command prints the raw response, so read the new client’s ID from client_id:

CLIENT_ID=$(neetoinvoice clients create --name "Acme Corp" --quiet | jq -r .client_id)

Update a client

Update a client. Only the flags you pass are changed.

neetoinvoice clients update 7c1f5e2a9b --status archived

Required arguments:

<client-id> - The client’s identifier.

Flag	Type	Required	Default	Description
`--address`	`string`	No		Full address
`--due-in-days`	`int`	No	`0`	Default invoice due in days
`--internal-notes`	`string`	No		Internal notes
`--name`	`string`	No		Client name
`--secondary-name`	`string`	No		Secondary name
`--status`	`string`	No		Status (active/archived)

Sample output (--json)

{
  "data": { "notice_code": "thumbs_up" },
  "breadcrumbs": [
    { "label": "Show", "command": "neetoinvoice clients show <client-id>" }
  ]
}

Getting started

Commands

List clients

Show a client

Create a client

Update a client

​List clients

​Show a client

​Create a client

​Update a client

List clients

Show a client

Create a client

Update a client