Set the next document numbers

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

v1Operation ID v1_public_setting_running_number_update

Sets the number the next sales order, purchase order or invoice gets, and returns all three next numbers. Send only the counters you want to change.

Only documents created afterwards use the new numbers; existing documents keep theirs. 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

Needs the Manage Settings permission.

Business rules

• Each value must be a number of at least 1. Send whole numbers: a fraction is rounded, so the next number may not be the one you asked for.
• YoPrint doesn't check the number against existing documents. Setting it below a number already used makes new documents repeat existing numbers.

Side effects

• Tells the team's open web app sessions about the new numbers.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• order_invoiceinteger

  The next invoice number.

  • Minimum 1
• purchase_orderinteger

  The next purchase order number.

  • Minimum 1
• sales_orderinteger

  The next sales order number.

  • Minimum 1

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).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

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

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

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

• 422The 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

  A value is not a number or is below 1. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

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

Example request

curl

curl -X PUT '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' \  -H 'Content-Type: application/json' \  -d '{    "sales_order": 2000  }'

Example response 200

Response

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