project QadFinancials > class BDInvoice > method ApiGetSalespersonPayments
Description
This method retrieves Salesperson Document Payment Data and Salesperson Cash Payment Data from Debtor Invoice Data.
Parameters
tSalespersonPayments | output | temp-table | output temp-table with sales person payments data |
icSalespersonFrom | input | character | Sales person to start with |
icSalespersonTo | input | character | Sales person to end with |
itPaymentStartDate | input | date | Payment date to start with |
itPaymentEndDate | input | date | Payment Date to end with |
icDomainCode | input | character | Domain Code |
icTransactionCurrency | input | character | Transaction Currency Code |
oiReturnStatus | output | integer | Return status of the method. |
Internal usage
unused
program code (program3/bdinvoice.p)
/* ================================================================ */
/* This API method was created to return salesperson payment data */
/* given a set of input ranges */
/* 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 tSalespersonPayments no-error.
/* Handle invalid input parameters */
if icDomainCode = ? or
icDomainCode = '':U
then return.
/* Get the Salesperson document payment data for the input parameters */
<Q-1 run DInvoiceBySlspsnByPayment (all) (Read) (NoCache)
(input ?, (CompanyId)
input icSalespersonFrom, (SalespersonFrom)
input icSalespersonTo, (SalespersonTo)
input itPaymentStartDate, (PaymentStartDate)
input itPaymentEndDate, (PaymentEndDate)
input icTransactionCurrency, (TransactionCurrency)
output dataset tqDInvoiceBySlspsnByPayment) in BDInvoice >
for each tqDInvoiceBySlspsnByPayment
where tqDInvoiceBySlspsnByPayment.tcDomainCode = icDomainCode:
assign oiReturnStatus = 0
vhDInvoiceBySlspsnByPayment = dataset tqDInvoiceBySlspsnByPayment:get-buffer-handle(1).
create tSalespersonPayments.
<M-2 run BufferCopy
(input vhDInvoiceBySlspsnByPayment (ihFrom),
input buffer tSalespersonPayments:handle (ihTo),
output viFcReturnSuper (oiReturnStatus)) in BDInvoice>
if viFcReturnSuper < 0
then do:
assign oiReturnStatus = -1.
return.
end.
end.
/* Get the Salesperson cash payment data for the input parameters */
<Q-3 run DInvoiceBySlspsnByBank (all) (Read) (NoCache)
(input ?, (CompanyId)
input icSalespersonFrom, (SalespersonFrom)
input icSalespersonTo, (SalespersonTo)
input itPaymentStartDate, (PaymentStartDate)
input itPaymentEndDate, (PaymentEndDate)
input icTransactionCurrency, (TransactionCurrency)
output dataset tqDInvoiceBySlspsnByBank) in BDInvoice >
for each tqDInvoiceBySlspsnByBank
where tqDInvoiceBySlspsnByBank.tcDomainCode = icDomainCode:
assign oiReturnStatus = 0
vhDInvoiceBySlspsnByPayment = dataset tqDInvoiceBySlspsnByBank:get-buffer-handle(1).
create tSalespersonPayments.
<M-4 run BufferCopy
(input vhDInvoiceBySlspsnByPayment (ihFrom),
input buffer tSalespersonPayments:handle (ihTo),
output viFcReturnSuper (oiReturnStatus)) in BDInvoice>
if viFcReturnSuper < 0
then do:
assign oiReturnStatus = -1.
return.
end.
/* Additional assignments since cash payments don't create DDocument records */
assign
tSalespersonPayments.tcDDocumentType = "CASH"
tSalespersonPayments.tdDDocumentExchangeRate = tqDInvoiceBySlspsnByBank.tdPostingLineExchangeRate
tSalespersonPayments.tdDDocumentRateScale = tqDInvoiceBySlspsnByBank.tdPostingLineRateScale
tSalespersonPayments.tiDDocumentYear = tqDInvoiceBySlspsnByBank.tiPostingYear
tSalespersonPayments.ttDDocumentCreationDate = tqDInvoiceBySlspsnByBank.ttPostingDate
tSalespersonPayments.tiDDocumentNumber = tqDInvoiceBySlspsnByBank.tiPostingVoucher
tSalespersonPayments.tdDDocumentInvoiceXrefAlloTC = tqDInvoiceBySlspsnByBank.tdPostingLineDebitTC
- tqDInvoiceBySlspsnByBank.tdPostingLineCreditTC
tSalespersonPayments.tdDDocumentInvoiceXrefDiscTC = 0
.
end.
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 = "ApiGetSalespersonPayments".
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.apigetsalespersonpayments.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().
assign vhParameter::icSalespersonFrom = <parameter value>
vhParameter::icSalespersonTo = <parameter value>
vhParameter::itPaymentStartDate = <parameter value>
vhParameter::itPaymentEndDate = <parameter value>
vhParameter::icDomainCode = <parameter value>
vhParameter::icTransactionCurrency = <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.