ARK TMS

API documentation | API docs for agents | OpenAPI 3.1

PATCH /api/v1/factoring-companies/{factoringCompanyId}

ark.update_factoring_company

Updates an organization factoring company and lets authorized users set or clear sensitive payment fields without echoing them back.

Availability
Expanded preview
Scopes
factoring:write
ARK permissions
canEditFactoring
Team visibility
Not entity-scoped
Idempotency-Key
Required for this write
Approval
No MCP approval on REST API-token calls
Rate limit
API credential and organization budgets

Parameters

factoringCompanyIdpathstringrequired
format: uuid
Idempotency-Keyheaderstringrequired
Required for external write operations. Reuse the same key only for exact retries of the same request body.
min length: 1; max length: 200

Request body

activeboolean
namestring

min length: 1; max length: 200

notesstring | null

max length: 5000

federalTaxIdstring | null

Sensitive tax ID to set. Use null to clear; value is never returned.

max length: 100

paymentMethodstring | null

max length: 50

paymentTermIdstring

format: uuid

bankNamestring | null

max length: 100

bankTypestring | null

max length: 50

bankAccountNumstring | null

Sensitive bank account number to set. Use null to clear; value is never returned.

max length: 100

bankRoutingNumstring | null

Sensitive 9-digit routing number to set. Use null to clear; value is never returned.

max length: 50

Example request

Shell
curl -X PATCH 'https://arktms.com/api/v1/factoring-companies/<factoringCompanyId>' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{}'

Success response

Updated factoring company

objectstringrequired
okbooleanrequired
api_versionstringrequired
request_idstringrequired
dataobjectrequired
data.messagestringrequired

Errors

HTTP 400
Invalid request
HTTP 401
Authentication required
HTTP 403
Permission, scope, team, or entitlement denied
HTTP 404
Resource not found
HTTP 409
Idempotency conflict or in-progress retry