Skip to navigation

Create Payment Term

View as Markdown

Creates a payment term. Send net_days for a single due date, or instalments to split the total across two or more due dates. Either shape can carry an early-payment discount.

Instalments that are all PERCENTAGE_RATE must add up to 100. When percentages and flat amounts are mixed, the last instalment takes whatever remains of the document total. A percentage discount must be below 100, and the discount window must end before the final due date.

Requires the can_create_payment_term permission on the key owner’s role. Available when the Invoices or Bills service is enabled for the workspace.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active project.

Request

This endpoint expects an object.
namestringRequired<=50 characters
Unique within the workspace, ignoring case.
net_daysintegerOptional0-365Defaults to 0

Calendar days from the document date to the due date. Ignored when instalments is sent; the last instalment's net_days is used.

is_defaultbooleanOptionalDefaults to false
Make this the workspace default. The previous default is unset.
instalmentslist of objectsOptional

Omit for a single due date. Otherwise send at least two instalments, each with a different net_days.

discountobjectOptional

Early-payment discount. net_days is the last day it can be taken and must be earlier than the term's final due date.

Response

Created
dataobject
statusboolean
messagestring

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
422
Unprocessable Entity Error