salesOrderPaymentReminderOptions

Requires permission sales:sales_order:send.

Whether the payment reminder can carry the How-to-pay block for this company, and whether the Include payment details tick box starts ticked. Read by whoever may send reminders, so no access to Settings is needed.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query SalesOrderPaymentReminderOptions {
  salesOrderPaymentReminderOptions {
    available
    includeByDefault
    showsBankAccounts
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesOrderPaymentReminderOptions {\n  salesOrderPaymentReminderOptions {\n    available\n    includeByDefault\n    showsBankAccounts\n  }\n}"
}
EOF

Response:

{
  "data": {
    "salesOrderPaymentReminderOptions": {
      "available": true,
      "includeByDefault": true,
      "showsBankAccounts": true
    }
  }
}

salesOrderPaymentReminderOptions: SalesOrderPaymentReminderOptions!

Type

SalesOrderPaymentReminderOptions object

What a sender needs to know before sending a sales order payment reminder: whether the payment-details option is on for this company, and whether its tick box should start ticked.