# Preview the next document number

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/available_identifier
```

- API version: v1
- Operation ID: `v1_public_misc_available_identifier`
- Section: Sales › [Document numbers](https://developer.yoprint.com/reference/document-numbers.md)
- Web page: https://developer.yoprint.com/reference/document-numbers/v1-misc-available-identifier/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns the number the next record of a type will get, such as `SO1002` for the next sales order. It is a preview: nothing is reserved, and someone else may take the number first.

Numbers are the prefix and the counter plus one, padded to 4 digits (`SO0042`); from 10,000 they get one leading zero (`SO010000`).

| `type` | Prefix |
| --- | --- |
| `sales_order` | SO |
| `quote` | QT |
| `purchase_order` | PO |
| `stock_transfer` | ST |
| `stock_adjustment` | SA |
| `general_defect` | DF |
| `production_defect` | PD |

## Permission

Any member of the team.

## Business rules

- `type` is required and must be one of the values in the table.

## Side effects

- On a team that has never numbered this type, the first call starts its counter, so the first real number is 2, not 1.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Query parameters

- `type` (string, required): One of: `"sales_order"`, `"quote"`, `"purchase_order"`, `"stock_transfer"`, `"stock_adjustment"`, `"general_defect"`, `"production_defect"`. Example `sales_order`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/available_identifier?type=sales_order' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `identifier` (string, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "identifier": "SO1002"
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `type` is missing or not in the list (`validation_failed`; `error.fields` names the field). Fix: Send one of the listed types.

## Notes

- Quotes are numbered from the sales order counter, so the next quote gets the number `type=sales_order` returns. `type=quote` reads a separate counter that quotes do not use.
- To choose a number yourself, send it when you create the record instead.