Ap Portal

Create or replace customer AP portal mapping

View as Markdown

Writes the customer’s AP portal mapping, creating it if there isn’t one. This is a full replacement, so any field you omit is cleared and an omitted status resets to PENDING — send the whole mapping every time. portalName is required when portal is OTHER and ignored for every other portal.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

customerIdstringRequired
Customer ID

Request

This endpoint expects an object.
portalenumRequired
AP portal invoices to this customer are submitted through
portalNamestringOptional<=255 characters

Free-text portal name. Required when portal is OTHER, ignored otherwise.

instanceUrlstringOptional<=2048 characters
Portal tenant URL. Omit to clear it.
supplierIdstringOptional<=255 characters

Your supplier/vendor ID within this portal. Omit to clear it.

statusenumOptional
Lifecycle of the mapping. Omit to reset it to PENDING.

Response

The stored AP portal mapping
payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional
json element with any error messages or warnings

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error