Show the next document numbers

GET/v1/api/store/{team_slug}/setting/running_number

v1Operation ID v1_public_setting_running_number_show

Returns the number the next sales order, purchase order and invoice will get.

New sales orders are numbered SO plus the number, padded with zeros to at least 4 digits (SO0042, SO1043); from 5 digits up, one extra zero is added (SO010000). Purchase orders use PO the same way. Invoices use the plain number.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (3)

  • order_invoiceintegerrequired

    The number the next invoice gets.

  • purchase_orderintegerrequired

    The number the next purchase order gets.

  • sales_orderintegerrequired

    The number the next sales order gets.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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.

Notes

• The numbers are a preview: another user creating a document first takes the number.

Related

• PUTSet the next document numbers/v1/api/store/{team_slug}/setting/running_number

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/running_number' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": {
    "order_invoice": 877,
    "purchase_order": 218,
    "sales_order": 1043
  },
  "status": 200,
  "success": true
}