business logic query CInvoiceByAllocationInfo

Description

CInvoiceByAllocationInfo; query that returns all creditor-invoices that match the input parameters (= Allocation information)

Parameters

iiCompanyId	integer	Company id
icBusinessRelationCode	character
icCreditorCode	character	CreditorCode
icCInvoiceRefererence	character	CInvoiceRefererence
icCurrencyCode	character
iiCInvoiceID	integer	CInvoiceID
ilCInvoiceIsOpen	logical	CInvoiceIsOpen
idCInvoiceAmountTCMinimum	decimal	CInvoiceAmountTCMinimum (checked against the DebitBalanceTC or the CreditBalanceTC)
idCInvoiceAmountTCMaximum	decimal	CInvoiceAmountTCMaximum (checked against the DebitBalanceTC or the CreditBalanceTC)
iiPeriodYearMinimum	integer	PeriodYearMinimum; when filled, only invoices with a >= year will be returned.
iiPeriodYear	integer
icJournalCode	character	Daybook Code
iiVoucher	integer	Voucher
icCInvoiceMovementType	character	CInvoiceMovementType
ilCInvoiceIsSelected	logical	Is the CI already selected into a payment selection ?
icCInvoiceTSMNumber	character	CInvoiceTSMNumber
icCorporateGroupCode	character	Group Code
ilReasonIsLockPayment	logical
ilCompIsOICrossCy	logical	Open Item Cross Entity Allowed or not ?

query condition

each CInvoice where

CInvoice.Company_Id = iiCompanyId AND
CInvoice.CInvoiceReference matches icCInvoiceRefererence AND
((CInvoice.CInvoiceBalanceCreditTC >= idCInvoiceAmountTCMinimum AND
CInvoice.CInvoiceBalanceCreditTC <= idCInvoiceAmountTCMaximum ) OR
(CInvoice.CInvoiceBalanceDebitTC >= idCInvoiceAmountTCMinimum AND
CInvoice.CInvoiceBalanceDebitTC <= idCInvoiceAmountTCMaximum )) AND
CInvoice.CInvoice_ID = iiCInvoiceID AND
CInvoice.CInvoiceIsOpen = ilCInvoiceIsOpen AND
CInvoice.CInvoiceVoucher = iiVoucher AND
CInvoice.CInvoiceIsSelected = ilCInvoiceIsSelected AND
CInvoice.CInvoiceTSMNumber matches icCInvoiceTSMNumber

each CInvoiceMovement (inner-join) where

CInvoiceMovement.Company_Id = iiCompanyId AND
CInvoiceMovement.CInvoice_ID = CInvoice.CInvoice_ID AND
CInvoiceMovement.CInvoiceMovementType = icCInvoiceMovementType

first PostingLine (inner-join) where

PostingLine.Company_Id = iiCompanyId AND
PostingLine.PostingLine_ID = CInvoiceMovement.PostingLine_ID AND

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = CInvoice.Company_ID AND

each CompanyProperty (conditional-join) where

CompanyProperty.Company_Id = iiCompanyId AND
CompanyProperty.Company_ID = Company.Company_ID AND
CompanyProperty.CompanyPropertyIsOICrossCy = ilCompIsOICrossCy

first Creditor (inner-join) where

Creditor.SharedSet_Id = vi_CREDITOR_sharedset(iiCompanyId) AND
Creditor.Creditor_ID = CInvoice.Creditor_ID AND
Creditor.CreditorCode matches icCreditorCode

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Creditor.BusinessRelation_ID AND
BusinessRelation.BusinessRelationCode matches icBusinessRelationCode

first CorporateGroup (conditional-join) where

CorporateGroup.CorporateGroup_ID = BusinessRelation.CorporateGroup_ID AND
CorporateGroup.CorporateGroupCode = icCorporateGroupCode

first Currency (inner-join) where

Currency.Currency_ID = CInvoice.CInvoiceCurrency_ID AND
Currency.CurrencyCode = icCurrencyCode

first Division (outer-join) where

Division.SharedSet_Id = vi_DIVISION_sharedset(iiCompanyId) AND
Division.Division_ID = CInvoice.Division_ID AND

first GL (inner-join) where

GL.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL.GL_ID = CInvoice.ControlGL_ID AND

first Journal (inner-join) where

Journal.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal.Journal_ID = CInvoice.Journal_ID AND
Journal.JournalCode = icJournalCode

