PaymentTerm

Get payment terms

Get the payment terms configured for your company. A payment term is the agreed timeframe a customer has to pay — for example "Net 30" means payment is due 30 days after the order date.

Use it to resolve the payment term applied to an order or invoice, or to pick a valid term id for an integration that sets one. Each term carries: • name — the term's display label (e.g. "Net 30"), unique within your company. • days — a non-negative whole number of days added to compute the due date. 0 means due the same day (immediately). The due datetime is the order's start date plus days, set to time_of_day. The start date is normally the order date, but is the delivery date if your company is configured to date its due dates from delivery. • time_of_day — the local clock time the term becomes due on the due date, as HH:MM:SS on a 24-hour clock (e.g. "17:00:00" = 5 PM). It is interpreted in your company's configured time zone, not UTC. • lockedtrue marks a built-in system term whose length (days) is fixed and which cannot be deleted; only its time_of_day is changeable. false marks a fully editable, user-created term. Independently of locked, any term (locked or not) currently chosen as the company's default order or default purchase payment term cannot be deleted while it holds that role — but this endpoint does not expose which term is a default.

Returns every payment term for your company in a single response — this endpoint is not paginated, so next_page is always null and there are no filter or page parameters. Order of the returned terms is not guaranteed.

Note: This endpoint returns eventually consistent data — a term you just created, edited, or deleted elsewhere may take up to 1 second to appear or disappear here.

Required permission: settings_permissions_payment_terms.

get/public/v1/payment-terms

Response

A list of payment terms

Changes

No recorded changes to this endpoint across all 1 revision of this API.