API query VatPeriodByCompany (optimised)

Description

This query returns all Vat Period records for one company if parameter is filled, otherwise it shows all vat period records

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tGL.GLCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodPeriod	i	=,>=,>,<>,<=,<
tPeriod.PeriodYear	i	=,>=,>,<>,<=,<
tPosting.PostingDate	t	=,>=,>,<>,<=,<
tPosting.PostingInvoiceReferenceTxt	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPostingLine.PostingLineCreditCC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineCreditLC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineCreditPC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineCreditTC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineDebitCC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineDebitLC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineDebitPC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineDebitTC	d	=,>=,>,<>,<=,<
tPostingLine.PostingLineQTY	d	=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxPointDate	t	=,>=,>,<>,<=,<
tPosting.PostingVoucher	i	=,>=,>,<>,<=,<
tVatPeriod.VatPeriodPeriod	i	=,>=,>,<>,<=,<
tVatPeriod.VatPeriodYear	i	=,>=,>,<>,<=,<

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each VatPeriod where

VatPeriod.Company_Id = iiCompanyId AND

each PostingVat (inner-join) where

PostingVat.VatPeriod_ID = VatPeriod.VatPeriod_ID AND

first PostingLine (inner-join) where

PostingLine.Company_Id = iiCompanyId AND
PostingLine.PostingLine_ID = PostingVat.PostingLine_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 Journal (inner-join) where

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

first Period (inner-join) where

Period.Company_Id = iiCompanyId AND
Period.Period_ID = Posting.Period_ID AND

query sort order

VatPeriod.VatPeriodYear (ascending)
VatPeriod.VatPeriodPeriod (ascending)

query resultset tqVatPeriodByCompany

field name	data type	db field	description
tcGLCode	character	GL.GLCode	A code identifying the GL account.
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tiPeriodPeriod	integer	Period.PeriodPeriod	GL Period
tiPeriodYear	integer	Period.PeriodYear	GL Calendar Year
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).
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
tdPostingLineBalanceCCCalc	decimal	calculated	PostingLineBalanceCCCalc
tdPostingLineBalanceLCCalc	decimal	calculated	PostingLineBalanceLCCalc
tdPostingLineBalanceTCCalc	decimal	calculated	PostingLineBalanceTCCalc
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
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.
tdPostingLineCreditPC	decimal	PostingLine.PostingLineCreditPC	PC Credit
	api annotation:		This field is obsolete and can be left blank.
tdPostingLineCreditTC	decimal	PostingLine.PostingLineCreditTC	TC Credit
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.
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.
tdPostingLineDebitPC	decimal	PostingLine.PostingLineDebitPC	PC Debit
	api annotation:		This field is obsolete.
tdPostingLineDebitTC	decimal	PostingLine.PostingLineDebitTC	TC Debit
tdPostingLineQTY	decimal	PostingLine.PostingLineQTY	Quantity
	api annotation:		Value for this field defaults to 0.0000.
ttPostingVatTaxPointDate	date	PostingVat.PostingVatTaxPointDate	The date when this posting is taken into account in the Tax sub-adminstration.
	api annotation:		?
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.
tiVatPeriodPeriod	integer	VatPeriod.VatPeriodPeriod	Tax Period
tiVatPeriodYear	integer	VatPeriod.VatPeriodYear	Tax Year
VatPeriodCustom	character	calculated	custom fields
PostingVatCustom	character	calculated	custom fields
PostingLineCustom	character	calculated	custom fields
GLCustom	character	calculated	custom fields
PostingCustom	character	calculated	custom fields
JournalCustom	character	calculated	custom fields
PeriodCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(VatPeriod),rowid(PostingVat),rowid(PostingLine),rowid(GL),rowid(Posting),rowid(Journal),rowid(Period)

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 = "BVATPeriod".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "VatPeriodByCompany".
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/bvatperiod.vatperiodbycompany.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.