Praecise Platform
Menu

Rivier/ Reference/ shop

Shop invoice send link

post/invoices/{id}/send-link

Send the invoice to the client by mail with its PDF and a private link (or, with channel link, return the link without mail). Beside the plain send, which stays.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Mcp
rivier_invoices_send_link
Sdk
shop.invoice.sendLink
Cli
invoices send-link

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • channelstring
    One of: email, link. Default: email.
  • tolist of object
    • namestring
      Default: . At most 200 characters.
    • emailstring (email)required
      At most 254 characters.
    • contactIdstring (uuid)
  • cclist of object
    • namestring
      Default: . At most 200 characters.
    • emailstring (email)required
      At most 254 characters.
    • contactIdstring (uuid)
  • subjectstring
    At most 300 characters.
  • messagestring
    At most 5000 characters.
  • attachPdfboolean
    Default: true.
  • linkDaysinteger
    Default: 30. At least 1. At most 365.
  • validDaysinteger
    Default: 30. At least 1. At most 365.
  • idempotencyKeystring
    At most 120 characters.

Responses

  • 200application/json
    Success
    • sentbooleanrequired
    • channelstringrequired
      One of: email, link.
    • urlstringrequired
    • linkIdstring (uuid)required
    • resendbooleanrequired
    • resultslist of objectrequired
      • emailstringrequired
      • rolestringrequired
        One of: to, cc.
      • okbooleanrequired
      • reasonstring
      • detailstring
    • numberstring or nullrequired
    • statusstringrequired
  • 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