Rivier/ Reference/ shop

Set the seller's details, default VAT, payment days and footer

put/invoices/settings

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:admin
Sdk
shop.invoiceSettings.set
Cli
shop invoice settings set

Request bodyapplication/json, required

  • sellerobject
    • namestringrequired
      At most 200 characters.
    • emailstring (email)
      At most 254 characters.
    • addressLineslist of string
      Default: [].
    • countrystring
      Pattern: ^[A-Z]{2}$.
    • vatIdstring
      At most 30 characters.
    • registrationstring
      At most 60 characters.
    • citystring
      At most 100 characters.
    • postalCodestring
      At most 20 characters.
    • endpointSchemestring
      Pattern: ^[0-9A-Z]{4}$.
    • endpointIdstring
      Pattern: ^\S(.{0,48}\S)?$.
    • paymentAccountstring
      Pattern: ^[A-Za-z0-9 ]{4,42}$.
    • paymentBicstring
      Pattern: ^[A-Za-z0-9]{8,11}$.
    • languagestring
      At most 20 characters. Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
  • defaultTaxBpinteger
    At least 0. At most 10000.
  • paymentDaysinteger
    At least 0. At most 365.
  • paymentTextstring
    At most 1000 characters.
  • footerstring
    At most 600 characters.
  • reminderslist of object
    • kindstringrequired
      One of: before, on, after.
    • daysintegerrequired
      At least 0. At most 120.

Responses

  • 200application/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