API query SelectCInvoiceMovementInv (optimised)

Description

Use this query in case you want to lookup a creditor invoice movement; This query should only be used by UI-components!!!!
In this query you can filter on period and journal of the invoice himself, not on posting

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tCInvoice.CInvoiceBalanceCC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceBalanceLC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceBalanceTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceDate	t	=,>=,>,<>,<=,<
tCInvoice.CInvoiceDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceDueDate	t	=,>=,>,<>,<=,<
tCInvoice.CInvoiceHoldAmountTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceIsOpen	l	=,<>
tCInvoiceMovement.CInvoiceMovementDiscountTC	d	=,>=,>,<>,<=,<
tCInvoiceMovement.CInvoiceMovementType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoiceMovement.CInvoiceMovementYearPeriod	i	=,>=,>,<>,<=,<
tCInvoice.CInvoiceOriginalCreditCC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceOriginalCreditLC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceOriginalCreditTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceOriginalDebitCC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceOriginalDebitLC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoiceOriginalDebitTC	d	=,>=,>,<>,<=,<
tCInvoice.CInvoicePostingYearPeriod	i	=,>=,>,<>,<=,<
tCInvoice.CInvoiceType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceVoucher	i	=,>=,>,<>,<=,<
tCreditor.CreditorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency1.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency2.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tGL.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal1.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal2.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.LastModifiedDate	t	=,>=,>,<>,<=,<
tCInvoice.LastModifiedTime	i	=,>=,>,<>,<=,<
tCInvoice.LastModifiedUser	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod1.PeriodPeriod	i	=,>=,>,<>,<=,<
tPeriod2.PeriodPeriod	i	=,>=,>,<>,<=,<
tPeriod2.PeriodYear	i	=,>=,>,<>,<=,<
tPeriod1.PeriodYear	i	=,>=,>,<>,<=,<
tPeriod2.PeriodYearPeriod	i	=,>=,>,<>,<=,<
tPeriod1.PeriodYearPeriod	i	=,>=,>,<>,<=,<
tPosting.PostingDate	t	=,>=,>,<>,<=,<
tPosting.PostingInvoiceReferenceTxt	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPostingLine.PostingLineCreditCC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineCreditLC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineCreditTC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineDebitCC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineDebitLC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineDebitTC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineExchangeRate	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineText	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPosting.PostingPeriod	i	=,>=,>,<>,<=,<
tPosting.PostingSystemDate	t	=,>=,>,<>,<=,<
tPosting.PostingVoucher	i	=,>=,>,<>,<=,<
tPosting.PostingYear	i	=,>=,>,<>,<=,<

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each CInvoice where

CInvoice.Company_Id = iiCompanyId AND

each CInvoiceMovement (inner-join) where

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

first PostingLine (inner-join) where

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

first Currency1 (inner-join) where

Currency1.Currency_ID = PostingLine.Currency_ID AND

first GL (inner-join) where

GL.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL.GL_ID = PostingLine.GL_ID AND

first Posting (inner-join) where

Posting.Company_Id = iiCompanyId AND
Posting.Posting_ID = PostingLine.Posting_ID AND

first Journal1 (inner-join) where

Journal1.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal1.Journal_ID = Posting.Journal_ID AND

first Period1 (inner-join) where

Period1.Company_Id = iiCompanyId AND
Period1.Period_ID = Posting.Period_ID AND

first Creditor (inner-join) where

Creditor.SharedSet_Id = vi_CREDITOR_sharedset(iiCompanyId) AND
Creditor.Creditor_ID = CInvoice.Creditor_ID AND

first Currency2 (inner-join) where

Currency2.Currency_ID = CInvoice.CInvoiceCurrency_ID AND

first Journal2 (inner-join) where

Journal2.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal2.Journal_ID = CInvoice.Journal_ID AND

first Period2 (inner-join) where

Period2.Company_Id = iiCompanyId AND
Period2.Period_ID = CInvoice.Period_ID AND

