Skip to main content

CreatePaymentTermInput

A new payment term for the organization.

input CreatePaymentTermInput {
code: String!
description: String
isActive: Boolean
isDefault: Boolean
kind: PaymentTermKind!
label: String!
netDays: Int!
sortOrder: Int
}

Fields​

CreatePaymentTermInput.code ● String! non-null scalar​

Tenant-authored code, immutable once created because documents store it. Shape: an uppercase letter then A-Z/0-9/underscore, 2-32 chars (e.g. NET_7, EOM_30).

CreatePaymentTermInput.description ● String scalar​

Longer explanation of the term.

CreatePaymentTermInput.isActive ● Boolean scalar​

Whether the term can be chosen on new documents.

CreatePaymentTermInput.isDefault ● Boolean scalar​

Make this the organization's default term. The service clears any previous default in the same transaction.

CreatePaymentTermInput.kind ● PaymentTermKind! non-null enum​

NET (due after netDays), COD (cash on delivery) or PREPAID.

CreatePaymentTermInput.label ● String! non-null scalar​

Name shown when choosing the term.

CreatePaymentTermInput.netDays ● Int! non-null scalar​

Number of days from the invoice date until payment is due.

CreatePaymentTermInput.sortOrder ● Int scalar​

Display order of the term in lists.

Member Of​

createPaymentTerm mutation