Mutations

payoutReportSettingsUpdate

Change the store’s payout report email settings and return them. Fields you leave out keep their values. An invalid value fails with INVALID_PAYOUT_REPORT_SETTINGS (400). Errors with PAYOUT_REPORT_EMAILS_NOT_AVAILABLE (403) when payout report emails are not available for this store. Errors with PAYMENTS_NOT_ENABLED (403) when payments are not enabled for this store, and with HSA_GALE_ORGANIZATION_NOT_LINKED (409) when the store isn’t linked to its payments organization yet.

Required scopes: checkout_settings_write Store must have one of: HSA

Arguments

PayoutReportSettingsUpdateInput!

required

The fields to change.

Show fields

Boolean

The switch. On with no recipients is valid and sends nothing. Left out or null keeps it.

[PayoutReportField!]

Replaces the column selection, which is saved in file order whatever order you send. It can’t be empty. Left out or null keeps it.

[String!]

Replaces every recipient: at most 10 email addresses of at most 254 characters each, trimmed, lowercased and de-duplicated. Left out or null keeps them.

Returns

PayoutReportSettings!

required

Who receives the payout report by email when an HSA/FSA payout is deposited, and which columns the file carries.

Show fields

[PayoutReportField!]!

required

The default column set.

Boolean!

required

The switch. Reports send only when this is on and at least one recipient is listed.

[PayoutReportField!]!

required

The saved columns, in file order. The default set when nothing was saved.

[String!]!

required

The email addresses that receive the report, normalized.

Example

mutation {
  payoutReportSettingsUpdate(input: { ... }) {
    defaultFields
    enabled
    fields
    recipients
  }
}

Getting Started

Guides

Reference

payoutReportSettingsUpdate

Arguments

Returns

Example

​Arguments

​Returns

​Example

Arguments

Returns

Example