Get payer settings

Retrieve the selected payer Account's effective settings through the calling Account's authorized relationship with the specified Payer. A V3-created child can inherit payableDefaults, defaultPaymentMethod and default or currency-specific payroll funding sources through its parent link's payerSettings mode; payoutDelay, instantPayoutEligible, defaultAccountCurrency, other payroll settings and employerPayrollSettings remain local. Payable terms resolve engagement, relationship, then effective payer Account defaults; payee-issued Invoice terms remain payee-controlled. Auto-pay for both document types resolves engagement, relationship, then effective payer Account defaults; otherwise auto-pay is off. Explicit own values remain unchanged. This endpoint reads settings; a payee cannot write the linked payer Account's global settings.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^[A-Za-z0-9_.]{22,80}$
Headers
string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json