CreateCustomerCollectionInput

A payment received from a customer.

input CreateCustomerCollectionInput {
  allocations: [PaymentAllocationInput!]
  amount: Float!
  bankAccountId: ID
  collectionDate: DateTime!
  collectionMethod: CollectionMethod!
  currency: String!
  customerId: ID!
  exchangeRate: Float
  idempotencyKey: String
  notes: String
  referenceNumber: String
  salesOrderId: ID
}

Fields

CreateCustomerCollectionInput.allocations ● [PaymentAllocationInput!] list input

The invoices to apply the money to and the amount for each. Leave out to keep the money on account.

CreateCustomerCollectionInput.amount ● Float! non-null scalar

The amount received, in the collection's currency. Must be positive.

CreateCustomerCollectionInput.bankAccountId ● ID scalar

The ID of the bank account that received the money.

CreateCustomerCollectionInput.collectionDate ● DateTime! non-null scalar

The date the money was received.

CreateCustomerCollectionInput.collectionMethod ● CollectionMethod! non-null enum

How the customer paid.

CreateCustomerCollectionInput.currency ● String! non-null scalar

ISO 4217 currency code.

CreateCustomerCollectionInput.customerId ● ID! non-null scalar

The ID of the customer.

CreateCustomerCollectionInput.exchangeRate ● Float scalar

The exchange rate to the organization's base currency. Needed when the currency is not the base currency.

CreateCustomerCollectionInput.idempotencyKey ● String scalar

A unique key of 8 to 128 characters. Sending the same key again returns the collection already created instead of a duplicate.

CreateCustomerCollectionInput.notes ● String scalar

Free-text notes about the collection.

CreateCustomerCollectionInput.referenceNumber ● String scalar

The customer's reference for the payment, such as a cheque or transfer number.

CreateCustomerCollectionInput.salesOrderId ● ID scalar

The customer's sales order this money is for, when it arrives before the order is invoiced (a prepayment). Must be an order of the same customer.

Member Of

createCustomerCollection mutation