project QadFinancials > class BCInvoice > method ApiGetSupplierInvoiceData

Description

Parameters

Internal usage

program code (program9/bcinvoice.p)

/* ================================================================ */
/* This API method was created for return suppliers with giving conditions     */
/* This method will be called from MFG/PRO for reports              */
/* ================================================================ */
/* Initialize the output parameter value */     
if oiReturnStatus = ? or oiReturnStatus = 0
then assign oiReturnStatus  = -1.
empty temp-table tSupplierInvoice no-error.

/* handle invalid parameters */
if iiPostingYear   = ?    or
   iiPostingYear   = 0    or
   iiVoucherNumber = ?    or
   iiVoucherNumber = 0    or
   icJournal       = ?    or
   icJournal       = '':U    
then return.

/* get the CInvoice by input parameters */ 
<Q-4 run CInvoiceForAPMSelection (all) (Read) (NoCache)
   (input viCompanyId, (CompanyId)
    input iiPostingYear, (CInvoicePostingYear)
    input icJournal, (JournalCode)
    input iiVoucherNumber, (CInvoiceVoucher)
    input ?, (CInvoiceId)
    input ?, (CreditorCode)
    input ?, (CInvoiceReference)
    input {&ADDRESSTYPECODESYSTEM-HEADOFFICE}, (AddressTypeCode)
    input ?, (CInvoiceRegistrationNr)
    output dataset tqCInvoiceForAPMSelection) in BCInvoice>
for each tqCInvoiceForAPMSelection :      
    /* set return value as 0 and prepare for return dataset */
    assign oiReturnStatus       = 0
           vhCInvoiceByCreditor = dataset tqCInvoiceForAPMSelection:get-buffer-handle(1).                             
    create tSupplierInvoice.
    <M-3 run BufferCopy
       (input  vhCInvoiceByCreditor (ihFrom), 
        input  buffer tSupplierInvoice:handle (ihTo), 
        output viFcReturnSuper (oiReturnStatus)) in BCInvoice>
    if viFcReturnSuper < 0 
    then assign oiReturnStatus = -1.
    return.    
end. /* end of for each tqCInvoiceForAPMSelection */

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 = "BCInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetSupplierInvoiceData".
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.apigetsupplierinvoicedata.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiPostingYear = <parameter value>
       vhParameter::icJournal = <parameter value>
       vhParameter::iiVoucherNumber = <parameter value>
       vhParameter::icCompanyCode = <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.