project QadFinancials > class BDInvoice > method ApiGetDInvoiceStatus
Description
Method to check the status of a Customer Invoice whether open or close.
Parameters
| iiyear | input | integer | Year part of the Invoice Number. |
| icdaybookcode | input | character | Daybookcode part of Invoice Number. |
| iivoucher | input | integer | Voucher part of Invoice Number. |
| olInvoiceOpenOrClosed | output | logical | Invoice is open or closed. |
| oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program9/bdinvoice.p)
if oiReturnStatus = 0
then oiReturnStatus = -98.
<Q-1 run DInvoicePrim (all) (Read) (NoCache)
(input viCompanyId, (CompanyId)
input ?, (DInvoiceId)
input iiyear, (PeriodYear)
input ?, (JournalId)
input icdaybookcode, (JournalCode)
input iivoucher, (DInvoiceVoucher)
output dataset tqDInvoicePrim) in BDInvoice >
find first tqDInvoicePrim where
tqDInvoicePrim.tiPeriodYear = iiyear and
tqDInvoicePrim.tcJournalCode = icdaybookcode and
tqDInvoicePrim.tiDInvoiceVoucher = iivoucher
no-error.
if available tqDInvoicePrim
then do:
<Q-2 run DInvoiceByIDAllInfo (all) (Read) (NoCache)
(input tqDInvoicePrim.tiCompany_ID, (CompanyId)
input tqDInvoicePrim.tiDInvoice_ID, (DInvoiceID)
output dataset tqDInvoiceByIDAllInfo) in BDInvoice >
find first tqDInvoiceByIDAllInfo where
tqDInvoiceByIDAllInfo.tiCompany_ID = tqDInvoicePrim.tiCompany_ID and
tqDInvoiceByIDAllInfo.tiDInvoice_ID = tqDInvoicePrim.tiDInvoice_ID
no-error.
if available tqDInvoiceByIDAllInfo
then
assign olInvoiceOpenOrClosed = tqDInvoiceByIDAllInfo.tlDInvoiceIsOpen.
end. /* IF AVAILABLE tqDInvoicePrim */
else
do:
assign oiReturnStatus = -1.
<M-3 run SetMessage
(input #T-1'Invoice does not exist.':50(71147)T-1# (icMessage),
input '':U (icArguments),
input '':U (icFieldName),
input '':U (icFieldValue),
input 'E':U (icType),
input 3 (iiSeverity),
input '':U (icRowid),
input 'QadFin-8649':U (icFcMsgNumber),
input '':U (icFcExplanation),
input '':U (icFcIdentification),
input '':U (icFcContext),
output viFcReturnSuper (oiReturnStatus)) in BDInvoice>
return.
end. /* ELSE DO */
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 = "ApiGetDInvoiceStatus".
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.apigetdinvoicestatus.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::iiyear = <parameter value>
vhParameter::icdaybookcode = <parameter value>
vhParameter::iivoucher = <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.