v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB

Payment Terms

Create payment term

Create a new payment term configuration in your organization

post/payment-terms

Request body

namestring required

Payment term name

descriptionstring

Payment term description or notes

daysinteger

Number of days until payment is due

quickPayFeenumber float

Quick pay fee percentage (e.g., 0.05 for 5%)

apOnlyboolean

Whether this payment term is for accounts payable only

doNotUseboolean

Flag to prevent using this payment term for new transactions

keystring

Client-defined reference identifier

Example request

{
  "name": "Net 30",
  "description": "Payment due 30 days from invoice date",
  "days": 30,
  "quickPayFee": 0.05,
  "key": "ERP-PAYTERM-NET30"
}

Response

Payment term created successfully

idstring uuid required

Unique payment term identifier

namestring required

Payment term name

descriptionstring nullable

Payment term description or notes

daysinteger nullable

Number of days until payment is due

quickPayFeenumber float nullable

Quick pay fee percentage (e.g., 0.05 for 5%)

apOnlyboolean nullable

Whether this payment term is for accounts payable only

doNotUseboolean nullable

Flag to prevent using this payment term for new transactions

keystring nullable

Client-defined reference identifier

createdAtstring date-time required

When the payment term was created

updatedAtstring date-time required

When the payment term was last updated

deletedAtstring date-time nullable

When the payment term was soft deleted (null if active)

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Net 30",
  "description": "Payment due 30 days from invoice date",
  "days": 30,
  "quickPayFee": 0.05,
  "key": "ERP-PAYTERM-NET30",
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z"
}