first PaymentCondition (inner-join) where

PaymentCondition.PaymentCondition_ID = CInvoice.NormalPaymentCondition_ID AND

first Period (inner-join) where

Period.Company_Id = iiCompanyId AND
Period.Period_ID = CInvoice.Period_ID AND
Period.PeriodYear >= iiPeriodYearMinimum AND
Period.PeriodYear = iiPeriodYear

first Reason (inner-join) where

Reason.Reason_ID = CInvoice.Reason_ID AND
Reason.ReasonIsLockPayment = ilReasonIsLockPayment

query sort order

Period.PeriodYear (ascending)
Journal.JournalCode (ascending)
CInvoice.CInvoiceVoucher (ascending)

query resultset tqCInvoiceByAllocationInfo

field name	data type	db field	description
tlBusinessRelationIsCompens	logical	BusinessRelation.BusinessRelationIsCompens	Customer/Supplier Compensation Allowed. This filed indicates how open items should be managed during payment processing when a customer and supplier are both associated with this business relation.
	api annotation:		PartialUpdate = yes - defaults to false.
tdCInvoiceCCRate	decimal	CInvoice.CInvoiceCCRate	SC Rate. The statutory exchange rate used by the invoice. The SC Invoice Amount is calculated based on the SC rate.
tdCInvoiceCCScale	decimal	CInvoice.CInvoiceCCScale	Scale Factor. This field indicates the scale factor applying to the SC rate in use for foreign currency payments.
tcCInvoiceCIText	character	CInvoice.CInvoiceCIText	CIDescription. A brief description for the SI posting.
	api annotation:		This field defaults from the CInvoiceDescription.
tcCInvoiceDescription	character	CInvoice.CInvoiceDescription	Description. A brief description of the invoice. The system generates a default description based on the Reference and Supplier Code.
tlCInvoiceIsInvoiceApproved	logical	CInvoice.CInvoiceIsInvoiceApproved	Invoice Approved. This field indicates if the invoice is already approved for payment.
	api annotation:		PartialUpdate = yes - defaults to false
tlCInvoiceIsLockPayment	logical	CInvoice.CInvoiceIsLockPayment	Lock Payment. This field indicates if the invoice is locked for payment. The invoice cannot be included in any automatic payment selections if this field is true.
	api annotation:		PartialUpdate = yes - defaults to false
tlCInvoiceIsWHT	logical	CInvoice.CInvoiceIsWHT	Withholding Tax
tdCInvoiceNonDiscAmtTC	decimal	CInvoice.CInvoiceNonDiscAmtTC	TC Non-discount Amount. This field display the invoice amount without discount in base currency.
ttCInvoicePostingDate	date	CInvoice.CInvoicePostingDate	Posting Date. This filed indicates the date on which the invoice is to be posted.
	api annotation:		This field defaults from the invoice creation date.
