API query CInvoiceByPostingID

Description

This query lists all CInvoice records based on posting id.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiPostingID	i	=
iiCompanyId	i
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceReference	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCInvoice.CInvoiceVoucher	i	=,>=,>,<>,<=,<
tCreditor.CreditorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodYearPeriod	i	=,>=,>,<>,<=,<
tVatNumber.VatNumberIdentity	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiPostingID	integer	Posting ID
iiCompanyId	integer	Company id

query condition

each CInvoicePosting where

CInvoicePosting.Posting_ID = iiPostingID

first CInvoice (inner-join) where

CInvoice.Company_Id = iiCompanyId AND
CInvoice.CInvoice_ID = CInvoicePosting.CInvoice_ID AND

first Creditor (inner-join) where

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

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Creditor.BusinessRelation_ID AND

each VatNumber (outer-join) where

VatNumber.BusinessRelation_ID = BusinessRelation.BusinessRelation_ID AND

first Currency (inner-join) where

Currency.Currency_ID = Creditor.Currency_ID AND

first Journal (inner-join) where

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

first Period (inner-join) where

Period.Company_Id = iiCompanyId AND
Period.Period_ID = CInvoice.Period_ID AND

query resultset tqCInvoiceByPostingID

field name	data type	db field	description
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.
tiCInvoice_ID	integer	CInvoice.CInvoice_ID	Record ID
tiCInvoicePosting_ID	integer	CInvoicePosting.CInvoicePosting_ID	Record ID
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.
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.
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.
tcCreditorCode	character	Creditor.CreditorCode	Supplier Code
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tiPeriodYearPeriod	integer	Period.PeriodYearPeriod	GL Calendar Year/GL Period
tiPosting_ID	integer	CInvoicePosting.Posting_ID	Link to Posting
tcVatNumberIdentity	character	VatNumber.VatNumberIdentity	Obsolete field
CInvoicePostingCustom	character	calculated	custom fields
CInvoiceCustom	character	calculated	custom fields
CreditorCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
VatNumberCustom	character	calculated	custom fields
CurrencyCustom	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(CInvoicePosting),rowid(CInvoice),rowid(Creditor),rowid(BusinessRelation),rowid(VatNumber),rowid(Currency),rowid(Journal),rowid(Period)

Internal usage

QadFinancials

method BJournalEntry.DumpJEForConsolid

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 = "CInvoiceByPostingID".
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.cinvoicebypostingid.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.