CustomerDocument

CustomerDocuments. Represents a document associated with a customer (e.g., Invoice, Credit Memo).

type CustomerDocument {
  paymentMethodId: String
  postPeriod: String!
  financialPeriod: String!
  customerRefNbr: String
  referenceNumber: String!
  paymentReference: String
  voucherId: String
  contractDocRef: String
  childRecordNumber: Int
  vatTotal: Decimal
  vatTotalInCurrency: Decimal
  accountId: Int
  subAccountId: Int
  dueDate: DateTime
  documentType: String!
  documentDate: DateTime
  status: String!
  currencyId: String!
  amount: Decimal
  amountInCurrency: Decimal
  balance: Decimal
  balanceInCurrency: Decimal
  cashDiscount: Decimal
  cashDiscountInCurrency: Decimal
  invoiceText: String
  locationId: Int
  lastModifiedDateTime: DateTime!
  createdDateTime: DateTime!
  customerId: Int!
  branchId: Int!
  deletedDatabaseRecord: Boolean!
  creditTermsId: String
  cashDiscountDate: DateTime
  externalReference: String
  isRotRutDeductible: Boolean
  exchangeRate: Decimal
  hold: Boolean
  detailTotal: Decimal
  detailTotalInCurrency: Decimal
  vatTaxableTotal: Decimal
  vatTaxableTotalInCurrency: Decimal
  vatExemptTotal: Decimal
  vatExemptTotalInCurrency: Decimal
  salesPersonId: Int
  attachments: [Attachment!]
  note: String
  projectId: Int
  dunningLetterDate: DateTime
  dunningLetterLevel: Int
  releasedDateTime: DateTime
  companyId: Int!
  id: String!
  createdInDataMartDateTime: DateTime!
  updatedInDataMartDateTime: DateTime!
}

Fields

CustomerDocument.paymentMethodId ● String scalar

paymentMethodId > The payment method of the customer. This field is optional and can be null.

CustomerDocument.postPeriod ● String! non-null scalar

postPeriod > The post period of the customer document. This field is required and cannot be null.

CustomerDocument.financialPeriod ● String! non-null scalar

financialPeriod > The financial period of the customer document. This field is required and cannot be null.

CustomerDocument.customerRefNbr ● String scalar

customerRefNbr > The customer reference number. This field is optional and can be null.

CustomerDocument.referenceNumber ● String! non-null scalar

referenceNumber > (PK) The reference number of the customer document. This field is required and cannot be null.

CustomerDocument.paymentReference ● String scalar

paymentReference > The payment reference string associated with the customer document. This field is optional and can be null.

CustomerDocument.voucherId ● String scalar

voucherId > The general ledger voucher identifier associated with the customer document. This field is optional and can be null.

CustomerDocument.contractDocRef ● String scalar

contractDocRef > The contract document reference associated with the customer document. This field is optional and can be null.

CustomerDocument.childRecordNumber ● Int scalar

childRecordNumber > The child customer account identifier associated with the customer document. This field is optional and can be null.

CustomerDocument.vatTotal ● Decimal scalar

vatTotal > The Vat Total for the customer document. This field is optional and can be null.

CustomerDocument.vatTotalInCurrency ● Decimal scalar

vatTotalInCurrency > The Vat Total in the currency used by the customer. This field is optional and can be null.

CustomerDocument.accountId ● Int scalar

accountId > The unique identifier of the account associated with the customer. This field is optional and can be null.

CustomerDocument.subAccountId ● Int scalar

subAccountId > The unique identifier of the subaccount associated with the customer. This field is optional and can be null.

CustomerDocument.dueDate ● DateTime scalar

dueDate > The date and time when the customer document is due. This field is optional and can be null.

CustomerDocument.documentType ● String! non-null scalar

documentType > (PK) The type of the customer document. This field is required and cannot be null.

CustomerDocument.documentDate ● DateTime scalar

documentDate > The date of the customer document. This field is optional and can be null.

CustomerDocument.status ● String! non-null scalar

status > The current status of the customer document. This field is required and cannot be null.

CustomerDocument.currencyId ● String! non-null scalar

currencyId > The unique identifier of the currency used by the customer document. This field is required and cannot be null.

CustomerDocument.amount ● Decimal scalar

