API documentation | API docs for agents | OpenAPI 3.1

payment-terms

ark.create_payment_term

Creates an organization payment term that can be assigned to customers, carriers, or factoring companies.

Availability: Expanded preview
Scopes: billing:write
ARK permissions: canViewBillingcanMakeAdjustments
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

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

daysintegerrequired

min: 1; max: 365

discountnumber

default: 0; min: 0; max: 100

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/billing/payment-terms' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "days": 1
}'

Success response

Created payment term

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.termobjectrequired

data.messagestringrequired

Errors

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