List payment terms

GET /api/v1/payment-terms

List all payment terms for the business.

Operation ID: list_payment_terms_api_v1_payment_terms_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

active_only boolean default: True

Only show active terms

cursor string

Cursor for pagination

limit integer

Pagination limit

direction string default: next

Pagination direction: 'next' or 'prev'

include_total_count boolean default: False

Whether to include total count (expensive - avoid if possible)

sort_by string

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descending boolean default: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: PaymentTermsListResponse

items array · PaymentTermResponse requiredPaymentTermResponse

List of items

10 fields
id string required

Payment term UUID

business_id string required

Business UUID

name string required

Display name

days_until_due integer required

Days until payment is due

discount_percent number

Early payment discount percentage

discount_days integer

Days to receive discount

is_default boolean required

Is default payment term

is_active boolean required

Is active

created_at string · date-time required

Creation timestamp

updated_at string · date-time required

Last update timestamp

total integer

Total number of items (null when not calculated for performance)

limit integer

Pagination limit

next_cursor string

Cursor for next page

prev_cursor string

Cursor for previous page

has_next boolean required

Whether there are more items

has_prev boolean required

Whether there are previous items

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object