API query DInvoiceByProjectBudgetWBS (optimised)

Description

This query lists all invoices based on Project, Period and Is Open flag.

query filter (table tFilter)

tcBusinessFieldName	tcDataType	tcOperator
iiCompanyId	i
iiProjectID	i	=
icProjectCode	c	=
iiPeriodID	i	=
iiPeriodYear	i	=
iiPeriodPeriod	i	=
ilDInvoiceIsOpen	l	=
tBusinessRelation.BusinessRelationCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tBusinessRelation.BusinessRelationName1	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCompany.CompanyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tCurrency.CurrencyCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DebtorCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceBalanceLC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceBalanceTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceClosingDate	t	=,>=,>,<>,<=,<
tDInvoice.DInvoiceDate	t	=,>=,>,<>,<=,<
tDInvoice.DInvoiceDescription	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceDiscountDueDate	t	=,>=,>,<>,<=,<
tDInvoice.DInvoiceDueDate	t	=,>=,>,<>,<=,<
tDInvoice.DInvoiceIsOpen	l	=,<>
tDInvoice.DInvoiceOriginalCreditLC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceOriginalCreditTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceOriginalDebitLC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceOriginalDebitTC	d	=,>=,>,<>,<=,<
tDInvoice.DInvoiceType	c	=,>=,>,<>,<=,<,begins,can-do,matches
tDInvoice.DInvoiceVoucher	i	=,>=,>,<>,<=,<
tDivision.DivisionCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tJournal.JournalCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tPeriod.PeriodPeriod	i	=,>=,>,<>,<=,<
tPeriod.PeriodYear	i	=,>=,>,<>,<=,<
tProject.ProjectCode	c	=,>=,>,<>,<=,<,begins,can-do,matches
tReason.ReasonCode	c	=,>=,>,<>,<=,<,begins,can-do,matches

Parameters (internal)

iiCompanyId	integer	Company id
iiProjectID	integer	Project ID
icProjectCode	character	Project Code
iiPeriodID	integer	Period ID
iiPeriodYear	integer	Year of the accounting period
iiPeriodPeriod	integer	Period of the accouning period
ilDInvoiceIsOpen	logical	Is debtor invoice is still open ?

query condition

each DInvoice where

DInvoice.Company_Id = iiCompanyId AND
DInvoice.Project_ID = iiProjectID AND
DInvoice.Period_ID = iiPeriodID AND
DInvoice.DInvoiceIsOpen = ilDInvoiceIsOpen

first Company (inner-join) where

Company.Company_Id = iiCompanyId AND
Company.Company_ID = DInvoice.Company_ID AND

first Currency (inner-join) where

Currency.Currency_ID = DInvoice.DInvoiceCurrency_ID AND

first Debtor (inner-join) where

Debtor.SharedSet_Id = vi_DEBTOR_sharedset(iiCompanyId) AND
Debtor.Debtor_ID = DInvoice.Debtor_ID AND

first BusinessRelation (inner-join) where

BusinessRelation.BusinessRelation_ID = Debtor.BusinessRelation_ID AND

first Division (outer-join) where

Division.SharedSet_Id = vi_DIVISION_sharedset(iiCompanyId) AND
Division.Division_ID = DInvoice.Division_ID AND

first Journal (inner-join) where

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

first Period (inner-join) where

Period.Company_Id = iiCompanyId AND
Period.Period_ID = DInvoice.Period_ID AND
Period.PeriodYear = iiPeriodYear AND
Period.PeriodPeriod = iiPeriodPeriod

first Project (inner-join) where

Project.SharedSet_Id = vi_PROJECT_sharedset(iiCompanyId) AND
Project.Project_ID = DInvoice.Project_ID AND
Project.ProjectCode = icProjectCode

first Reason (inner-join) where

Reason.Reason_ID = DInvoice.Reason_ID AND

query resultset tqDInvoiceByProjectBudgetWBS

field name	data type	db field	description
tiBusinessRelation_ID	integer	BusinessRelation.BusinessRelation_ID	Record ID
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.
tcBusinessRelationName1	character	BusinessRelation.BusinessRelationName1	Name: The full name of the business relation. This field sets the default name for linked addresses such as customers and suppliers.
	api annotation:		PartialUpdate = yes - defaults to the BusinessRelationCode.
tiCompany_ID	integer	Company.Company_ID	Record ID
tcCompanyCode	character	Company.CompanyCode	Entity Code
tiCurrency_ID	integer	Currency.Currency_ID	Record ID
tcCurrencyCode	character	Currency.CurrencyCode	Currency Code
tiDebtor_ID	integer	DInvoice.Debtor_ID	Link to Debtor
tiDebtor_ID2	integer	Debtor.Debtor_ID	Record ID
tcDebtorCode	character	Debtor.DebtorCode	A code (maximum eight characters) that identifies a customer. If the code you specify matches an existing supplier code, a warning message displays. You can choose to ignore the warning, and create the record. However, when a supplier and customer share the same code, they must reference the same business relation.
	api annotation:		If you leave the Customer Code field blank, the system automatically generates a number for the record based on the sequence defined in Customer Autonumber Create.
