Invoice Settings

Update an Invoice Render Settings

Changed on

Update an Invoice Render Settings

put/invoices/render-settings/{id}

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/invoices/render-settings/{id}
  • Auth
    none declared. Required headers: Authorization

Path parameters

idstring required

Invoice settings ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

paymentLinkDisplay'SHOW_PAYMENT_LINK' | 'HIDE_PAYMENT_LINK' required
currencyConversionDisplay'SHOW_CURRENCY_CONVERSION' | 'HIDE_CURRENCY_CONVERSION'

Example request

{
  "paymentLinkDisplay": "SHOW_PAYMENT_LINK",
  "currencyConversionDisplay": "SHOW_CURRENCY_CONVERSION"
}

Response

OK

idstring required

Invoice settings ID

paymentLinkDisplay'SHOW_PAYMENT_LINK' | 'HIDE_PAYMENT_LINK' required
currencyConversionDisplay'SHOW_CURRENCY_CONVERSION' | 'HIDE_CURRENCY_CONVERSION' required

Example response

{
  "id": "385f41ab-51f9-49c2-8f25-358545106b88",
  "paymentLinkDisplay": "SHOW_PAYMENT_LINK",
  "currencyConversionDisplay": "SHOW_CURRENCY_CONVERSION"
}

Changes

  • 2fa300409e19Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • d01512162768Revision changes
    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version