Draft an invoice; idempotent on the key. It has no number until it is finalised

Before you call

Credential

Authorization: Bearer $KEY

Scope

shop:write

Mcp

rivier_invoices_draft

Graphql

Mutation.draftInvoice

Sdk

shop.invoice.draft

Cli

shop invoice draft

Request bodyapplication/json, required

• seriesKeystring
  Pattern: ^[a-z0-9][a-z0-9-]{0,30}$.
• currencystringrequired
  Pattern: ^[a-z]{3}$.
• contactobjectrequired
  • 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})*$.
• deliveryobject
  • namestring
    At most 200 characters.
  • addressLineslist of string
    Default: [].
  • citystring
    At most 100 characters.
  • postalCodestring
    At most 20 characters.
  • countrystring
    Pattern: ^[A-Z]{2}$.
• lineslist of object
  Default: [].
  • descriptionstringrequired
    At most 500 characters.
  • quantitynumber
    Default: 1. At most 1000000.
  • unitstring
    Default: C62. At most 10 characters.
  • unitAmountMinorintegerrequired
    At least 0. At most 99999999999.
  • discountMinorinteger
    Default: 0. At least 0. At most 99999999999.
  • taxRateBpinteger
    At least 0. At most 10000.
  • taxCategorystring
    One of: S, Z, E, AE, K, G, O, L, M. Default: S.
  • productIdstring (uuid)
  • sourceobject
    • kindstringrequired
      At most 40 characters.
    • idstringrequired
      At most 120 characters.
• issueDatestring
  Pattern: ^\d{4}-\d{2}-\d{2}$.
• dueDatestring
  Pattern: ^\d{4}-\d{2}-\d{2}$.
• supplyDatestring
  Pattern: ^\d{4}-\d{2}-\d{2}$.
• periodFromstring
  Pattern: ^\d{4}-\d{2}-\d{2}$.
• periodTostring
  Pattern: ^\d{4}-\d{2}-\d{2}$.
• referenceobject
  • kindstringrequired
    At most 40 characters.
  • idstringrequired
    At most 120 characters.
• buyerReferencestring
  Default: . At most 120 characters.
• purchaseOrderstring
  Default: . At most 120 characters.
• paymentTermsstring
  At most 500 characters.
• paymentInstructionsstring
  At most 1000 characters.
• notesstring
  Default: . At most 2000 characters.
• reverseChargeboolean
  Default: false.
• roundingMinorinteger
  Default: 0. At least -99. At most 99.
• idempotencyKeystringrequired
  At most 120 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