> For the complete documentation index, see [llms.txt](https://docs.olziedev.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.olziedev.com/projects/playerbusinesses/commands.md).

# Commands & Permissions

### Player Commands

| Command                                                                 | Description                                         | Permission                                        |
| ----------------------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------------- |
| /pb pay \<firm> \<player> \<amount>                                     | Pay a user from a specified firm.                   | playerbusinesses.use & playerbusinesses.limit.<#> |
| /pb staff createrole \<firm> \<name>                                    | Create a role for the specified firm.               | playerbusinesses.staff.createrole                 |
| /pb transactions \<firm> \[page]                                        | Shows transaction list for the specified firm.      | playerbusinesses.transactions.use                 |
| /pb transactions export \<firm>                                         | Exports transactions list of specified firm.        | playerbusinesses.sales.transactions               |
| /pb offer \<firm> \<user>                                               | Offer a user a job.                                 | playerbusinesses.user.offer                       |
| /pb disband \<firm>                                                     | Disband a firm.                                     | playerbusinesses.user.disband                     |
| /pb fire \<firm> \<user>                                                | Removes specified user from specified firm you own. | playerbusinesses.user.fire                        |
| /pb staff editrole add \<firm> \<name> \<permission>                    | Allows you to add permissions to a role.            | playerbusinesses.user.role.edit.add               |
| /pb staff editrole remove \<firm> \<name> \<permission>                 | Allows you to remove permissions from a role.       | playerbusinesses.user.role.edit.remove            |
| /pb staff list \<firm>                                                  | Shows a list of all staff members.                  | playerbusinesses.use                              |
| /pb staff demote \<firm> \<user>                                        | Demote a player from a role.                        | playerbusinesses.user.staff.demote                |
| /pb staff removerole \<firm> \<name>                                    | Remove a role from the specified firm.              | playerbusinesses.staff.removerole                 |
| /pb staff promote \<firm> \<user>                                       | Promote a player to a role.                         | playerbusinesses.user.staff.promote               |
| /pb list \<user>                                                        | List firms for the specified user.                  | playerbusinesses.user.list                        |
| /pb amount                                                              | Check how many businesses you have.                 | playerbusinesses.user.amount                      |
| /pb deposit \<firm> \<money> \[reason]                                  | Puts money from player balance into a firm balance. | playerbusinesses.use                              |
| /pb set hq \<firm> \<plot>                                              | Set the HQ for a firm.                              | playerbusinesses.user.set.hq                      |
| /pb set discord \<firm> \<discord>                                      | Set the discord for the specified firm.             | playerbusinesses.user.set.discord                 |
| /pb withdraw \<firm> \<money> \[reason]                                 | Takes money from the specified firm.                | playerbusinesses.use                              |
| /pb accept \<firm>                                                      | Accepts pending job offer from specified firm.      | playerbusinesses.user.offer.accept                |
| /pb deny \<firm>                                                        | Denies pending job offer from specified firm.       | playerbusinesses.user.offer.deny                  |
| /pb info \<firm>                                                        | Shows information about the specified firm.         | playerbusinesses.user.information                 |
| /pb primary \<firm>                                                     | Setup your primary firm.                            | playerbusinesses.user.primary                     |
| /pb list all \[page]                                                    | List all firms.                                     | playerbusinesses.user.list.all                    |
| /pb create \<firm>                                                      | Creates a firm.                                     | playerbusinesses.user.create                      |
| /pb sales \<firm> \[page]                                               | Shows sales list of specified firm.                 | playerbusinesses.sales.use                        |
| /pb sales toggle \<firm>                                                | Toggles sale notifications for a firm.              | playerbusinesses.sales.toggle                     |
| /pb sales export \<firm> \<days>                                        | Exports sales list of specified firm.               | playerbusinesses.sales.export                     |
| /pb resign \<firm>                                                      | Resigns from specified firm.                        | playerbusinesses.user.resign                      |
| /pb transferproprietorship \<firm> \<user>                              | Change firm proprietorship.                         | playerbusinesses.user.transferproprietorship      |
| /pb menu \<firm>                                                        | Open the menu.                                      | playerbusinesses.use                              |
| /pb stocks commodity \<item> \<item>                                    | Shows the commodity information.                    | playerbusinesses.stocks.commodity                 |
| /pb stocks delist \<firm/ticker>                                        | Delist a company from the stock market.             | playerbusinesses.stocks.delist                    |
| /pb stocks dividend \<firm/ticker> \<dividend type> \<amount per share> | Put a dividend on your stocks.                      | playerbusinesses.stocks.dividend                  |
| /pb stocks ipo \<firm> \<ticker> \<number of shares>                    | Enable stocks for a firm.                           | playerbusinesses.stocks.enable                    |
| /pb stocks sell \<firm/ticker> \<shares> \<price>                       | Sell stocks from your firm.                         | playerbusinesses.stocks.sell                      |
| /pb stocks market                                                       | List all companies stocks.                          | playerbusinesses.stocks.market                    |
| /pb stocks profile \<firm/ticker>                                       | Show the biggest seller information.                | playerbusinesses.stocks.profile                   |
| /pb stocks portfolio                                                    | Show your information.                              | playerbusinesses.stocks.portfolio                 |

### Admin Commands

| Command                               | Description                                  | Permission                           |
| ------------------------------------- | -------------------------------------------- | ------------------------------------ |
| /pb reload                            | Reloads all the config files.                | playerbusinesses.admin.reload        |
| /pb addbusinesses \<player> \<amount> | Add more businesses to a player via command. | playerbusinesses.admin.addbusinesses |

## Rest API Commands

| Command                          | Description               | Permission                          |
| -------------------------------- | ------------------------- | ----------------------------------- |
| /pb apitokens                    | Shows the help menu.      | playerbusinesses.apitokens          |
| /pb apitokens delete \[player]   | Delete your API token.    | playerbusinesses.apitokens.delete   |
| /pb apitokens generate \[player] | Generate a new API token. | playerbusinesses.apitokens.generate |

{% hint style="info" %}
**Permissions not working?**

The <> in some permissions are placeholders, you will need to replace them with a valid value like requested.
{% endhint %}

## Admin Permissions

| Permission                                          | Description                                                              |
| --------------------------------------------------- | ------------------------------------------------------------------------ |
| playerbusinesses.admin.update                       | When a player joins they receive update notifications.                   |
| playerbusinesses.user.fire.others                   | Allows the player to fire any staff member from any business.            |
| playerbusinesses.user.transferproprietorship.others | Allows the player to transfer the proprietorship of any business.        |
| playerbusinesses.admin                              | Allows the player to interact with other businesses without owning them. |
| playerbusinesses.transactions.export.other          | Allows players to export transactions to businesses they don't own.      |
| playerbusinesses.sales.export.other                 | Allows players to export sales to businesses they don't own.             |
| playerbusinesses.admin.apitokens                    | Remove/Generate other players' API tokens.                               |
