Skip to main content

PaymentScheduleItem

Defines a payment schedule item.

type PaymentScheduleItem {
  alternateCurrencyAmounts: [Money!]!
  createdAt: DateTime!
  createdBy: String
  dueDate: LocalDate
  id: ID!
  invoiceTermDays: NonNegativeInt!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  type: PaymentScheduleItemType!
  value: Float!
}

Fields​

PaymentScheduleItem.alternateCurrencyAmounts ● [Money!]! non-null object​

The list of alternate currency amounts for the payment schedule item when the type is AMOUNT.

PaymentScheduleItem.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

PaymentScheduleItem.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

PaymentScheduleItem.dueDate ● LocalDate scalar​

The date the payment schedule item is due. Optional.

If not specified the due date is date of booking + invoice terms days.

PaymentScheduleItem.id ● ID! non-null scalar​

The unque identifier of the payment schedule item.

PaymentScheduleItem.invoiceTermDays ● NonNegativeInt! non-null scalar​

The number of days for the invoice term.

PaymentScheduleItem.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

PaymentScheduleItem.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

PaymentScheduleItem.type ● PaymentScheduleItemType! non-null enum​

The type of the payment schedule item.

PaymentScheduleItem.value ● Float! non-null scalar​

The value for the payment schedule item.

  • When type is AMOUNT, the value will be the amount due for the payment schedule item in the event default currency.
  • When type is INCREMENTAL_PERCENTAGE, the value will be a percentage expressed as a decimal.
  • When type is BALANCE_DUE, the value will be 0.
  • When type is NUMBER_OF_NIGHTS, the value will be the number of nights.

Member Of​

PaymentPolicy object