tdDInvoiceBalanceLC	decimal	DInvoice.DInvoiceBalanceLC	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.
tdDInvoiceBalanceTC	decimal	DInvoice.DInvoiceBalanceTC	Balance. This field displays the sum of the debit and credit amounts of all posting lines in transaction currency.
ttDInvoiceClosingDate	date	DInvoice.DInvoiceClosingDate	Closing Date. This field displays the date on which the open balance became zero.
tiDInvoiceCurrency_ID	integer	DInvoice.DInvoiceCurrency_ID	Currency Code
ttDInvoiceDate	date	DInvoice.DInvoiceDate	Invoice Date. This field indicates the invoice creation date.This field is normallly prior to the posting date and within the same accounting period as the posting date. The date must be within the upper and lower date limits of an open GL period. The system uses the invoice date with the credit terms to calculate due date and discount date.
	api annotation:		This field defaults to the DInvoicePostingDate.
tcDInvoiceDescription	character	DInvoice.DInvoiceDescription	Description. A brief description of the invoice. This field is mandatory.
ttDInvoiceDiscountDueDate	date	DInvoice.DInvoiceDiscountDueDate	Discount Due Date. This field displays the last date a discount applies, calculated by the system based on the credit terms and the invoice date. You can modify the due date without affecting the credit terms. If the credit terms have a base date specified, this is used in the due date calculations rather than the invoice creation date.
ttDInvoiceDueDate	date	DInvoice.DInvoiceDueDate	Due Date. This field displays the date when payment is due, calculated by the system based on the credit terms and the invoice date. User can modify the due date without affecting the credit terms. If the credit terms have a base date specified, this is used in the due date calculations rather than the invoice creation date.
tlDInvoiceIsOpen	logical	DInvoice.DInvoiceIsOpen	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
tdDInvoiceOriginalCreditLC	decimal	DInvoice.DInvoiceOriginalCreditLC	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.
tdDInvoiceOriginalCreditTC	decimal	DInvoice.DInvoiceOriginalCreditTC	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.
tdDInvoiceOriginalDebitLC	decimal	DInvoice.DInvoiceOriginalDebitLC	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.
tdDInvoiceOriginalDebitTC	decimal	DInvoice.DInvoiceOriginalDebitTC	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.
tdDinvoiceOriginalLC	decimal	calculated
tdDinvoiceOriginalTC	decimal	calculated
tcDInvoiceType	character	DInvoice.DInvoiceType	Invoice Type. This field displays the invoice type. Invoice Correction and Credit Note Correction display as choices only when the appropriate daybook types have already been defined.
	api annotation:		PartialUpdate = yes - defaults to Invoice
tiDInvoiceVoucher	integer	DInvoice.DInvoiceVoucher	Voucher.This field displays the numeric identifier assigned to the posting. When the daybook of the journal entry is charged(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.
tiDivision_ID	integer	DInvoice.Division_ID	Sub-Account
tiDivision_ID2	integer	Division.Division_ID	Record ID
tcDivisionCode	character	Division.DivisionCode	Sub-Account
tiJournal_ID	integer	DInvoice.Journal_ID	Daybook Code
tiJournal_ID2	integer	Journal.Journal_ID	Record ID
tcJournalCode	character	Journal.JournalCode	A daybook code (maximum eight characters).
tiPeriod_ID	integer	DInvoice.Period_ID	Link to Period
tiPeriodPeriod	integer	Period.PeriodPeriod	GL Period
tiPeriodYear	integer	Period.PeriodYear	GL Calendar Year
tiProject_ID	integer	DInvoice.Project_ID	Project
tiProject_ID2	integer	Project.Project_ID	Record ID
tcProjectCode	character	Project.ProjectCode	Project
tiReason_ID	integer	DInvoice.Reason_ID	Invoice Status Code
tiReason_ID2	integer	Reason.Reason_ID	Record ID
tcReasonCode	character	Reason.ReasonCode	Invoice Status Code
DInvoiceCustom	character	calculated	custom fields
CompanyCustom	character	calculated	custom fields
CurrencyCustom	character	calculated	custom fields
DebtorCustom	character	calculated	custom fields
BusinessRelationCustom	character	calculated	custom fields
DivisionCustom	character	calculated	custom fields
JournalCustom	character	calculated	custom fields
PeriodCustom	character	calculated	custom fields
ProjectCustom	character	calculated	custom fields
ReasonCustom	character	calculated	custom fields
ti_sequence	integer	calculated	primary index
tc_rowid	character	calculated	= rowid(DInvoice),rowid(Company),rowid(Currency),rowid(Debtor),rowid(BusinessRelation),rowid(Division),rowid(Journal),rowid(Period),rowid(Project),rowid(Reason)

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 = "BDInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "DInvoiceByProjectBudgetWBS".
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/bdinvoice.dinvoicebyprojectbudgetwbs.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.