query resultset tqSelectCInvoiceMovementInv

field name	data type	db field	description
tdAmountCCCalc	decimal	calculated	Net amount in SC
tdAmountLCCalc	decimal	calculated	Net amount in BC
tdAmountTCCalc	decimal	calculated	Net Amount in TC
tiCInvoice_ID	integer	CInvoice.CInvoice_ID	Record ID
tdCInvoiceBalanceCC	decimal	CInvoice.CInvoiceBalanceCC	SC Balance. This field displays the sum of the debit and credit amounts of all posting lines in statutory currency. This field is calculated by the system using the TC Balance and the SC rate.
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.
tcCInvoiceKeyCalc	character	calculated	Concatenated field of the key fields of the invoice
tdCInvoiceMovementDiscountTC	decimal	CInvoiceMovement.CInvoiceMovementDiscountTC	CInvoiceMovementDiscountTC. The amount of payment discount in TC.
tiCInvoiceMovementYearPeriod	integer	CInvoiceMovement.CInvoiceMovementYearPeriod	Year/GL Period. This field indicates the accounting year and period for the invoice's movement.
tdCInvoiceOriginalCreditCC	decimal	CInvoice.CInvoiceOriginalCreditCC	SC Invoice Amount (CR). This field displays the credit total invoice amount in the statutory currency. This field is calculated by the system using the TC Invoice Amount(CR) and the SC Rate.
tdCInvoiceOriginalDebitCC	decimal	CInvoice.CInvoiceOriginalDebitCC	SC Invoice Amount (DR). This field displays the debit total invoice amount in the statutory currency. This field is calculated by the system using the TC Invoice Amount(CR) and the SC Rate.
tiCInvoicePostingYearPeriod	integer	CInvoice.CInvoicePostingYearPeriod	Year/Period. This field indicates the accounting year and period for the invoice. If you modify these fields, the posting and tax dates are changed correspondingly.
	api annotation:		This field defaults to the accounting year and period associated with the posting date.
ttLastModifiedDate	date	CInvoice.LastModifiedDate	Last Modified Date
tiLastModifiedTime	integer	CInvoice.LastModifiedTime	Last Modified Time
tcLastModifiedUser	character	CInvoice.LastModifiedUser	Last Modified User
tdPostingLineCreditCC	decimal	PostingLine.PostingLineCreditCC	SC Credit
	api annotation:		Partial Update = yes - it will get a default value depending on the value of PostingLinCreditTC, PostingLineCCRate & PostingLineCCScale. SC Amount = TC Amount * Exchange rate (TC/SC) * Scale Factor (TC/SC). If Partial Update is false, you should enter the correct value for this field
tdPostingLineDebitCC	decimal	PostingLine.PostingLineDebitCC	SC Debit
	api annotation:		Partial Update = yes - it will get a default value depending on the value of PostingLineDebitTC, PostingLineCCRate & PostingLineCCScale. SC Amount = TC Amount * Exchange rate (TC/SC) * Scale Factor (TC/SC). If Partial Update is false, enter the correct value for this field.
tdPostingLineExchangeRate	decimal	PostingLine.PostingLineExchangeRate	Exchange Rate
	api annotation:		Default value for this field depends on the exchang erate shared set specified for the current domain.
tcPostingLineText	character	PostingLine.PostingLineText	Description
	api annotation:		Value for this field defaults to blank. Note: if a new record is created through the user interface, the default value is as same as the value of "PostingText" of tPosting.
tiPostingPeriod	integer	Posting.PostingPeriod	The GL period for the posting. The period must be open.
ttPostingSystemDate	date	Posting.PostingSystemDate	The system date of the posting corresponding to "PostingDate".
	api annotation:		In Create mode, when Partial Update = yes - this field gets a default value which is the current date of the system.
