Rivier/ Reference/ shop

Add a number series (gapless, optionally restarting each year)

post/invoices/series

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:admin
Sdk
shop.invoiceSeries.create
Cli
shop invoice series create

Request bodyapplication/json, required

  • keystringrequired
    Pattern: ^[a-z0-9][a-z0-9-]{0,30}$.
  • kindstring
    One of: invoice, credit_note, quote, proposal. Default: invoice.
  • prefixstring
    Default: . At most 20 characters.
  • paddinginteger
    Default: 5. At least 1. At most 12.
  • resetRulestring
    One of: never, yearly. Default: never.
  • startAtinteger
    Default: 1. At least 1. At most 999999999.
  • jurisdictionstring
    Default: . At most 10 characters.

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown