SupplierDocument

SupplierDocuments. Represents a supplier document (e.g., Invoice). Note: if a Supplier Document is deleted on ERP side this will not be reflected in DataMart for the time being. Support for deletion detection is in development.

type SupplierDocument {
  documentType: String!
  referenceNumber: String!
  docDate: DateTime!
  origInvoiceDate: DateTime
  status: String!
  appStatus: Int
  hold: Boolean!
  financialPeriod: String!
  description: String
  supplierId: Int!
  locationId: Int!
  currencyId: String!
  exchangeRate: Decimal
  dueDate: DateTime
  vatTotal: Decimal!
  vatTotalInCurrency: Decimal!
  vatTaxableTotal: Decimal!
  vatTaxableTotalInCurrency: Decimal!
  vatExemptTotal: Decimal!
  vatExemptTotalInCurrency: Decimal!
  withHoldingTax: Decimal! @deprecated
  withholdingTax: Decimal!
  withHoldingTaxInCurrency: Decimal! @deprecated
  withholdingTaxInCurrency: Decimal!
  cashDiscountInCurrency: Decimal!
  cashDiscount: Decimal!
  balance: Decimal!
  balanceInCurrency: Decimal!
  amount: Decimal!
  amountInCurrency: Decimal!
  detailTotal: Decimal!
  detailTotalInCurrency: Decimal!
  note: String
  closedFinancialPeriod: String
  accountId: Int!
  subaccountId: Int!
  paymentMessage: String
  paymentRefNo: String
  paymentMethodId: String
  termsId: String
  cashDiscountDate: DateTime
  batchNumber: String
  payDate: DateTime
  supplierReference: String
  branchId: Int!
  paySelected: Boolean
  voucherId: String
  createdDateTime: DateTime!
  releasedDateTime: DateTime
  released: Boolean!
  voided: Boolean!
  prebooked: Boolean!
  installmentCntr: Short
  cashAccountId: Int
  lastModifiedDateTime: DateTime!
  deletedDatabaseRecord: Boolean!
  companyId: Int!
  id: String!
  createdInDataMartDateTime: DateTime!
  updatedInDataMartDateTime: DateTime!
}

Fields

SupplierDocument.documentType ● String! non-null scalar

documentType > (PK) The type of the document.

SupplierDocument.referenceNumber ● String! non-null scalar

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

SupplierDocument.docDate ● DateTime! non-null scalar

docDate > The date of the document.

SupplierDocument.origInvoiceDate ● DateTime scalar

origInvoiceDate > The original invoice date, if applicable.

SupplierDocument.status ● String! non-null scalar

status > The current status of the document.

SupplierDocument.appStatus ● Int scalar

appStatus > The application status of the document.

SupplierDocument.hold ● Boolean! non-null scalar

hold > Indicates whether the document is on hold.

SupplierDocument.financialPeriod ● String! non-null scalar

financialPeriod > The financial period associated with the document.

SupplierDocument.description ● String scalar

description > A description or additional details about the document.

SupplierDocument.supplierId ● Int! non-null scalar

supplierId > The unique identifier of the supplier associated with the document.

SupplierDocument.locationId ● Int! non-null scalar

locationId > The unique identifier of the location associated with the document.

SupplierDocument.currencyId ● String! non-null scalar

currencyId > The currency identifier used in the document.

SupplierDocument.exchangeRate ● Decimal scalar

exchangeRate > The exchange rate applied to the document, if applicable.

SupplierDocument.dueDate ● DateTime scalar

dueDate > The due date for payment of the document.

SupplierDocument.vatTotal ● Decimal! non-null scalar

vatTotal > The total VAT amount in the document.

SupplierDocument.vatTotalInCurrency ● Decimal! non-null scalar

vatTotalInCurrency > The total VAT amount in the document's currency.

SupplierDocument.vatTaxableTotal ● Decimal! non-null scalar

vatTaxableTotal > The total taxable VAT amount in the document.

SupplierDocument.vatTaxableTotalInCurrency ● Decimal! non-null scalar

vatTaxableTotalInCurrency > The total taxable VAT amount in the document's currency.

SupplierDocument.vatExemptTotal ● Decimal! non-null scalar

vatExemptTotal > The total VAT-exempt amount in the document.

SupplierDocument.vatExemptTotalInCurrency ● Decimal! non-null scalar

vatExemptTotalInCurrency > The total VAT-exempt amount in the document's currency.

SupplierDocument.withholdingTax ● Decimal! non-null scalar

withholdingTax > The total withholding tax amount in the document.

