Skip to main content

PaymentTerm

An organization's payment term, such as Net 30, that sets when an invoice is due.

type PaymentTerm {
  code: String!
  createdAt: DateTime
  description: String
  id: ID!
  isActive: Boolean!
  isDefault: Boolean!
  isPlatformDefault: Boolean!
  kind: PaymentTermKind!
  label: String!
  netDays: Int!
  sortOrder: Int!
  updatedAt: DateTime
}

Fields​

PaymentTerm.code ● String! non-null scalar​

Tenant-authored storage code, e.g. NET_30 or EOM_15.

PaymentTerm.createdAt ● DateTime scalar​

When the record was created.

PaymentTerm.description ● String scalar​

Free-text note about the term.

PaymentTerm.id ● ID! non-null scalar​

The unique ID of this record.

PaymentTerm.isActive ● Boolean! non-null scalar​

Whether the record is active.

PaymentTerm.isDefault ● Boolean! non-null scalar​

Whether this is the default.

PaymentTerm.isPlatformDefault ● Boolean! non-null scalar​

True when this row is served from the platform default set because the organization has not customized its terms yet. Such a row has no database id and cannot be updated until it is materialized.

PaymentTerm.kind ● PaymentTermKind! non-null enum​

What the term does: NET gives a credit period of netDays, COD and PREPAID have none.

PaymentTerm.label ● String! non-null scalar​

Tenant-editable display text, e.g. 'Net 30'.

PaymentTerm.netDays ● Int! non-null scalar​

The only input to due-date math: dueDate = invoiceDate + netDays.

PaymentTerm.sortOrder ● Int! non-null scalar​

The position of the term in lists, lowest first.

PaymentTerm.updatedAt ● DateTime scalar​

When the record was last changed.

Returned By​

createPaymentTerm mutation ● deactivatePaymentTerm mutation ● materializePaymentTerms mutation ● paymentTerms query ● setDefaultPaymentTerm mutation ● updatePaymentTerm mutation