tiPostingYear	integer	Posting.PostingYear	The GL calendar year for the posting.
tiPeriodPeriod	integer	Period1.PeriodPeriod	GL Period
tiPeriodYear	integer	Period1.PeriodYear	GL Calendar Year
tiPeriodYearPeriod	integer	Period1.PeriodYearPeriod	GL Calendar Year/GL Period
tdCInvoiceBalanceLC	decimal	CInvoice.CInvoiceBalanceLC	BC Balance. This field displays the sum of the debit and credit amounts of all posting lines in base currency. This field is calculated by the system using the TC Balance and the Exchange rate.
tiPeriodYearPeriod2	integer	Period2.PeriodYearPeriod	GL Calendar Year/GL Period
tdCInvoiceOriginalCreditLC	decimal	CInvoice.CInvoiceOriginalCreditLC	BC Invoice Amount(CR). This field displays the credit total invoice amount in the base currency. This field is calculated by the system using the TC Invoice Amount(CR) and the Exchange rate.
tdCInvoiceOriginalDebitLC	decimal	CInvoice.CInvoiceOriginalDebitLC	BC Invoice Amount(DR). This field displays the debit total invoice amount in the base currency. This field is calculated by the system using the TC Invoice Amount(DR) and the Exchange rate.
tdPostingLineCreditLC	decimal	PostingLine.PostingLineCreditLC	BC Credit
	api annotation:		Partial Update = yes - it will get a default value depends on the value of PostingLineCreditTC, PostingLineExchangeRate & PostingLineRateScale. BC Amount = TC Amount * Exchange rate (TC/BC) * Scale Factor (TC/BC). If Partial Update is false, enter a value for this field.
tcPostingInvoiceReferenceTxt	character	Posting.PostingInvoiceReferenceTxt	When the posting is part of an invoice posting, then this field contains the invoice number (Year/Daybook/Voucher extended with supplier invoice Reference in case of a supplier invoice). Used for information purpose on reports and browsers.
	api annotation:		Value for this field defaults to blank
tdPostingLineDebitLC	decimal	PostingLine.PostingLineDebitLC	BC Debit
	api annotation:		Partial Update = yes - it will get a default value depending on the value of PostingLineDebitTC, PostingLineExchangeRate and PostingLineRateScale. BC Amount = TC Amount * Exchange rate (TC/BC) * Scale Factor (TC/BC). If Partial Update = false, enter the correct value into this field.
tcCInvoiceMovTypeInvCalc	character	calculated	CInvoiceTypeCalc; Creditor Invoice Type nl Invoice or Credit Note
tiPeriodYear2	integer	Period2.PeriodYear	GL Calendar Year
tiPeriodPeriod2	integer	Period2.PeriodPeriod	GL Period
tcCInvoiceMovTypeMovCalc	character	calculated	CInvoiceMovTypeMovCalc; calculated field with the movement-type
tcMovementJournal	character	Journal1.JournalCode	A daybook code (maximum eight characters).
tcCreditorCode	character	Creditor.CreditorCode	Supplier Code
tcJournalCode	character	Journal2.JournalCode	A daybook code (maximum eight characters).
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.
tcCInvoiceCurrencyCode	character	Currency2.CurrencyCode	Currency Code
tiPostingVoucher	integer	Posting.PostingVoucher	Voucher is a sequential number that uniquely identifies the journal entry (within the combination of an entity and a daybook code).
	api annotation:		In create mode,enter 0 in this field - the voucher number is generated by the system. In Modify/Delete, the correct voucher number must be entered because this identifies the record.
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tdPostingLineDebitTC	decimal	PostingLine.PostingLineDebitTC	TC Debit
tdPostingLineCreditTC	decimal	PostingLine.PostingLineCreditTC	TC Credit
tcPostingLineCurrencyCode	character	Currency1.CurrencyCode	Currency Code
ttPostingDate	date	Posting.PostingDate	The accounting date on which the journal entry is posted. The posting date must be a valid calendar date and must be within the GL calendar year (PostingYear) and period (PostingPeriod).
tdCInvoiceBalanceTC	decimal	CInvoice.CInvoiceBalanceTC	Balance. This field displays the sum of the debit and credit amounts of all posting lines in transaction currency.
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
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.
tcCInvoiceDescription	character	CInvoice.CInvoiceDescription	Description. A brief description of the invoice. The system generates a default description based on the Reference and Supplier Code.
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.
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.
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.
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.
tiPeriod_ID	integer	Posting.Period_ID	Link to Period
tiJournal_ID	integer	Posting.Journal_ID	Daybook Code
tiCompany_ID	integer	CInvoice.Company_ID	Link to Company
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).
CInvoiceCustom	character	calculated	custom fields
CInvoiceMovementCustom	character	calculated	custom fields
PostingLineCustom	character	calculated	custom fields
Currency1Custom	character	calculated	custom fields
GLCustom	character	calculated	custom fields
PostingCustom	character	calculated	custom fields
Journal1Custom	character	calculated	custom fields
Period1Custom	character	calculated	custom fields
CreditorCustom	character	calculated	custom fields
Currency2Custom	character	calculated	custom fields
Journal2Custom	character	calculated	custom fields
Period2Custom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(CInvoice),rowid(CInvoiceMovement),rowid(PostingLine),rowid(Currency1),rowid(GL),rowid(Posting),rowid(Journal1),rowid(Period1),rowid(Creditor),rowid(Currency2),rowid(Journal2),rowid(Period2)

