Praecise Platform
Menu

Rivier/ Reference/ shop

Change a draft invoice

patch/invoices/{id}

Change a draft invoice: dates, notes, payment terms, references, the customer and where the goods were delivered.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Sdk
shop.invoice.update
Cli
shop invoice update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • issueDatestring
    Pattern: ^\d{4}-\d{2}-\d{2}$.
  • dueDatestring
    Pattern: ^\d{4}-\d{2}-\d{2}$.
  • supplyDatestring
    Pattern: ^\d{4}-\d{2}-\d{2}$.
  • notesstring
    Default: . At most 2000 characters.
  • paymentTermsstring
    At most 500 characters.
  • paymentInstructionsstring
    At most 1000 characters.
  • buyerReferencestring
    Default: . At most 120 characters.
  • purchaseOrderstring
    Default: . At most 120 characters.
  • contactobject
    • 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}$.
  • reverseChargeboolean
    Default: false.

Responses

  • 200application/json
    Success
    • idstringrequired
    • seriesIdstringrequired
    • numberstring or nullrequired
    • statusstringrequired
    • currencystringrequired
    • issueDatestring or nullrequired
    • dueDatestring or nullrequired
    • subtotalMinornumberrequired
    • taxMinornumberrequired
    • totalMinornumberrequired
    • paidMinornumberrequired
    • dueMinornumberrequired
    • payUrlstring or nullrequired
    • createdAtstringrequired
    • sentAtstring or nullrequired
  • 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