Skip to main content

APInvoice

APInvoices. 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 APInvoice {
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​

APInvoice.documentType ● String! non-null scalar​

documentType > (PK) The type of the document.

APInvoice.referenceNumber ● String! non-null scalar​

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

APInvoice.docDate ● DateTime! non-null scalar​

docDate > The date of the document.

APInvoice.origInvoiceDate ● DateTime scalar​

origInvoiceDate > The original invoice date, if applicable.

APInvoice.status ● String! non-null scalar​

status > The current status of the document.

APInvoice.appStatus ● Int scalar​

appStatus > The application status of the document.

APInvoice.hold ● Boolean! non-null scalar​

hold > Indicates whether the document is on hold.

APInvoice.financialPeriod ● String! non-null scalar​

financialPeriod > The financial period associated with the document.

APInvoice.description ● String scalar​

description > A description or additional details about the document.

APInvoice.supplierId ● Int! non-null scalar​

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

APInvoice.locationId ● Int! non-null scalar​

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

APInvoice.currencyId ● String! non-null scalar​

currencyId > The currency identifier used in the document.

APInvoice.exchangeRate ● Decimal scalar​

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

APInvoice.dueDate ● DateTime scalar​

dueDate > The due date for payment of the document.

APInvoice.vatTotal ● Decimal! non-null scalar​

vatTotal > The total VAT amount in the document.

APInvoice.vatTotalInCurrency ● Decimal! non-null scalar​

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

APInvoice.vatTaxableTotal ● Decimal! non-null scalar​

vatTaxableTotal > The total taxable VAT amount in the document.

APInvoice.vatTaxableTotalInCurrency ● Decimal! non-null scalar​

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

APInvoice.vatExemptTotal ● Decimal! non-null scalar​

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

APInvoice.vatExemptTotalInCurrency ● Decimal! non-null scalar​

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

APInvoice.withholdingTax ● Decimal! non-null scalar​

withholdingTax > The total withholding tax amount in the document.

APInvoice.withholdingTaxInCurrency ● Decimal! non-null scalar​

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

APInvoice.cashDiscountInCurrency ● Decimal! non-null scalar​

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

APInvoice.cashDiscount ● Decimal! non-null scalar​

cashDiscount > The cash discount amount in the document.

APInvoice.balance ● Decimal! non-null scalar​

balance > The remaining balance in the document.

APInvoice.balanceInCurrency ● Decimal! non-null scalar​

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

APInvoice.amount ● Decimal! non-null scalar​

amount > The total amount in the document.

APInvoice.amountInCurrency ● Decimal! non-null scalar​

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

APInvoice.detailTotal ● Decimal! non-null scalar​

detailTotal > The total amount of details in the document.

APInvoice.detailTotalInCurrency ● Decimal! non-null scalar​

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

APInvoice.note ● String scalar​

note > Additional notes or comments about the document.

APInvoice.closedFinancialPeriod ● String scalar​

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

APInvoice.accountId ● Int! non-null scalar​

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

APInvoice.subaccountId ● Int! non-null scalar​

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

APInvoice.paymentMessage ● String scalar​

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

APInvoice.paymentRefNo ● String scalar​

paymentRefNo > The payment reference number associated with the document.

APInvoice.paymentMethodId ● String scalar​

paymentMethodId > The payment method identifier associated with the document.

APInvoice.termsId ● String scalar​

termsId > The terms identifier associated with the document.

APInvoice.cashDiscountDate ● DateTime scalar​

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

APInvoice.batchNumber ● String scalar​

batchNumber > The batch number associated with the document.

APInvoice.payDate ● DateTime scalar​

payDate > The payment date associated with the document.

APInvoice.supplierReference ● String scalar​

supplierReference > The supplier's reference for the document.

APInvoice.branchId ● Int! non-null scalar​

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

APInvoice.paySelected ● Boolean scalar​

paySelected > Indicates whether the document is selected for payment.

APInvoice.voucherId ● String scalar​

voucherId > The voucher identifier associated with the document.

APInvoice.createdDateTime ● DateTime! non-null scalar​

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

APInvoice.releasedDateTime ● DateTime scalar​

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

APInvoice.released ● Boolean! non-null scalar​

released > Indicates whether the document has been released.

APInvoice.voided ● Boolean! non-null scalar​

voided > Indicates whether the document has been voided.

APInvoice.prebooked ● Boolean! non-null scalar​

prebooked > Indicates whether the document has been prebooked.

APInvoice.installmentCntr ● Short scalar​

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

APInvoice.cashAccountId ● Int scalar​

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

APInvoice.lastModifiedDateTime ● DateTime! non-null scalar​

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

APInvoice.deletedDatabaseRecord ● Boolean! non-null scalar​

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

APInvoice.companyId ● Int! non-null scalar​

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

APInvoice.id ● String! non-null scalar​

id > The unique identifier of the document in DataMart.

APInvoice.createdInDataMartDateTime ● DateTime! non-null scalar​

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

APInvoice.updatedInDataMartDateTime ● DateTime! non-null scalar​

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

Show deprecated

APInvoice.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.

APInvoice.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​

apInvoices query