Skip to main content

CustomerPayment

CustomerPayments. Represents a customer payment transaction derived from ARPayment and ARRegister.

type CustomerPayment {
  documentType: String!
  referenceNumber: String!
  status: String!
  hold: Boolean!
  applicationDate: DateTime!
  applicationPeriod: String!
  paymentRef: String
  customerId: Int!
  locationId: Int!
  paymentMethodId: String
  cashAccountId: Int
  currencyId: String!
  paymentAmount: Decimal!
  invoiceText: String
  appliedToDocuments: Decimal
  appliedToOrders: Decimal
  availableBalance: Decimal
  writeOffAmount: Decimal
  financeCharges: Decimal!
  deductedCharges: Decimal!
  branchId: Int!
  paymentDate: DateTime!
  lastModifiedDateTime: DateTime!
  postedDateTime: DateTime
  deletedDatabaseRecord: Boolean!
  companyId: Int!
  id: String!
  createdInDataMartDateTime: DateTime!
  updatedInDataMartDateTime: DateTime!
}

Fields

`CustomerPayment.documentType` ● `String!` non-null scalar

documentType > (PK) The type of the customer payment document.

`CustomerPayment.referenceNumber` ● `String!` non-null scalar

referenceNumber > (PK) The reference number of the customer payment.

`CustomerPayment.status` ● `String!` non-null scalar

status > The current status of the customer payment.

`CustomerPayment.hold` ● `Boolean!` non-null scalar

hold > Indicates if the customer payment is on hold.

`CustomerPayment.applicationDate` ● `DateTime!` non-null scalar

applicationDate > The date when the customer payment was applied.

`CustomerPayment.applicationPeriod` ● `String!` non-null scalar

applicationPeriod > The financial period when the customer payment was applied.

`CustomerPayment.paymentRef` ● `String` scalar

paymentRef > The external reference number of the payment.

`CustomerPayment.customerId` ● `Int!` non-null scalar

customerId > The unique identifier of the customer.

`CustomerPayment.locationId` ● `Int!` non-null scalar

locationId > The customer location identifier.

`CustomerPayment.paymentMethodId` ● `String` scalar

paymentMethodId > The payment method identifier of the customer payment.

`CustomerPayment.cashAccountId` ● `Int` scalar

cashAccountId > The cash account identifier associated with the payment.

`CustomerPayment.currencyId` ● `String!` non-null scalar

currencyId > The unique identifier of the currency used by the customer payment.

`CustomerPayment.paymentAmount` ● `Decimal!` non-null scalar

paymentAmount > The total amount of the customer payment.

`CustomerPayment.invoiceText` ● `String` scalar

invoiceText > The description text of the payment.

`CustomerPayment.appliedToDocuments` ● `Decimal` scalar

appliedToDocuments > The amount applied to documents.

`CustomerPayment.appliedToOrders` ● `Decimal` scalar

appliedToOrders > The amount applied to orders.

`CustomerPayment.availableBalance` ● `Decimal` scalar

availableBalance > The available balance of the payment.

`CustomerPayment.writeOffAmount` ● `Decimal` scalar

writeOffAmount > The amount written off from the payment.

`CustomerPayment.financeCharges` ● `Decimal!` non-null scalar

financeCharges > The finance charges associated with the payment.

`CustomerPayment.deductedCharges` ● `Decimal!` non-null scalar

deductedCharges > The consolidated charge total that was deducted.

`CustomerPayment.branchId` ● `Int!` non-null scalar

branchId > The unique identifier of the branch associated with the customer payment.

`CustomerPayment.paymentDate` ● `DateTime!` non-null scalar

paymentDate > The date of the customer payment.

`CustomerPayment.lastModifiedDateTime` ● `DateTime!` non-null scalar

lastModifiedDateTime > The last modified date and time of the customer payment.

`CustomerPayment.postedDateTime` ● `DateTime` scalar

postedDateTime > The date and time when the customer payment was posted.

`CustomerPayment.deletedDatabaseRecord` ● `Boolean!` non-null scalar

deletedDatabaseRecord > Indicates if the corresponding record in the database has been deleted.

`CustomerPayment.companyId` ● `Int!` non-null scalar

companyId > (PK) The unique identifier of the company.

`CustomerPayment.id` ● `String!` non-null scalar

id > The unique identifier of the document in DataMart.

`CustomerPayment.createdInDataMartDateTime` ● `DateTime!` non-null scalar

createdInDataMartDateTime > The UTC DateTime when this document has been added to DataMart.

`CustomerPayment.updatedInDataMartDateTime` ● `DateTime!` non-null scalar

updatedInDataMartDateTime > The UTC DateTime when this document has been updated in DataMart.

Returned By

customerPayments query

Fields
Returned By