project QadFinancials > class BDebtor > method ApiGetOpenOrdersTotal

Parameters

Internal usage

program code (program3/bdebtor.p)

/* oiReturnStatus must be set to a negative value */
assign
   oiReturnStatus = -98.

/*BKW*
/*
 * DataLoad method will not load a Debtor record by
 * DebtorCode. Must find iiDebtorID by icDebtorCode
 * iiDebtorID. Query DebtorByCode helps us find the
 * Debtor_ID value.
 *
 */

<Q-2 run DebtorByCode (all) (Read) (NoCache)
   (input 0, (CompanyId)
    input icDebtorCode, (DebtorCode)
    output dataset tqDebtorByCode) in BDebtor >

find first tqDebtorByCode no-error.
    if available tqDebtorByCode
    then assign iiDebtorId = tqDebtorByCode.tiDebtor_ID.


/*
 * Fill the tDebtor Temp-Table. tDebtor is not
 * populated by default. DataLoad will a tDebtor record by
 * using iiDebtorID. Ensure that iiDebtorID is populated
 *
 */

<M-1 run DataLoad
   (input  ? (icRowids), 
    input  iiDebtorID (icPkeys), 
    input  ? (icObjectIds), 
    input  ? (icFreeform), 
    input  YES (ilKeepPrevious), 
    output viFcReturnSuper (oiReturnStatus)) in BDebtor>


/*
 * common logic to test DataLoad
 * method call was successful.
 * 
 * if not we return from this api block
 */
if viFcReturnSuper <> 0 
then do:
  oiReturnStatus = viFcReturnSuper.
end.

if viFcReturnSuper < 0 then return.


/*
 * The main logic happens here.
 * We make an explicit find on the populated
 * tDebtor Record, if available we set odOpenSOAmount
 * with DebtorSalesOrderBalance. Thats all we needed
 * to do.
 */
find first tDebtor
    where tDebtor.DebtorCode = icDebtorCode 
no-lock no-error.

if available(tDebtor)
then do:
   assign
      odOpenSOAmount  = tDebtor.DebtorSalesOrderBalance
      viFcReturnSuper = 0
      oiReturnStatus  = 0.
end.
*BKW*/

<Q-12 run DebtorForCreditData (all) (Read) (NoCache)
   (input viCompanyId, (CompanyId)
    input iiDebtorID, (DebtorID)
    input icDebtorCode, (DebtorCode)
    output dataset tqDebtorForCreditData) in BDebtor>
find first tqDebtorForCreditData no-error.
if(available(tqDebtorForCreditData)) then do:
   assign
      odOpenSOAmount  = tqDebtorForCreditData.tdDebtorSalesOrderBalance
      viFcReturnSuper = 0
      oiReturnStatus  = 0.
end.       
else do:
   /*
    * We did not get a tDebtor Record
    */
   assign
      odOpenSOAmount  = 0
      viFcReturnSuper = -98
      oiReturnStatus  = -98.
end.


/*
 * We need to find which Debtor Currency, we
 * make a call to DebtorByCreditLimitInfo this
 * will give us Debtor Currency Code. We will use
 * this later for Exchange Rate method call.
 * 
 */
<Q-4 run DebtorByCreditLimitInfo (all) (Read) (NoCache)
   (input viCompanyId, (CompanyId)
    input iiDebtorID, (DebtorId)
    input icDebtorCode, (DebtorCode)
    output dataset tqDebtorByCreditLimitInfo) in BDebtor>

/*
 *  We need to find the current record
 *  a record is not in scope until it is
 *  explicitly found
 *
 */
find first tqDebtorByCreditLimitInfo where
           tqDebtorByCreditLimitInfo.tiDebtor_ID  = (if iiDebtorId = 0
                                                     then tqDebtorByCreditLimitInfo.tiDebtor_ID
                                                     else iiDebtorId) and
           tqDebtorByCreditLimitInfo.tcDebtorCode = (if iiDebtorId = 0
                                                     then icDebtorCode
                                                     else tqDebtorByCreditLimitInfo.tcDebtorCode)
           no-error.

if available(tqdebtorbycreditlimitinfo)
then do:
    /*
     *  Need to provide Open Amount as the reporting currency
     *
     */   
    <M-10 run GetCurrencyAmount
       (input  tqDebtorByCreditLimitInfo.tcCurrencyCode (icCurrencyFrom), 
        input  icCurrency (icCurrencyTo), 
        input  tqDebtorForCreditData.tdDebtorSalesOrderBalance (idAmount), 
        output odOpenSOAmount (odAmount), 
        output viFcReturnSuper (oiReturnStatus)) in BDebtor>

    assign oiReturnStatus = viFcReturnSuper.   

    if oiReturnStatus < 0 then return.

    /*
     *  Need to provide Open Amount as a base/local currency
     *
     */

    <M-11 run GetCurrencyAmount
       (input  tqDebtorByCreditLimitInfo.tcCurrencyCode (icCurrencyFrom), 
        input  vcCompanyLC (icCurrencyTo), 
        input  tqDebtorForCreditData.tdDebtorSalesOrderBalance (idAmount), 
        output odOpenSOAmountLC (odAmount), 
        output viFcReturnSuper (oiReturnStatus)) in BDebtor>

    assign oiReturnStatus = viFcReturnSuper.   

    if oiReturnStatus < 0 then return.
end.

return.

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 = "BDebtor".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetOpenOrdersTotal".
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/bdebtor.apigetopenorderstotal.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiDebtorID = <parameter value>
       vhParameter::icDebtorCode = <parameter value>
       vhParameter::icCurrency = <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.