How Can We Help?
Funds API
| Funds API |
| Funds Get |
| Request | |
| URL | http{s}:// { server name }/riskmasterapi/{ Formname }/{clamid}/reserves/{rcrowid}/transactiontype/{paymenttype}/transaction/{transid} |
| Method | HTTPGET |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
 |
application/json Returns a response data with HATEOS |
 |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
 |
Forbidden Access |
| Description | Server name, the IP or machine name of rmA application server. Rcrowid, rc row id of the reserve selected on which payment is to be made Formname, claim line of business. It could be claimgc,claimva,claimwc,claimdi,claimpc Claimid, claim id of claim record from CLAIM table. Paymenttype, if it is payment,collection or manual deductible |
| Funds Create |
| Request | |
| URL | http{s}://{server name}/riskmasterapi/{formname}/{claimid}/transaction |
| Method | TPPOST |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
| |
application/json Returns a response data with HATEOS |
| |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
|
Forbidden Access |
| Description | Server name, the IP or machine name of rmA application server. Formname, claim line of business. It could be claimgc,claimva,claimwc,claimdi,claimpc Claimid, claim id of claim record from CLAIM table. |
| Mandatory fields for Funds Create |
| Fields in JSON | Description | Sample data |
| accountId | Bank account | 62 |
| lastName | Payee Last name | D&R Reporting And Video, Inc. |
| amount | Total of all split amounts in base currency | 2.0 |
| claimantEid | Claimant involved on financial key of payment | 3752 |
| claimCurrencyAmount | Total of split claim currency amount | 2.0 |
| dstrbnType | Distribution Type | “id”:45213,
“shortCode”:”RML”, “desc”:”Regular Mail”, “codeTable”:”DISTRIBUTION_TYPE” |
| payeeTypeCode | Payee Type | “id”:466,
“shortCode”:”C”, “desc”:”Claimant”, “codeTable”:”PAYEE_TYPE” |
| pmtCurrencyAmount | Total of split payment currency amount | 2.0 |
| pmtCurrencyType | Currency of the payment | “id”:44327,
“shortCode”:”USD”, “desc”:”United States|en-US”, “codeTable”:”CURRENCY_TYPE” |
| policyCurrencyAmount | Total of split policy currency amount | 2.0 |
| transDate | Transaction date | 10/16/2017 |
| splitRcRowID | Reserve id on which split is created. Used for carrier payment | 0 |
| claimId | Claim id | 6656 |
| splitCvgLossID | Loss type applied on coverage | 0 |
| splitResTypeCode | Reserve type applied on split | 368 |
| splitResSubTypeCode | Reserve sub type applied on split | 45919 |
| splitPolCvgID | Key of policy_X_cvg_type table applied on split | 0 |
| splitPolicyID | Policy applied on split | 0 |
| rcRowId | Reserve id on which split is created | 1927 |
| claimCurrencyAmount | Claim currency amount of split | 2.0 |
| sumAmount | Amount of split | 2.0 |
| cmbTransactionType | Transaction type of split | 5410 |
| isFirstFinal | True if first and final split | false |
| policyCurrencyAmount | Policy currency amount of split | 2.0 |
| Funds Save |
| Request | |
| URL | http{s}://{server name}/riskmasterapi/{formname}/{claimid}/transaction |
| Method | HTTPPUT |
| Content Header | Content-type: application/json Authorization: Please contact your RISKMASTER Administrator if you require an Authorization Key. |
| Response | |
| |
application/json Returns a response data with HATEOS |
| |
Returned if there is no content with the given id, or if the calling user does not have permission to view the content |
|
Forbidden Access |
| Description | Server name: the IP or machine name of rmA application server. Formname: claim line of business. It could be claimgc,claimva,claimwc,claimdi,claimpc Claimid: claim id of claim record from CLAIM table. |
| Data Dictionary for Funds Json |
| JSON Fields | UX field | Description |
| accountId | Bank account | Bank account id on which payment is made |
| addr1 | Payee information | Payee data |
| addr2 | ||
| addr3 | ||
| addr4 | ||
| countryCode | ||
| stateId | ||
| county | ||
| lastName | ||
| zipCode | ||
| city | ||
| middleName | ||
| firstName | ||
| amount | Total of all split amounts in base currency | |
| applyPayments2Cvg | If payment is processed from apply payment to coverage module. Default value is false | |
| approverId | Supervisory approval id when payment goes on hold | |
| approveUser | Supervisory approval user name | |
| autoCheckDetail | Auto check payment details | |
| autoCheckFlag | Auto Check? | If payment is created from printed auto check |
| batchNumber | Batch number generated when payment was printed in batch form. | |
| billTypeCode | Type of Bill | Type of Bill |
| checkMemo | Check memo | Check memo non html content |
| checkMemo_HTMLComments | Check memo html content | |
| checkTotal | Total amount of payments printed as a single check after roll up | |
| claimantEid | Detail level tracking claimant | Claimant involved on financial key of payment |
| claimCurrencyAmount | Total of split claim currency amount | |
| claimCurrencyType | Claim currency type .if payment is not attached to claim then it is 0 | |
| claimId | Claim id of claim to which payment is associated | |
| claimNumber | Claim number | Claim number of claim to which payment is associated |
| clearedFlag | Cleared flag | If payment check is cleared after printing |
| collectionFlag | Collection flag | Is true if it is a collection record |
| combinedPayFlag | Combined payment | If payee is a combined payment and checks for that payee will be rolled up |
| Comments | From comment tool bar button | Funds comments saved.non html content |
| htmlComments | Html content of comments | |
| Crc | Checksum.it is 0 | |
| ctlNumber | Control number | Control number to uniquely identify the payment |
| dateOfCheck | Date of check | Date on which payment was printed |
| deductibleCategory | Type of deductible.it is 1 for manual deductible | |
| disableOverRideDed | Field present on split screen.if deductible can be over ridden or not | |
| dormancyStatus | Dormancy status | Defines dormancy status of payment |
| dstrbnType | Distribution Type | Defines type of check to be printed. |
| dttmApproval | Date when payment was approved by supervisor | |
| eftDate | Date when eft check was printed | |
| eftFileName | Csv file name created during eft check printing | |
| enclosureFlag | Enclosure flag | Enclosure flag |
| eobPrintDate | When eob were printed. It is used for health claim payments or brs. | |
| eobPrintedBy | User who printed eob. | |
| filed1099Flag | 1099 filed flag | |
| finalPaymentFlag | Final payment | If payment is marked as final payment for the reserve. |
| iseftPayment | True if distribution type is EFT | |
| isSupplementalPay | If payment is made on closed reserve | |
| mailToAddressId | Mail to address fields | Address id of on which check will be printed |
| mailToEid | Mail to lastname | Entity id of mail to entity. |
| manualCheckFlag | Is true if distribution type is manual payment | |
| Notes | Transaction notes | Non html content of notes |
| notes_HTMLComments | Html content of notes | |
| numOfPaidDays | Used for non occ disability payments | |
| offSetFlag | True if payment was offset from payment history screen | |
| parentTransId | Transaction id of parent funds record. used for withholding | |
| payeeEid | Last name | Entity id of payee record |
| payeeTypeCode | Payee Type | Payee type |
| paymentFlag | Payment flag | True if record is of payment |
| payToTheOrderOf | Pay to the order of | Name to which check will be addressed |
| pmtCurrencyAmount | Total of split payment currency amount | |
| pmtCurrencyType | Currency type | Currency of the payment |
| policyCurrencyAmount | Total of split policy currency amount | |
| policyCurrencyType | Policy currency type. | |
| precheckFlag | True is payment is marked for printing | |
| Reason | Transaction reason | Transaction reason |
| reissueBy | User who reissued the payment | |
| reissueDate | Date on which payment was reissued | |
| reissueFlag | True if payment was reissues | |
| reissueParentID | Trans id of payment which was voided and the new current payment is reissues | |
| reissueReasonCode | Reason of reissues | |
| resubmitFlag | Resubmit | Resubmitted payment |
| rollupId | Roll up id generated when checks are printed | |
| settlementFlag | True if there are more than 1 payee | |
| statusCode | Check status | Current status of payment |
| stopPayDate | Stop pay date | |
| stopPayFlag | Stop pay | Indicates stop pay |
| subAccountId | Sub bank account | Primary key sub bank account table is use sub bank account setting is on |
| suppPaymentFlag | Used for non occ payments | |
| taxPaymentFlag | Used for non occ payments | |
| transactionReason | Transaction reason | Transaction reason |
| transDate | Transaction date | Date of payment |
| transId | Primary key of funds table | |
| transNumber | check number | Check number |
| unitId | Detail level tracking unti | Used for VA claim.if detail level tracking is enabled |
| voidDate | Date on which payment was voided | |
| voidFlag | Void flag | True is payment is voided |
| voidReason | Void check reason | Non html content of void reason |
| voidReason_HTMLComments | Html content of void reason | |
| voucherFlag | True if payment is printed as voucher instead of check | |
| weeksPaidCode | Used for non occ payments | |
| withholdingChildFlag | If payment is withholding child payments | |
| withholdingPMTFlag | True is withholding is applied | |
| withholdingType | Type of withholding processed | |
| mailToEntity | Entity details of mail to entity | |
| mailToAddress | Address details of mail to address | |
| fundsLss | Funds lss tab | Data related to lss payment |
| stopPayStatus | Stop pay status | Stop pay status |
| topPayReasonCode | Stop pay reason code | stopPayReason |
| stopPayReason | Stop pay reason description | Stop pay reason description |
| Supplementals | Data related to supplementals | |
| dttmRcdLastUpd | Date on which record was last updated | |
| Links | Defines the actions that can be performed on payment | |
| associatedEntities | Children of payment .they are blank | |
| sysExData. parentName | Parent form name of claim or claimant from where payment is opened | |
| parentId | Claim id/claimant row id | |
| splitRcRowID | Reserve id on which split is created. Used for carrier payment | |
| transType | Manual deductible or payment or collection | |
| claimId | Claim id | |
| isManualDed | True if manual deductible record | |
| Memophrase | Memo phrase | Memo phrase |
| resStatusParent | Parent of reserve status of split used for carrier payments | |
| isCheckStatusQueued | True if payment is in queued status | |
| isCheckStatusHold | True if payment is in hold status | |
| combPayeeAccountId | Account id of combined payee | |
| isCombPayee | If selected payee is combined payee or not | |
| combPayeeCurrtype | Currency type of combined payment | |
| accountList | Bank account list | |
| isTandE | True if Time and expense payment | |
| tandEClaimID | Claim id of time and expense payment | |
| allowVoidClearedTrans | Utility Setting allow cleared of void checks | |
| rmxLssEnable | Utility setting is lss is enabled | |
| isAllowEditPayee | if payee data can be updated.depending upon permission | |
| maxPayees | Maximum number of payees that can be added | |
| update_tax_id | New tax id of payee if updated | |
| payeeTaxId | Tax id | Tax id of payee |
| fundsPayeeTaxId | Tax id of payee | |
| splitCoverageKey | Coverage key of coverage applied on split | |
| splitCvgLossID | Loss type applied on coverage | |
| splitTransSeqNum | Transaction sequence number of coverage applied on split | |
| splitCovgSeqNum | Coverage sequence number of coverage applied on split | |
| splitResTypeCode | Reserve type applied on split | |
| splitResSubTypeCode | Reserve sub type applied on split | |
| splitPolCvgID | Key of policy_X_cvg_type table applied on split | |
| splitPolicyID | Policy applied on split | |
| splitTotals | Total of split in payment currency | |
| bRSSplitTotals | Total of brs in payment currency | |
| fundsSplits.gridstate | Defines columns of funds trans split grid | |
| Fundssplits. gridOptions | Defines actions that can be performed on split grid | |
| Fundssplit.datafield | Split data | |
| pmtCurrencyType | Payment currency | |
| rcRowId | Reserve id on which split is created | |
| pmtCurrencyAmount | Payment currency amount of split | |
| pmtCurrencyAutoDiscount | Discount amount in payment currency | |
| claimCurrencyAmount | Claim currency amount of split | |
| claimCurrencyAutoDiscount | Discount amount in claim currency | |
| sumAmount | Amount of split | |
| splitRowId | Primary key of split | |
| splitRowId | Primary key of funds | |
| cmbTransactionType | Transaction type of split | |
| glAccountCode | GL account type | |
| fromDate | From date | |
| toDate | To date | |
| invoicedBy | Invoice details | |
| invoiceAmount | ||
| invoiceNumber | ||
| poNumber | ||
| invoiceDate | ||
| CRC | Checksum.value is 0 | |
| autoDiscount | True if discount is applied | |
| isFirstFinal | True if first and final split | |
| withholdingSplitFlag | True for withholding payment | |
| parentSplitRowId | Split row id of parent record for withholding | |
| controlReqFlag | True if control request is processed | |
| isOverrideDedProcessing | If deductible is over ridden | |
| policyCurrencyAmount | Policy currency amount of split | |
| currencyConversionDate | Date recorded when amount was changed. Used for MC | |
| pmtToBaseCurRate | Payment to base currency rate | |
| pmtToClaimCurRate | Payment to claim currency rate | |
| pmtToPolicyCurRate | Payment to policy currency rate | |
| invoiceCurrencyCode | Invoice Currency: | Invoice currency |
| useMultiCurrency | True is Multi currency setting is on | |
| financialKey | Parameters which are applied to uniquely create a reserve. | |
| rsvBalance | Reserve balance in payment currency | |
| rsvPaid | Reserve paid in payment currency | |
| transTypeCodeDesc | Transaction type description | |
| Supplementals | Supplementals | Supplemental data |
| payeeTypeList | Type of payees | |
| payeeTypeCode | Selected payee type code | |
| claimantList | Detailed level tracking claimant record | |
| unitList | Detailed level tracking unit record | |
| Lob | Claim lob | |
| isDetailLevelTrackingOn | Detailed level applied | |
| isClaimNumberReadOnly | True | |
| fundsXPayeeList | Funds payee listbox values | |
| memoPhraseList | Memo phrase list | |
| voidCodeReasonList | Void code list | |
| sysSid | SMS permission id |
