Skip to main content

CreateEventPaymentInput

Define the input for creating a payment.

input CreateEventPaymentInput {
  comment: String
  currencyId: ID
  description: String
  eventId: ID!
  itemsToPay: [PayableItemToPayInput!]!
  paidById: ID!
  paymentTypeId: ID!
  recordedAt: DateTime!
  totalAmount: Float!
}

Fields​

CreateEventPaymentInput.comment ● String scalar​

A UTF-8 string comment for the information block. Optional.

CreateEventPaymentInput.currencyId ● ID scalar​

The identifier of the currency for the payment. Optional.

The default value is the identifier of the event currency for the event.

CreateEventPaymentInput.description ● String scalar​

A UTF-8 string that represents the description for the payment. Optional.

CreateEventPaymentInput.eventId ● ID! non-null scalar​

The identifier of the event for the payment.

CreateEventPaymentInput.itemsToPay ● [PayableItemToPayInput!]! non-null input​

The list of items and amounts to pay.

The identifier of the contact for the payment.

CreateEventPaymentInput.paymentTypeId ● ID! non-null scalar​

The identifier of the payment type for the payment.

Only payment types where the funding type is CASH are allowed.

CreateEventPaymentInput.recordedAt ● DateTime! non-null scalar​

The date and time at which the payment was recorded.

CreateEventPaymentInput.totalAmount ● Float! non-null scalar​

The total amount for the payment in the currency of the payment.

Member Of​

createEventPayment mutation