project QadFinancials > class BAPMatching > method ApiGetAPMatchingLnByPvo

Description

This method retrives all AP Matching records for certain Pending voucher


Parameters


iiPvoIdinputintegerPending voucher Id
iiPvoLineIdinputintegerPending voucher Lind Id
tAPMatchingLnByPvooutputtemp-table
oiReturnStatusoutputintegerReturn status of the method.


Internal usage


unused


program code (program9/bapmatching.p)

/* ============================================================================================ */
    /* Method:   ApiGetAPMatchingLnByPvo                                                            */
    /* Desc:     This method returns all matching lines to certain pending voucher                  */
    /* Caller:   different .p-files in the operationals                                             */
    /* Input:    PvoId               Pending voucher Id                                             */
    /* Output    APMatchingLnByPvo   Temporary table with all matching lines of pending voucher     */
    /* ============================================================================================ */
    
    assign oiReturnStatus = -98.
    empty temp-table tAPMatchingLnByPvo.
    
    /* Normalize input parameters */
    if iiPvoId = 0 then assign iiPvoId = ?.
    
    /* Validate input paramters */
    if iiPvoId = ?
    then do:
        assign vcMessage = #T-1'You have not entered all the mandatory values.':255(63250)t-1#
               vcContext = substitute("iiPvoId=&1", iiPvoId).
        <M-2 run SetMessage
           (input  vcMessage (icMessage), 
            input  '':U (icArguments), 
            input  '':U (icFieldName), 
            input  '':U (icFieldValue), 
            input  'E':U (icType), 
            input  3 (iiSeverity), 
            input  '':U (icRowid), 
            input  'QadFin-6428':U (icFcMsgNumber), 
            input  '':U (icFcExplanation), 
            input  '':U (icFcIdentification), 
            input  vcContext (icFcContext), 
            output viFcReturnSuper (oiReturnStatus)) in BAPMatching>
        assign oiReturnStatus = -1.
        return.
    end. /* if iiPvoId = ? */
    
    /* Retrieve records from database - this query can return multiple records for a single APMatching as it also joins to APMatchingLnTax */
    <Q-3 run APMatchingLnByPvo (all) (Read) (NoCache)
       (input viCompanyId, (CompanyId)
        input iiPvoId, (PvoId)
        input iiPvoLineId, (PvoLineId)
        input vcDomainCode, (DomainCode)
        output dataset tqAPMatchingLnByPvo) in BAPMatching >
    
    /* Copy retrieved data to resulting temp-table - only create a single output record for every APMatchingLn */
    for each tqAPMatchingLnByPvo
        break by tqAPMatchingLnByPvo.tiAPMatchingLn_ID :
        
        /* create an output record once for every APMatchingLn */
        if first-of (tqAPMatchingLnByPvo.tiAPMatchingLn_ID)
        then do :
            create tAPMatchingLnByPvo.
            buffer-copy tqAPMatchingLnByPvo 
                        to tAPMatchingLnByPvo
                        assign tAPMatchingLnByPvo.tdAPMatchingLnReceiptTaxLC   = 0
                               tAPMatchingLnByPvo.tdAPMatchingLnReceiptTaxTC   = 0
                               tAPMatchingLnByPvo.tdAPMatchingLnTaxARRecTaxTC  = 0
                               tAPMatchingLnByPvo.tdAPMatchingLnTaxARNRecTaxTC = 0
                               tAPMatchingLnByPvo.tdAPMatchingLnTaxAIRecTaxTC  = 0
                               tAPMatchingLnByPvo.tdAPMatchingLnTaxAINRecTaxTC = 0.
        end. /* if first-of (tqAPMatchingLnByPvo.tiAPMatchingLn_ID) */
        
        /* Sum the ReceiptTaxTC */
        assign tAPMatchingLnByPvo.tdAPMatchingLnReceiptTaxTC   = tAPMatchingLnByPvo.tdAPMatchingLnReceiptTaxTC + 
                                                                 tqAPMatchingLnByPvo.tdAPMatchingLnTaxARRecTaxTC + 
                                                                 tqAPMatchingLnByPvo.tdAPMatchingLnTaxARNRecTaxTC
               tAPMatchingLnByPvo.tdAPMatchingLnTaxARRecTaxTC  = tAPMatchingLnByPvo.tdAPMatchingLnTaxARRecTaxTC +
                                                                 tqAPMatchingLnByPvo.tdAPMatchingLnTaxARRecTaxTC
               tAPMatchingLnByPvo.tdAPMatchingLnTaxARNRecTaxTC = tAPMatchingLnByPvo.tdAPMatchingLnTaxARNRecTaxTC +
                                                                 tqAPMatchingLnByPvo.tdAPMatchingLnTaxARNRecTaxTC
               tAPMatchingLnByPvo.tdAPMatchingLnTaxAIRecTaxTC  = tAPMatchingLnByPvo.tdAPMatchingLnTaxAIRecTaxTC +
                                                                 tqAPMatchingLnByPvo.tdAPMatchingLnTaxAIRecTaxTC
               tAPMatchingLnByPvo.tdAPMatchingLnTaxAINRecTaxTC = tAPMatchingLnByPvo.tdAPMatchingLnTaxAINRecTaxTC +
                                                                 tqAPMatchingLnByPvo.tdAPMatchingLnTaxAINRecTaxTC.
                         
                                                                 
                                                                 .
        
        /* State the ReceiptTaxLC based upon the ReceiptTaxTC and the LC-TC ratio */
        if last-of (tqAPMatchingLnByPvo.tiAPMatchingLn_ID)
        then assign tAPMatchingLnByPvo.tdAPMatchingLnReceiptTaxLC = <M-4 RoundAmount
                                                                       (input  tAPMatchingLnByPvo.tdAPMatchingLnReceiptTaxTC * tAPMatchingLnByPvo.tdAPMatchingLnReceiptAmtLC / tAPMatchingLnByPvo.tdAPMatchingLnReceiptAmtTC (idUnroundedAmount), 
                                                                        input  ? (iiCurrencyID), 
                                                                        input  tAPMatchingLnByPvo.tcCInvoiceCurrencyCode (icCurrencyCode)) in BAPMatching>.
        
    end. /* for each tqAPMatchingLnByPvo */
    
    /* Return */
    if oiReturnStatus = -98 then assign oiReturnStatus = 0.


Sample code: how to call this method 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 = "BAPMatching".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetAPMatchingLnByPvo".
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/bapmatching.apigetapmatchinglnbypvo.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiPvoId = <parameter value>
       vhParameter::iiPvoLineId = <parameter value>.

/* 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.