Description
This method used to get the prposed payment selection lines(the information of these lines come from the invoice)
Parameters
| icPaymentSelectionDue | input | character | PaymentSelectionDue |
| ilShowAll | input | logical | ShowAll |
| itDueDate | input | date | DueDate |
| ilIsInitialLoad | input | logical | IsInitialLoad |
| icCurrencyCode | input | character | Currency Code |
| icDivisionCode | input | character | Sub-Account Code |
| icBusinessRelationCode | input | character | Business Relation Code |
| icBusinessRelationType | input | character | BusinessRelationType |
| ilBusinessRelationIsInterco | input | logical | Business Relation Interco |
| icPaymentGroupCode | input | character | Payment Group Code |
| tProposedLine | output | temp-table | Proposed Line |
| tProposedLineStage | output | temp-table | |
| icCountryCode | input | character | BusinessRelationCountryCode |
| icPaySelCurrCode | input | character | PaySelCurrCode |
| itPaySelDate | input | date | PaySelDate |
| iiPaySel_ID | input | integer | |
| iiBankPayFormatID | input | integer | |
| ilAllEntities | input | logical | |
| ilIsWithBank | input | logical | |
| icCorporateGroupCode | input | character | |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
QadFinancials
program code (program3/bpaymentselection.p)
/* ========================= */
/* Set default return status */
/* Start Block */
/* ========================= */
assign oiReturnStatus = -98
viLocalReturn = 0.
MAINAPIPROCESSINGBLOCK: DO :
/* ============================================================================================================================================================================================= */
/* Call Version 02 of this method and pass in ? for the new parameters: iiCInvoiceID, icFromBusinessRelationCode, icFromBusinessRelationCode, iiMaxNumberOfLinesToReturn, icBankNumberFormatted */
/* ============================================================================================================================================================================================= */
<M-91 run ApiGetToPayObjectsV03
(input ilIsInitialLoad (ilIsInitialLoad),
input iiBankPayFormatID (iiBankPayFormatID),
input ilShowAll (ilShowAll),
input itDueDate (itDueDate),
input icPaymentSelectionDue (icPaymentSelectionDue),
input icCurrencyCode (icCurrencyCode),
input icDivisionCode (icDivisionCode),
input icCountryCode (icCountryCode),
input icBusinessRelationCode (icBusinessRelationCode),
input ? (icFromBusinessRelationCode),
input ? (icToBusinessRelationCode),
input icBusinessRelationType (icBusinessRelationType),
input ilBusinessRelationIsInterco (ilBusinessRelationIsInterco),
input icPaymentGroupCode (icPaymentGroupCode),
input icCorporateGroupCode (icCorporateGroupCode),
input ilAllEntities (ilAllEntities),
input ilIsWithBank (ilIsWithBank),
input iiPaySel_ID (iiPaySelID),
input itPaySelDate (itPaySelDate),
input icPaySelCurrCode (icPaySelCurrCode),
input ? (iiMaxNumberOfLinesToReturn),
input ? (iiCInvoiceID),
input ? (icBankNumberFormatted),
input ? (icPaymentReference),
output tProposedLine (tProposedLine),
output tProposedLineStage (tProposedLineStage),
output viFcReturnSuper (oiReturnStatus)) in BPaymentSelection>
if viFcReturnSuper <> 0 and viLocalReturn >= 0
then assign viLocalReturn = viFcReturnSuper.
END. /* MAINAPIPROCESSINGBLOCK */
/* ========================= */
/* Set return status */
/* ========================= */
assign oiReturnStatus = viLocalReturn.
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 = "BPaymentSelection".
create ttContext.
assign ttContext.propertyName = "methodName"
ttContext.propertyValue = "ApiGetToPayObjects".
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/bpaymentselection.apigettopayobjects.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icPaymentSelectionDue = <parameter value>
vhParameter::ilShowAll = <parameter value>
vhParameter::itDueDate = <parameter value>
vhParameter::ilIsInitialLoad = <parameter value>
vhParameter::icCurrencyCode = <parameter value>
vhParameter::icDivisionCode = <parameter value>
vhParameter::icBusinessRelationCode = <parameter value>
vhParameter::icBusinessRelationType = <parameter value>
vhParameter::ilBusinessRelationIsInterco = <parameter value>
vhParameter::icPaymentGroupCode = <parameter value>
vhParameter::icCountryCode = <parameter value>
vhParameter::icPaySelCurrCode = <parameter value>
vhParameter::itPaySelDate = <parameter value>
vhParameter::iiPaySel_ID = <parameter value>
vhParameter::iiBankPayFormatID = <parameter value>
vhParameter::ilAllEntities = <parameter value>
vhParameter::ilIsWithBank = <parameter value>
vhParameter::icCorporateGroupCode = <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.