tdCInvoiceWHTBaseAmtCreditTC	decimal	CInvoice.CInvoiceWHTBaseAmtCreditTC	TC WHT Base Amount (CR)
tdCInvoiceWHTBaseAmtDebitTC	decimal	CInvoice.CInvoiceWHTBaseAmtDebitTC	TC WHT Base Amount (DR)
tdCInvoiceWHTTotAmtCreditCC	decimal	CInvoice.CInvoiceWHTTotAmtCreditCC	SC WHT Total Amount (CR)
tdCInvoiceWHTTotAmtCreditLC	decimal	CInvoice.CInvoiceWHTTotAmtCreditLC	BC WHT Total Amount (CR)
tdCInvoiceWHTTotAmtCreditTC	decimal	CInvoice.CInvoiceWHTTotAmtCreditTC	TC WHT Total Amount (CR)
tdCInvoiceWHTTotAmtDebitCC	decimal	CInvoice.CInvoiceWHTTotAmtDebitCC	SC WHT Total Amount (DR)
tdCInvoiceWHTTotAmtDebitLC	decimal	CInvoice.CInvoiceWHTTotAmtDebitLC	BC WHT Total Amount (DR)
tdCInvoiceWHTTotAmtDebitTC	decimal	CInvoice.CInvoiceWHTTotAmtDebitTC	TC WHT Total Amount (DR)
tlCompanyPropertyIsCompens	logical	CompanyProperty.CompanyPropertyIsCompens	Customer/Supplier Compensation allowed
tlCompanyPropertyIsOICrossCy	logical	CompanyProperty.CompanyPropertyIsOICrossCy	Open Item Cross Entity Allowed
tlCompanyPropertyIsWHT	logical	CompanyProperty.CompanyPropertyIsWHT	Use Withholding Tax
tcCompanyPropertyOINetRestr	character	CompanyProperty.CompanyPropertyOINetRestr	Open Item Netting Restriction
tlCreditorIsWHT	logical	Creditor.CreditorIsWHT	Withholding Tax
tiReason_ID	integer	Reason.Reason_ID	Record ID
tcReasonCode	character	Reason.ReasonCode	Invoice Status Code
tlReasonIsLockPayment	logical	Reason.ReasonIsLockPayment	Lock Payment
tiCompany_ID	integer	CInvoice.Company_ID	Link to Company
tdCInvoiceExchangeRate	decimal	CInvoice.CInvoiceExchangeRate	Exchange Rate. The exchange rate used by the invoice. The BC Invoice Amount is calculated based on the exchange rate. If user modify the TC Invoice Amount, the BC invoice amount is automatically adjusted.
tdCInvoiceRateScale	decimal	CInvoice.CInvoiceRateScale	Scale Factor. This field indicates the scale factor applying to the exchange rate in use for foreign currency payments.
tdCInvoiceVatCreditTC	decimal	CInvoice.CInvoiceVatCreditTC	TC Tax Amount CR. This field displays the credit tax amount (TC) calculated by the system using the total invoice amount (TC) and the applicable tax rate code.
tdCInvoiceVatDebitTC	decimal	CInvoice.CInvoiceVatDebitTC	TC Tax Amount DR. This field displays the debit tax amount (TC) calculated by the system using the total invoice amount (TC) and the applicable tax rate code.
tlCInvoiceIsOpen	logical	CInvoice.CInvoiceIsOpen	Open.This field indicates if the invoice has been completely paid. This field is updated automatically when complete payment is confirmed. This field is read-only.
	api annotation:		PartialUpdate = yes - defaults to true
tlCInvoiceIsSelected	logical	CInvoice.CInvoiceIsSelected	Selected. This field indicates whether the invoice is included in a payment selection. This field is read-only.
tcCInvoiceTSMNumber	character	CInvoice.CInvoiceTSMNumber	Payment Reference. This field displays a unique reference number to be included in the supplier payment file. This reference can consist of a Transfer with Structured Message (TSM) number. This field can be blank.
tdCInvoiceVatBaseCreditTC	decimal	CInvoice.CInvoiceVatBaseCreditTC	TC Base Amount CR. This field displays the credit base amount in the transaction currency. This field is calculated by the system using the total invoice amount (TC) and the applicable tax rate code.
tdCInvoiceVatBaseDebitTC	decimal	CInvoice.CInvoiceVatBaseDebitTC	TC Base Amount DR. This field displays the debit base amount in the transaction currency. This field is calculated by the system using the total invoice amount (TC) and the applicable tax rate code.
tiPosting_ID	integer	PostingLine.Posting_ID	Link to Posting
tcCInvoiceMovementType	character	CInvoiceMovement.CInvoiceMovementType	CInvoiceMovementType. "Initial" indicates that the movement represents the initial creation of the invoice, "movement" stands for all subsequent modifications of the invoice balance (payments, adjustments etc).
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tiPeriodYear	integer	Period.PeriodYear	GL Calendar Year
tiPeriodPeriod	integer	Period.PeriodPeriod	GL Period
tcBusinessRelationCode	character	BusinessRelation.BusinessRelationCode	Business Relation. A code to identify the business relation. If this field does not have a input from the user, the system automatically generates a number for the record based on the sequence defined in Business Relation Autonumber Create.
tcCreditorCode	character	Creditor.CreditorCode	Supplier Code
tdCInvoiceBalanceCreditTC	decimal	CInvoice.CInvoiceBalanceCreditTC	TC Balance Amount CR. This field displays the sum of the credit amounts of all posting lines in transaction currency.
tdCInvoiceBalanceDebitTC	decimal	CInvoice.CInvoiceBalanceDebitTC	TC Balance Amount DR. This field displays the sum of the debit amounts of all posting lines in transaction currency.
tdCInvoiceBalanceCreditLC	decimal	CInvoice.CInvoiceBalanceCreditLC	BC Balance Amount CR. This field displays the sum of the credit amounts of all posting lines in transaction currency. This field is calculated by the system using the TC Base Amount CR and the Exchange rate.
tdCInvoiceBalanceDebitLC	decimal	CInvoice.CInvoiceBalanceDebitLC	BC Balance Amount DR. This field displays the sum of the debit amounts of all posting lines in transaction currency. This field is calculated by the system using the TC Base Amount DR and the Exchange rate.
ttCInvoiceDate	date	CInvoice.CInvoiceDate	Invoice Date. This field indicates the invoice creation date. The system uses this field with the credit terms to calculate due date and discount date.
	api annotation:		This field defaults from the system date.
