method ApiGetDeductionsForReview

Description

API is used to read deduction Categories (code, description, type) and read deduction detail information.

it will be called by external TPM team.

Parameters

icDebtorCode	input	character
icDeductionCatCode	input	character
icDeductionCatPromCode	input	character
icDeductionCatType	input	character
iiDInvoiceDeductionID	input	integer
icDInvoiceDeductionComment	input	character
icDInvoiceDeductionCustRef	input	character
icDInvoiceDeductionStatus	input	character
itDInvoicePostingDateFrom	input	date
itDInvoicePostingDateTo	input	date
icDomainCode	input	character	Required.
tApiGetDeductionsForReview	output	temp-table	Deduction invoice and detail line info. Deduction Catgory info.
icEntityList	input	character
icCurrencyCode	input	character
idDeductionAmount	input	decimal
iiDInvoiceID	input	integer
ilDInvoiceIsOpen	input	logical
oiReturnStatus	output	integer	Return status of the method.

Internal usage

unused

program code (program3/bdinvoice.p)

assign oiReturnStatus = -98.

<M-40 run ApiGetDeductions
   (input  icDebtorCode (icDebtorCode), 
    input  icDeductionCatCode (icDeductionCatCode), 
    input  icDeductionCatType (icDeductionCatType), 
    input  icDInvoiceDeductionComment (icDInvoiceDeductionComment), 
    input  icDInvoiceDeductionCustRef (icDInvoiceDeductionCustRef), 
    input  icDInvoiceDeductionStatus (icDInvoiceDeductionStatus), 
    input  itDInvoicePostingDateFrom (itDInvoicePostingDateFrom), 
    input  itDInvoicePostingDateTo (itDInvoicePostingDateTo), 
    input  icDomainCode (icDomainCode), 
    input  false (ilDeductionDetailIsWithFull), 
    output tApiGetDeductions (tApiGetDeductions), 
    input  icEntityList (icDeductionDetailEntity), 
    input  icCurrencyCode (icCurrencyCode), 
    input  idDeductionAmount (idDeductionAmount), 
    input  iiDInvoiceID (iiDInvoiceID), 
    input  iiDInvoiceDeductionID (iiDInvoiceDeductionID), 
    input  ilDInvoiceIsOpen (ilDInvoiceIsOpen), 
    input  icDeductionCatPromCode (icPromotionCode), 
    output oiReturnStatus (oiReturnStatus)) in BDInvoice>



/* Copy all data into the tApiGetDeductions */
for each tApiGetDeductions:
    create tApiGetDeductionsForReview.
    buffer-copy tApiGetDeductions  to tApiGetDeductionsForReview.
end.

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 = "BDInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "ApiGetDeductionsForReview".
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.apigetdeductionsforreview.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icDebtorCode = <parameter value>
       vhParameter::icDeductionCatCode = <parameter value>
       vhParameter::icDeductionCatPromCode = <parameter value>
       vhParameter::icDeductionCatType = <parameter value>
       vhParameter::iiDInvoiceDeductionID = <parameter value>
       vhParameter::icDInvoiceDeductionComment = <parameter value>
       vhParameter::icDInvoiceDeductionCustRef = <parameter value>
       vhParameter::icDInvoiceDeductionStatus = <parameter value>
       vhParameter::itDInvoicePostingDateFrom = <parameter value>
       vhParameter::itDInvoicePostingDateTo = <parameter value>
       vhParameter::icDomainCode = <parameter value>
       vhParameter::icEntityList = <parameter value>
       vhParameter::icCurrencyCode = <parameter value>
       vhParameter::idDeductionAmount = <parameter value>
       vhParameter::iiDInvoiceID = <parameter value>
       vhParameter::ilDInvoiceIsOpen = <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.