Internal usage

unused

Sample code: how to call this query through RPCRequestService (QXtend Inbound)

define temp-table ttContext no-undo
    field propertyQualifier as character
    field propertyName as character
    field propertyValue as character
    index entityContext is primary unique
        propertyQualifier
        propertyName
    index propertyQualifier
        propertyQualifier.

define dataset dsContext for ttContext.

define variable vhContextDS as handle no-undo.
define variable vhExceptionDS as handle no-undo.
define variable vhServer as handle no-undo.
define variable vhInputDS as handle no-undo.
define variable vhInputOutputDS as handle no-undo.
define variable vhOutputDS as handle no-undo.
define variable vhParameter as handle no-undo.

/* Create context */
create ttContext.
assign ttContext.propertyName = "programName"
       ttContext.propertyValue = "BCInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectCInvoiceMovementInv".
create ttContext.
assign ttContext.propertyName = "applicationId"
       ttContext.propertyValue = "fin".
create ttContext.
assign ttContext.propertyName = "entity"
       ttContext.propertyValue = "1000".
create ttContext.
assign ttContext.propertyName = "userName"
       ttContext.propertyValue = "mfg".
create ttContext.
assign ttContext.propertyName = "password"
       ttContext.propertyValue = "".

/* Create input dataset */
create dataset vhInputDS.
vhInputDS:read-xmlschema("file", "xml/bcinvoice.selectcinvoicemovementinv.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
vhParameter:buffer-create().

assign vhParameter::<field-name-1> = <field-value-1>
       vhParameter::<field-name-2> = <field-value-2>
       ...

/* Connect the AppServer */
create server vhServer.
vhServer:connect("-URL <appserver-url>").

if not vhServer:connected()
then do:
    message "Could not connect AppServer" view-as alert-box error title "Error".
    return.
end.

/* Run */
assign vhContextDS = dataset dsContext:handle.

run program/rpcrequestservice.p on vhServer
    (input-output dataset-handle vhContextDS by-reference,
           output dataset-handle vhExceptionDS,
     input        dataset-handle vhInputDS by-reference,
     input-output dataset-handle vhInputOutputDS by-reference,
           output dataset-handle vhOutputDS).

/* Handle output however you want, in this example, we dump it to xml */
if valid-handle(vhExceptionDS)
then vhExceptionDS:write-xml("file", "Exceptions.xml", true).

if valid-handle(vhOutputDS)
then vhOutputDS:write-xml("file", "Output.xml", true).

/* Cleanup */
vhServer:disconnect().
assign vhServer = ?.

if valid-handle(vhInputDS)
then delete object vhInputDS.

if valid-handle(vhOutputDS)
then delete object vhOutputDS.

if valid-handle(vhExceptionDS)
then delete object vhExceptionDS.