project QadFinancials > class BDInvoice > method ApiInvoiceStagebyInvoiceNbr
Description
API Method: returns invoice stage payment information for a set of invoice numbers.
Parameters
tApiInvoiceNbrDomCompany | input | temp-table | Input parameter: temp table holding invoice information. |
tApiInvoiceStageLegalDoc | output | temp-table | Output dataset: holds the invoice stage information. |
oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program8/bdinvoice.p)
assign oiReturnStatus = -98
viLocalReturn = 0.
processloop:
for each tApiInvoiceNbrDomCompany
no-lock:
/* Break the invoice number into it's components */
assign viPostingYear = integer(entry(1,tApiInvoiceNbrDomCompany.tcInvoiceNumber,'/':U))
viInvoiceVoucher = integer(entry(3,tApiInvoiceNbrDomCompany.tcInvoiceNumber,'/':U))
vcJournalCode = entry(2,tApiInvoiceNbrDomCompany.tcInvoiceNumber,'/':U).
/* Start the invoice query */
if vlInvoiceQueryStarted = FALSE
then do:
<Q-38 run DInvoiceByInvoiceNumber (Start) in BDInvoice >
end.
/* Find the invoice */
<Q-63 run DInvoiceByInvoiceNumber (all) (Read) (NoCache)
(input viCompanyId, (CompanyId)
input viPostingYear, (DInvoicePostingYear)
input viInvoiceVoucher, (DInvoiceVoucher)
input vcJournalCode, (JournalCode)
output dataset tqDInvoiceByInvoiceNumber) in BDInvoice >
find first tqDInvoiceByInvoiceNumber where
tqDInvoiceByInvoiceNumber.tiDInvoicePostingYear = viPostingYear and
tqDInvoiceByInvoiceNumber.tiDInvoiceVoucher = viInvoiceVoucher and
tqDInvoiceByInvoiceNumber.tcJournalCode = vcJournalCode
no-lock no-error.
if not available tqDInvoiceByInvoiceNumber
then next processloop.
if vlInvoiceStageQueryStarted = FALSE
then do:
<Q-87 run InvoiceStageByInvoiceID (Start) in BDInvoice >
end.
/* find the stage information */
<Q-60 run InvoiceStageByInvoiceID (all) (Read) (NoCache)
(input viCompanyId, (CompanyId)
input tqDInvoiceByInvoiceNumber.tiDInvoice_ID, (InvoiceId)
output dataset tqInvoiceStageByInvoiceID) in BDInvoice >
assign viStageNumber = 0.
for each tqInvoiceStageByInvoiceID
no-lock:
create tApiInvoiceStageLegalDoc.
assign tApiInvoiceStageLegalDoc.tcInvoiceNumber = tApiInvoiceNbrDomCompany.tcInvoiceNumber
tApiInvoiceStageLegalDoc.tiInvoiceId = tqDInvoiceByInvoiceNumber.tiDInvoice_ID
tApiInvoiceStageLegalDoc.tcCurreny = tqDInvoiceByInvoiceNumber.tcCurrencyCode
tApiInvoiceStageLegalDoc.tdInvoiceAmtLC = tqDInvoiceByInvoiceNumber.tdDInvoiceOriginalCreditLC + tqDInvoiceByInvoiceNumber.tdDInvoiceOriginalDebitLC
tApiInvoiceStageLegalDoc.tdStageAmtLC = tqInvoiceStageByInvoiceID.tdDInvoiceStageAmountLC
viStageNumber = viStageNumber + 1
tApiInvoiceStageLegalDoc.tiInvoiceStageNumber = viStageNumber
tApiInvoiceStageLegalDoc.tiInvoiceStageID = tqInvoiceStageByInvoiceID.tiDInvoiceStage_ID
tApiInvoiceStageLegalDoc.ttStageDueDate = tqInvoiceStageByInvoiceID.ttDInvoiceStageDueDate.
end.
end. /* for each tApiInvoiceNbrDomCompany */
/* Stop the invoice query */
if vlInvoiceQueryStarted = TRUE
then do:
<Q-37 run DInvoiceByInvoiceNumber (Stop) in BDInvoice >
end.
if vlInvoiceStageQueryStarted = TRUE
then do:
<Q-26 run InvoiceStageByInvoiceID (Stop) in BDInvoice >
end.
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 = "BDInvoice".
create ttContext.
assign ttContext.propertyName = "methodName"
ttContext.propertyValue = "ApiInvoiceStagebyInvoiceNbr".
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.apiinvoicestagebyinvoicenbr.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tApiInvoiceNbrDomCompany").
vhParameter:buffer-create().
assign vhParameter::<field-name-1> = <field-value-1>
vhParameter::<field-name-2> = <field-value-2>
...
/* 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.