People

Customers and suppliers — the counterparty of any bill. ids returns identifiers only, handy to keep an agent's context window small.

Command	HTTP	Description
`people list`	`GET /v1/people`	List people (customers / suppliers)
`people create`	`POST /v1/people`	Create a person (customer / supplier)
`people get`	`GET /v1/people/{id}`	Get a person by ID
`people update`	`PATCH /v1/people/{id}`	Update a person
`people delete`	`DELETE /v1/people/{id}`	Delete a person
`people ids list`	`GET /v1/people/ids`	List person IDs

Examples

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List people (customers / suppliers)
kobana finance people list --fields "id,company_id,name,legal_name,nickname"

# Get a person by ID
kobana finance people get --params '{"id": "PEOPLE_ID"}'

# Create a person (customer / supplier)
kobana finance people create \
  --json '{"company_id": "COMPANY_ID", "name": "NAME"}'

# Update a person
kobana finance people update \
  --params '{"id": "PEOPLE_ID"}' \
  --json '{"name": "NAME", "legal_name": "LEGAL_NAME", "nickname": "NICKNAME"}'

# Delete a person
kobana finance people delete --params '{"id": "PEOPLE_ID"}' --dry-run

Next steps

Companies
Schema introspection — every parameter this resource accepts.

Examples​

Next steps​

Examples

Next steps