Skip to main content

APPayment

SupplierPayments. Represents a supplier payment. Note: if a Payment is deleted on ERP side this will not be reflected in DataMart for the time being. Support for deletion detection is in development.

type APPayment {
  documentType: String!
  refNbr: String!
  status: String!
  hold: Boolean!
  applicationPeriod: String!
  applicationDate: DateTime!
  paymentRef: String
  paymentMethod: String
  released: Boolean!
  cashAccountId: Int
  lastModifiedDateTime: DateTime!
  currencyId: String!
  description: String
  supplierId: Int!
  locationId: Int!
  paymentAmount: Decimal!
  paymentAmountInBaseCurrency: Decimal!
  financeCharges: Decimal!
  unappliedBalance: Decimal!
  appliedAmount: Decimal!
  postedDateTime: DateTime
  paymentDate: DateTime!
  financialPeriod: String
  branchId: Int!
  voided: Boolean!
  deletedDatabaseRecord: Boolean!
  companyId: Int!
  id: String!
  createdInDataMartDateTime: DateTime!
  updatedInDataMartDateTime: DateTime!
}

Fields

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

documentType > (PK) The type of the document.

`APPayment.refNbr` ● `String!` non-null scalar

refNbr > (PK) The reference number of the document.

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

status > The status of the document.

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

hold > Indicates if the document is on hold.

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

applicationPeriod > The financial period of the application.

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

applicationDate > The date of the application.

`APPayment.paymentRef` ● `String` scalar

paymentRef > The external reference number of the payment.

`APPayment.paymentMethod` ● `String` scalar

paymentMethod > The method of payment.

`APPayment.released` ● `Boolean!` non-null scalar

released > Indicates if the document is released.

`APPayment.cashAccountId` ● `Int` scalar

cashAccountId > The ID of the cash account.

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

lastModifiedDateTime > The last modified date and time of the document.

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

currencyId > The ID of the currency.

`APPayment.description` ● `String` scalar

description > The description of the document.

`APPayment.supplierId` ● `Int!` non-null scalar

supplierId > The ID of the supplier.

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

locationId > The ID of the location.

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

paymentAmount > The amount of the payment.

`APPayment.paymentAmountInBaseCurrency` ● `Decimal!` non-null scalar

paymentAmountInBaseCurrency > The amount of the payment in the base currency of the company.

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

financeCharges > The finance charges of the payment.

`APPayment.unappliedBalance` ● `Decimal!` non-null scalar

unappliedBalance > The unapplied balance of the payment.

`APPayment.appliedAmount` ● `Decimal!` non-null scalar

appliedAmount > The applied amount of the payment.

`APPayment.postedDateTime` ● `DateTime` scalar

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

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

paymentDate > The document date of the payment.

`APPayment.financialPeriod` ● `String` scalar

financialPeriod > The financial period the payment was posted in.

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

branchId > The ID of the branch.

`APPayment.voided` ● `Boolean!` non-null scalar

voided > Indicates if the payment has been voided.

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

deletedDatabaseRecord > Indicates whether this record has been marked as deleted in the database.

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

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

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

id > The unique identifier of the document in DataMart.

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

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

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

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

Returned By

apPayments query

Fields
Returned By