ttCInvoiceDiscountDueDate	date	CInvoice.CInvoiceDiscountDueDate	Discount Due Date.This field indicates the last date a discount applies, calculated by the system based on the credit terms and the invoice date. User can modify this field without affecting the credit terms.
ttCInvoiceDueDate	date	CInvoice.CInvoiceDueDate	Due Date.This field indicates the date when payment become due. This field can be modified without affecting the credit terms. This field is calculated by the system based on the credit terms and the invoice date.
tiCInvoiceVoucher	integer	CInvoice.CInvoiceVoucher	Voucher. This field displays the numeric identifier assigned to the posting. When the daybook of the journal entry is changed (after transfer), the voucher is cleared. Voucher must be unique in one GL period. When the user input is zero, the system automatically assign a value not used yet for this field.
tcCInvoiceType	character	CInvoice.CInvoiceType	Invoice Type. This field identifies the invoice type. The value can be Invoice Correction and Credit Note Correction type only when the appropriate daybook types have already been defined.
tdCInvoiceHoldAmountTC	decimal	CInvoice.CInvoiceHoldAmountTC	TC Hold Amount. This field displays the amount of the invoice total that is not to be paid. If this field is not blank, the hold amount is taken into account during payment processing. Hold amounts must be: For invoices or correction invoices: Less than the invoice total and greater than zero. For credit notes or correction credit notes: Greater than the document total and less than zero. The hold amount for a negative payment must always be set to zero.
tcCorporateGroupCode	character	CorporateGroup.CorporateGroupCode	Group Name
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tcPaymentConditionPaymentTyp	character	PaymentCondition.PaymentConditionPaymentTyp	Payment Type
tdPaymentConditionPercentage	decimal	PaymentCondition.PaymentConditionPercentage	Discount Percentage
tcDivisionCode	character	Division.DivisionCode	Sub-Account
tcCompanyCode	character	Company.CompanyCode	Entity Code
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tiCInvoice_ID	integer	CInvoice.CInvoice_ID	Record ID
tcCInvoiceAllocationStatus	character	CInvoice.CInvoiceAllocationStatus	Allocation Status.This field indicates whether postings occur and if they affect transient or official layers. User can not delete an invoice which has a non-initial invoice status code.
tcCInvoiceReference	character	CInvoice.CInvoiceReference	Reference. An alphanumeric reference to help identify the invoice in the system. This reference is typically the ID number of the invoice received from the supplier.
tiCreditor_ID	integer	CInvoice.Creditor_ID	Link to Creditor
tiCInvoiceCurrency_ID	integer	CInvoice.CInvoiceCurrency_ID	Currency Code
tdCInvoiceOriginalCreditTC	decimal	CInvoice.CInvoiceOriginalCreditTC	TC Invoice Amount CR. This field displays the credit total invoice amount in the transaction currency. If you modify this field, the system automatically recalculates the exchange rate to ensure that the BC Invoice Amount remains the same.
tdCInvoiceOriginalDebitTC	decimal	CInvoice.CInvoiceOriginalDebitTC	TC AP Amount. This field displays the debit total invoice amount in the transaction currency. If you modify this field, the system automatically recalculates the exchange rate to ensure that the TC Invoice Amount remains the same.
tiControlGL_ID	integer	CInvoice.ControlGL_ID	Account
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CInvoice),rowid(CInvoiceMovement),rowid(PostingLine),rowid(Company),rowid(CompanyProperty),rowid(Creditor),rowid(BusinessRelation),rowid(CorporateGroup),rowid(Currency),rowid(Division),rowid(GL),rowid(Journal),rowid(PaymentCondition),rowid(Period),rowid(Reason)

Internal usage

QadFinancials

method BBankEntry.CalculateBankStateAlloc
method BBankEntry.GetPossibleAllocationsCInvoice
method BCDocument.CalculateAll