SupplierDocument.withholdingTaxInCurrency ● Decimal! non-null scalar

withholdingTaxInCurrency > The total withholding tax amount in the document's currency.

SupplierDocument.cashDiscountInCurrency ● Decimal! non-null scalar

cashDiscountInCurrency > The cash discount amount in the document's currency.

SupplierDocument.cashDiscount ● Decimal! non-null scalar

cashDiscount > The cash discount amount in the document.

SupplierDocument.balance ● Decimal! non-null scalar

balance > The remaining balance in the document.

SupplierDocument.balanceInCurrency ● Decimal! non-null scalar

balanceInCurrency > The remaining balance in the document's currency.

SupplierDocument.amount ● Decimal! non-null scalar

amount > The total amount in the document.

SupplierDocument.amountInCurrency ● Decimal! non-null scalar

amountInCurrency > The total amount in the document's currency.

SupplierDocument.detailTotal ● Decimal! non-null scalar

detailTotal > The total amount of details in the document.

SupplierDocument.detailTotalInCurrency ● Decimal! non-null scalar

detailTotalInCurrency > The total amount of details in the document's currency.

SupplierDocument.note ● String scalar

note > Additional notes or comments about the document.

SupplierDocument.closedFinancialPeriod ● String scalar

closedFinancialPeriod > The financial period in which the document was closed, if applicable.

SupplierDocument.accountId ● Int! non-null scalar

accountId > The unique identifier of the account associated with the document.

SupplierDocument.subaccountId ● Int! non-null scalar

subaccountId > The unique identifier of the subaccount associated with the document.

SupplierDocument.paymentMessage ● String scalar

paymentMessage > A payment message or note associated with the document.

SupplierDocument.paymentRefNo ● String scalar

paymentRefNo > The payment reference number associated with the document.

SupplierDocument.paymentMethodId ● String scalar

paymentMethodId > The payment method identifier associated with the document.

SupplierDocument.termsId ● String scalar

termsId > The terms identifier associated with the document.

SupplierDocument.cashDiscountDate ● DateTime scalar

cashDiscountDate > The date by which the cash discount is applicable.

SupplierDocument.batchNumber ● String scalar

batchNumber > The batch number associated with the document.

SupplierDocument.payDate ● DateTime scalar

payDate > The payment date associated with the document.

SupplierDocument.supplierReference ● String scalar

supplierReference > The supplier's reference for the document.

SupplierDocument.branchId ● Int! non-null scalar

branchId > The unique identifier of the branch associated with the document.

SupplierDocument.paySelected ● Boolean scalar

paySelected > Indicates whether the document is selected for payment.

SupplierDocument.voucherId ● String scalar

voucherId > The voucher identifier associated with the document.

SupplierDocument.createdDateTime ● DateTime! non-null scalar

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

SupplierDocument.releasedDateTime ● DateTime scalar

releasedDateTime > The date and time when the supplier invoice was released.

SupplierDocument.released ● Boolean! non-null scalar

released > Indicates whether the document has been released.

SupplierDocument.voided ● Boolean! non-null scalar

voided > Indicates whether the document has been voided.

SupplierDocument.prebooked ● Boolean! non-null scalar

prebooked > Indicates whether the document has been prebooked.

SupplierDocument.installmentCntr ● Short scalar

installmentCntr > The number of installment documents generated from this master document; null for regular documents.

SupplierDocument.cashAccountId ● Int scalar

cashAccountId > The unique identifier of the cash account associated with the document.

SupplierDocument.lastModifiedDateTime ● DateTime! non-null scalar

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

SupplierDocument.deletedDatabaseRecord ● Boolean! non-null scalar

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

SupplierDocument.companyId ● Int! non-null scalar

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

SupplierDocument.id ● String! non-null scalar

id > The unique identifier of the document in DataMart.

SupplierDocument.createdInDataMartDateTime ● DateTime! non-null scalar

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

SupplierDocument.updatedInDataMartDateTime ● DateTime! non-null scalar

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

Show deprecated

SupplierDocument.withHoldingTax ● Decimal! deprecated non-null scalar

DEPRECATED

The value for this field is available in WithholdingTax. This property will be removed in the future.

withHoldingTax > The total withholding tax amount in the document.

SupplierDocument.withHoldingTaxInCurrency ● Decimal! deprecated non-null scalar

DEPRECATED

The value for this field is available in WithholdingTaxInCurrency. This property will be removed in the future.

withHoldingTaxInCurrency > The total withholding tax amount in the document's currency.

Returned By

supplierDocuments query