API query SelectExpNoteCInvoice (optimised)

Description

Returns Creditor invoices linked to a Expense note

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
tCInvoice.CInvoicePostingYear	i	=,>=,>,<>,<=,<
tCInvoice.CInvoiceVoucher	i	=,>=,>,<>,<=,<
tExpNoteCInvoice.ExpNoteCInvoiceStatusCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tExpNoteCInvoice.ExpNoteCInvoiceTypeCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tExpNote.ExpNoteNumber	i	=,>=,>,<>,<=,<
tExpNote.ExpNoteYear	i	=,>=,>,<>,<=,<
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId

integer

Company id

query condition

each ExpNoteCInvoice where

first CInvoice (inner-join) where

CInvoice.Company_Id = iiCompanyId AND
CInvoice.CInvoice_ID = ExpNoteCInvoice.CInvoice_ID AND

first Journal (inner-join) where

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

first ExpNote (inner-join) where

ExpNote.Company_Id = iiCompanyId AND
ExpNote.ExpNote_ID = ExpNoteCInvoice.ExpNote_ID AND

query sort order

ExpNote.ExpNoteYear (ascending)
ExpNote.ExpNoteNumber (ascending)

query resultset tqSelectExpNoteCInvoice

field name	data type	db field	description
tiCInvoice_ID	integer	ExpNoteCInvoice.CInvoice_ID	Link to CInvoice
tiCInvoicePostingYear	integer	CInvoice.CInvoicePostingYear	Year.This field indicates the accounting year 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 associated with the posting 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.
tiExpNote_ID	integer	ExpNoteCInvoice.ExpNote_ID	Link to ExpNote
tcExpNoteCInvoiceStatusCode	character	ExpNoteCInvoice.ExpNoteCInvoiceStatusCode	Status Code
tcExpNoteCInvoiceTypeCode	character	ExpNoteCInvoice.ExpNoteCInvoiceTypeCode	Type Code
tiExpNoteNumber	integer	ExpNote.ExpNoteNumber	Number
tiExpNoteYear	integer	ExpNote.ExpNoteYear	Year
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
ExpNoteCInvoiceCustom	character	calculated	custom fields
CInvoiceCustom	character	calculated	custom fields
JournalCustom	character	calculated	custom fields
ExpNoteCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(ExpNoteCInvoice),rowid(CInvoice),rowid(Journal),rowid(ExpNote)

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 = "BExpenseNote".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "SelectExpNoteCInvoice".
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/bexpensenote.selectexpnotecinvoice.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.