project QadFinancials > class BPeriod > API query SelectPeriodForAccVat (optimised)

Description

Select Query for Accounting Periods and Vat Periods


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
tGL.GLCodec=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCodec=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodPeriodi=,>=,>,<>,<=,<
tPeriod.PeriodYeari=,>=,>,<>,<=,<
tPosting.PostingDatet=,>=,>,<>,<=,<
tPosting.PostingInvoiceReferenceTxtc=,>=,>,<>,<=,<,begins,can-do,matches
tPostingLine.PostingLineQTYd=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxCreditCCd=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxCreditLCd=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxCreditTCd=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxDebitCCd=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxDebitLCd=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxDebitTCd=,>=,>,<>,<=,<
tPostingVat.PostingVatTaxPointDatet=,>=,>,<>,<=,<
tPosting.PostingVoucheri=,>=,>,<>,<=,<
tVatPeriod.VatPeriodPeriodi=,>=,>,<>,<=,<
tVatPeriod.VatPeriodYeari=,>=,>,<>,<=,<


Parameters (internal)


iiCompanyIdintegerCompany id


query condition


  each Period where
Period.Company_Id = iiCompanyId AND

      each Posting (inner-join) where
Posting.Company_Id = iiCompanyId AND
Posting.Period_ID = Period.Period_ID AND

          first Journal (inner-join) where
Journal.SharedSet_Id = vi_JOURNAL_sharedset(iiCompanyId) AND
Journal.Journal_ID = Posting.Journal_ID AND

          each PostingLine (inner-join) where
PostingLine.Company_Id = iiCompanyId AND
PostingLine.Posting_ID = Posting.Posting_ID AND

              first GL (inner-join) where
GL.SharedSet_Id = vi_GL_sharedset(iiCompanyId) AND
GL.GL_ID = PostingLine.GL_ID AND

              each PostingVat (inner-join) where
PostingVat.PostingLine_ID = PostingLine.PostingLine_ID AND

                  first VatPeriod (inner-join) where
VatPeriod.Company_Id = iiCompanyId AND
VatPeriod.VatPeriod_ID = PostingVat.VatPeriod_ID AND


query sort order


Period.PeriodYear (ascending)
Period.PeriodPeriod (ascending)
Journal.JournalCode (ascending)
Posting.PostingVoucher (ascending)


query resultset tqSelectPeriodForAccVat


field namedata typedb fielddescription
tcGLCodecharacterGL.GLCodeA code identifying the GL account.
tcJournalCodecharacterJournal.JournalCodeA daybook code (maximum eight characters).
tiPeriodPeriodintegerPeriod.PeriodPeriodGL Period
tiPeriodYearintegerPeriod.PeriodYearGL Calendar Year
ttPostingDatedatePosting.PostingDateThe 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).
tcPostingInvoiceReferenceTxtcharacterPosting.PostingInvoiceReferenceTxtWhen 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
tdPostingLineQTYdecimalPostingLine.PostingLineQTYQuantity
api annotation:Value for this field defaults to 0.0000.
tdPostingVatBalanceCCCalcdecimalcalculatedPostingVatBalanceCCCalc
tdPostingVatBalanceLCCalcdecimalcalculatedPostingVatBalanceLCCalc
tdPostingVatBalanceTCCalcdecimalcalculatedPostingVatBalanceTCCalc
tdPostingVatTaxCreditCCdecimalPostingVat.PostingVatTaxCreditCCSC (Statutory Currency) Tax Credit amount.
api annotation:?
tdPostingVatTaxCreditLCdecimalPostingVat.PostingVatTaxCreditLCBC (Base/Local) Tax Credit amount.
api annotation:?
tdPostingVatTaxCreditTCdecimalPostingVat.PostingVatTaxCreditTCTC (Transaction Currency) Tax Credit amount.
api annotation:?
tdPostingVatTaxDebitCCdecimalPostingVat.PostingVatTaxDebitCCSC (Statutory Currency) Tax Debit amount.
api annotation:?
tdPostingVatTaxDebitLCdecimalPostingVat.PostingVatTaxDebitLCBC (Base Currency) Tax Debit amount.
api annotation:?
tdPostingVatTaxDebitTCdecimalPostingVat.PostingVatTaxDebitTCTC (Transaction Currency) Tax Debit amount.
api annotation:?
ttPostingVatTaxPointDatedatePostingVat.PostingVatTaxPointDateThe date when this posting is taken into account in the Tax sub-adminstration.
api annotation:?
tiPostingVoucherintegerPosting.PostingVoucherVoucher 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.
tiVatPeriodPeriodintegerVatPeriod.VatPeriodPeriodTax Period
tiVatPeriodYearintegerVatPeriod.VatPeriodYearTax Year
PeriodCustomcharactercalculatedcustom fields
PostingCustomcharactercalculatedcustom fields
JournalCustomcharactercalculatedcustom fields
PostingLineCustomcharactercalculatedcustom fields
GLCustomcharactercalculatedcustom fields
PostingVatCustomcharactercalculatedcustom fields
VatPeriodCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Period),rowid(Posting),rowid(Journal),rowid(PostingLine),rowid(GL),rowid(PostingVat),rowid(VatPeriod)


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 = "BPeriod".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectPeriodForAccVat".
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/bperiod.selectperiodforaccvat.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.