project QadFinancials > class BDebtor > API query DebtorForCreditData

Description

Query used to retrieve credit information for the API methods called from MFG/PRO.


query filter (table tFilter)


tcBusinessFieldNametcDataTypetcOperator
iiCompanyIdi
iiDebtorIDi=
icDebtorCodec=
tCurrency.CurrencyCodec=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DebtorCodec=,>=,>,<>,<=,<,begins,can-do,matches
tDebtorCreditRating.DebtorCreditRatingCodec=,>=,>,<>,<=,<,begins,can-do,matches
tDebtor.DebtorFixedCredLimTCd=,>=,>,<>,<=,<
tDebtor.DebtorHighCreditd=,>=,>,<>,<=,<
tDebtor.DebtorHighCreditDatet=,>=,>,<>,<=,<
tDebtor.DebtorIsLockedCredLiml=,<>
tDebtor.DebtorLastCreditReviewt=,>=,>,<>,<=,<
tDebtor.DebtorLastCreditUpdatet=,>=,>,<>,<=,<
tDebtor.DebtorLastSalet=,>=,>,<>,<=,<
tDebtor.DebtorPercTurnOverCredLimd=,>=,>,<>,<=,<
tDebtor.DebtorSalesOrderBalanced=,>=,>,<>,<=,<


Parameters (internal)


iiCompanyIdintegerCompany id
iiDebtorIDinteger
icDebtorCodecharacter


query condition


  each Debtor where
Debtor.SharedSet_Id = vi_DEBTOR_sharedset(iiCompanyId) AND
Debtor.Debtor_ID = iiDebtorID AND
Debtor.DebtorCode = icDebtorCode

      first Currency (inner-join) where
Currency.Currency_ID = Debtor.Currency_ID AND

      first DebtorCreditRating (outer-join) where
DebtorCreditRating.DebtorCreditRating_ID = Debtor.DebtorCreditRating_ID AND


query resultset tqDebtorForCreditData


field namedata typedb fielddescription
tcCurrencyCodecharacterCurrency.CurrencyCodeCurrency Code
tiDebtor_IDintegerDebtor.Debtor_IDRecord ID
tcDebtorCodecharacterDebtor.DebtorCodeA code (maximum eight characters) that identifies a customer. If the code you specify matches an existing supplier code, a warning message displays. You can choose to ignore the warning, and create the record. However, when a supplier and customer share the same code, they must reference the same business relation.
api annotation:If you leave the Customer Code field blank, the system automatically generates a number for the record based on the sequence defined in Customer Autonumber Create.
tcDebtorCreditRatingCodecharacterDebtorCreditRating.DebtorCreditRatingCodeA code (maximum eight characters) that identifies a customer credit rating.
tdDebtorFixedCredLimTCdecimalDebtor.DebtorFixedCredLimTCWhen Apply Fixed Ceiling is selected, specify the currency amount that determines the maximum credit extended to this customer.
api annotation:Value for this field defaults to 0.0000 .
tdDebtorHighCreditdecimalDebtor.DebtorHighCreditThe highest amount of credit you have ever extended to this customer. This is the largest AR balance they have had open at one time.
ttDebtorHighCreditDatedateDebtor.DebtorHighCreditDateThe date the highest credit amount was extended to this customer.
tlDebtorIsLockedCredLimlogicalDebtor.DebtorIsLockedCredLimIndicate whether to put this customer on hold.
api annotation:Value for this field defaults to false.
ttDebtorLastCreditReviewdateDebtor.DebtorLastCreditReviewThe date when the customer’s credit status was last reviewed.
ttDebtorLastCreditUpdatedateDebtor.DebtorLastCreditUpdateThe date when the customer’s credit status was last updated.
ttDebtorLastSaledateDebtor.DebtorLastSaleThe date an invoice was last posted for this customer.
api annotation:This date is updated by Invoice Post and Print.
tdDebtorPercTurnOverCredLimdecimalDebtor.DebtorPercTurnOverCredLimWhen Apply % of Turnover is selected,specify a percentage value. The system applies this percentage to the last year turnover and displays the result in the Credit on Turnover field. The amount is recalculated when you change the percentage.
api annotation:Value for this field defaults to 0.00 .
tdDebtorSalesOrderBalancedecimalDebtor.DebtorSalesOrderBalanceCurrent balance of all sales order related to this customer.
api annotation:Value for this field defaults to 0.0000 .
DebtorCustomcharactercalculatedcustom fields
CurrencyCustomcharactercalculatedcustom fields
DebtorCreditRatingCustomcharactercalculatedcustom fields
ti_sequenceintegercalculatedprimary index
tc_rowidcharactercalculated = rowid(Debtor),rowid(Currency),rowid(DebtorCreditRating)


Internal usage


QadFinancials
method BDebtor.ApiDebtorCreditLocked
method BDebtor.ApiExtractHighCreditInfo
method BDebtor.ApiGetDebtorCreditStatus
method BDebtor.ApiGetDebtorLastSale
method BDebtor.ApiGetFixedCreditLimit
method BDebtor.ApiGetOpenOrdersTotal
method BDebtor.ApiGetTurnoverCreditLimit
method BDebtor.CalculateBalanceSalesOrders
method BDebtor.CalculateBSOForCompany


Sample code: how to call this query 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 = "BDebtor".
create ttContext.
assign ttContext.propertyName = "methodName"
       ttContext.propertyValue = "DebtorForCreditData".
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/bdebtor.debtorforcreditdata.i.xsd", ?).
vhParameter = vhInputDS:get-buffer-handle("tParameterI").
vhParameter:buffer-create().

assign vhParameter::icRange = "A"
       vhParameter::icRowid = ""
       vhParameter::iiRownum = 0
       vhParameter::iiNumber = 5 /* Number of records to read */
       vhParameter::icSortColumns = ""
       vhParameter::ilCountOnly = false
       vhParameter::ilForwardRead = true
       vhParameter::iiMaximumBrowseRecordsToCount = 0.

vhParameter = vhInputDS:get-buffer-handle("tFilter").
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.