STstuut
ap-portals

Associate Account Partner

Associate partners

Tie an AP-portal login to one or more customer partners. Creates the ap_portal config row for each partner that has none yet; otherwise repoints its login to this account. Required before sweep will enqueue a sweep for that partner. All-or-nothing: an unknown partner id fails the whole request.

post/v2/ap-portals/accounts/{account_id}/associate

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

account_idstring required

Request body

partner_idsstring[] required
namestring nullable

AP portal display name. Defaults to each partner's name.

customer_namestring nullable

Buyer/customer name as shown in the portal. Defaults to each partner's name.

customer_identifierstring nullable

Optional buyer/customer identifier used by some providers.

submission_profilestring nullable

Deprecated legacy submission profile key; not required. Use buyer form revisions for invoice preparation. Retained for compatibility: omit to leave an existing portal's legacy profile unchanged; send null to clear it.

submission_configobject nullable

Per-buyer supplier identity ids for submit (address / legal-entity picks). Omit to leave an existing portal's config unchanged; send null to clear it. Unknown or missing keys are rejected.

is_enabledboolean nullable

Whether the portal config is active. Defaults to True on create; omit on re-associate to leave an existing portal's enabled state unchanged.

is_invoice_submit_enabledboolean nullable

Whether invoices for this buyer may be sent live. Defaults to False on create; omit on re-associate to leave an existing portal unchanged. This is separate from is_enabled: while this is off, the buyer still supports previews and dry runs.

Response

Successful Response

idstring required
buyer_idstring nullable required
partner_idstring required
account_idstring nullable required
account_keystring nullable required
provider'kehe' | 'taulia' | 'coupa' | 'ariba' | 'meijer' | 'kroger' | 'walgreens' | 'albertsons' | 'target' | 'heb' | 'heb_sidm' | 'c_and_s' | 'walmart' | 'walmart_highradius' | 'cvs' | 'cvs_sap' | 'cvs_image_silo' | 'kroger_supplier_connect' | 'kroger_claimtrax' | 'kroger_verigon' | 'servicetitan' | 'sandbox' | 'generic' required

Supported AP Portal providers.

namestring nullable required
customer_namestring nullable required
customer_identifierstring nullable required
is_enabledboolean required
is_invoice_submit_enabledboolean required
status'active' | 'paused' required

Status of an AP portal.

Changes

No recorded changes to this operation across all 1 revision of this API.