amount > The amount of the customer document. This field is optional and can be null.

CustomerDocument.amountInCurrency ● Decimal scalar

amountInCurrency > The amount of the customer document in the currency used by the customer. This field is optional and can be null.

CustomerDocument.balance ● Decimal scalar

balance > The balance of the customer document. This field is optional and can be null.

CustomerDocument.balanceInCurrency ● Decimal scalar

balanceInCurrency > The balance of the customer document in currency. This field is optional and can be null.

CustomerDocument.cashDiscount ● Decimal scalar

cashDiscount > The cash discount applicable to the customer document. This field is optional and can be null.

CustomerDocument.cashDiscountInCurrency ● Decimal scalar

cashDiscountInCurrency > The cash discount in currency applicable to the customer document. This field is optional and can be null.

CustomerDocument.invoiceText ● String scalar

invoiceText > The text of the invoice associated with the customer document. This field is optional and can be null.

CustomerDocument.locationId ● Int scalar

locationId > The unique identifier of the location associated with the customer document. This field is optional and can be null.

CustomerDocument.lastModifiedDateTime ● DateTime! non-null scalar

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

CustomerDocument.createdDateTime ● DateTime! non-null scalar

createdDateTime > The date and time when the customer document record was created.

CustomerDocument.customerId ● Int! non-null scalar

customerId > The customer id. This field is required and cannot be null.

CustomerDocument.branchId ● Int! non-null scalar

branchId > The unique identifier of the branch associated with the customer. This field is required and cannot be null.

CustomerDocument.deletedDatabaseRecord ● Boolean! non-null scalar

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

CustomerDocument.creditTermsId ● String scalar

creditTermsId > The credit terms identifier associated with the invoice.

CustomerDocument.cashDiscountDate ● DateTime scalar

cashDiscountDate > The cash discount date of the invoice.

CustomerDocument.externalReference ● String scalar

externalReference > The external reference of the invoice.

CustomerDocument.isRotRutDeductible ● Boolean scalar

isRotRutDeductible > Indicates if the invoice is RUT/ROT deductible.

CustomerDocument.exchangeRate ● Decimal scalar

exchangeRate > The exchange rate used for the invoice.

CustomerDocument.hold ● Boolean scalar

hold > Indicates if the invoice is on hold.

CustomerDocument.detailTotal ● Decimal scalar

detailTotal > The total of the invoice details.

CustomerDocument.detailTotalInCurrency ● Decimal scalar

detailTotalInCurrency > The total of the invoice details in currency.

CustomerDocument.vatTaxableTotal ● Decimal scalar

vatTaxableTotal > The VAT taxable total.

CustomerDocument.vatTaxableTotalInCurrency ● Decimal scalar

vatTaxableTotalInCurrency > The VAT taxable total in currency.

CustomerDocument.vatExemptTotal ● Decimal scalar

vatExemptTotal > The VAT exempt total.

CustomerDocument.vatExemptTotalInCurrency ● Decimal scalar

vatExemptTotalInCurrency > The VAT exempt total in currency.

CustomerDocument.salesPersonId ● Int scalar

salesPersonId > The sales person identifier.

CustomerDocument.attachments ● [Attachment!] list object

attachments > Files that have been uploaded to this Customer Document.

CustomerDocument.note ● String scalar

note > The text of the note associated with the document. This field is optional and can be null.

CustomerDocument.projectId ● Int scalar

projectId > The unique identifier of the project associated with the customer document. This field is optional and can be null.

CustomerDocument.dunningLetterDate ● DateTime scalar

dunningLetterDate > The date and time when the dunning letter was created.

CustomerDocument.dunningLetterLevel ● Int scalar

dunningLetterLevel > The unique identifier of the dunning letter level associated with the customer document. This field is optional and can be null.

CustomerDocument.releasedDateTime ● DateTime scalar

releasedDateTime > The date and time when the document was released. This field is optional and can be null.

CustomerDocument.companyId ● Int! non-null scalar

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

CustomerDocument.id ● String! non-null scalar

id > The unique identifier of the document in DataMart.

CustomerDocument.createdInDataMartDateTime ● DateTime! non-null scalar

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

CustomerDocument.updatedInDataMartDateTime ● DateTime! non-null scalar

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

Returned By

customerDocuments query