xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Finance Case — entity reference
REFERENCE · Last reviewed

Finance Case — entity reference

A customer's application to a lender for a loan that pays for a sale. It records the requested terms (amount, down payment, interest rate, tenure in months, EMI), the approved terms and the amount actually disbursed, and links the customer, the selling company and branch, the sales order and invoice, and the lender and scheme from the Financer masters. Only the Disbursed Amount has an effect outside the case: creating a case, changing its Disbursed Amount or deleting it recalculates Finance Amount on the linked order and invoice as the total Disbursed Amount of their finance cases, and the order's Outstanding Amount subtracts Finance Amount. Partner Account and Branch are validated on create and cannot be changed afterwards; Order and Invoice are not locked. Status is recorded by users through the record page's status timeline and nothing sets or checks it; the shipped Status values are inactive until an administrator activates them. New cases are numbered from the FC series. Finance Case is not on any shipped app menu.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe customer applying for the loan. Only customer accounts are offered. Required on create: saving without it is refused with 'Customer is required.', and an inactive customer with 'Customer is Inactive.'.
ApprovalRemarksApproval RemarksTextNotes on the lender's approval. Not on the shipped forms.
ApprovedAmountApproved AmountCurrencyThe loan amount the lender sanctioned, typed by the user in the Approved Amounts panel. For the record only.
ApprovedByIdApproved ByLookupWho approved the application. Not on the shipped forms and not set automatically.
ApprovedDownPaymentApproved Down PaymentCurrencyThe down payment the lender agreed. Not on the shipped forms and not read by anything.
ApprovedInterestRateApproved Interest RateDecimalThe interest rate the lender sanctioned, typed by the user. For the record only.
ApprovedTenureMonthsApproved Tenure (In Months)NumberThe tenure in months the lender sanctioned, typed by the user. For the record only.
BranchIdBranchLookup → BranchYour location that owns the case. Must be an active branch of the Partner Account and is required when that company has branches. Cannot be changed after the case is saved.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DeclinedByIdDeclined ByLookupWho declined the application. Not on the shipped forms and not set automatically.
DeclinedRemarksDeclined RemarksTextNotes on why the application was declined. Not on the shipped forms.
DisbursedAmountDisbursed AmountCurrencyWhat the lender actually paid out, and the only field that affects other records: creating the case, changing this value or deleting the case recalculates Finance Amount on the linked order and invoice. It may not exceed the Requested Amount.
DisbursementDateDisbursement DateDateThe date the lender paid out. Not on the shipped form panels and not read by anything.
DisbursementNumberDisbursement NumberTextThe lender's reference for the payout. Not on the shipped form panels; the record page's Disbursement Details card shows fixed sample text rather than this value until an administrator rebinds it.
EMIOnApprovedAmountEMI on Approved AmountCurrencyThe instalment on the approved terms. Not on the shipped forms and not calculated by anything.
EMIOnDisbursedAmountEMI on Disbursed AmountCurrencyThe instalment on the disbursed amount. Not on the shipped forms and not calculated by anything.
EMIOnRequestedAmountEMI on Requested AmountCurrencyThe monthly instalment on the requested terms, normally written by the Finance Calculator (reducing-balance EMI, or amount divided by months at a zero rate). Read-only on the record page. It may not exceed the Disbursed Amount, so it cannot be saved on a case that has no disbursement yet unless that validation is deactivated.
ExternalIdExternalTextAn identifier from an outside system, for imports and integrations. Not on the shipped forms.
FinanceProviderIdFinance ProviderLookup → FinancerThe lender funding the case, chosen from the Financer list. Shown on the New form, in the record page's Finance Details panel and as a header figure.
FinancerSchemeIdFinancer SchemeLookup → FinancerSchemeThe lender's finance product, chosen from the Financer Scheme list on the New form. The picker lists every scheme whatever lender is chosen, and the scheme's minimum and maximum amount and tenure are not checked against the case.
FinanceSchemeIdFinance SchemeLookupAn older scheme reference that no form shows and nothing reads. Use Financer Scheme instead.
IdIdGuidYes
InvoiceIdInvoiceLookup → InvoiceThe invoice for the financed sale; the case's Disbursed Amount counts towards this invoice's Finance Amount. It is set on the New form only, as the shipped record page does not show it, so pick it when the invoice already exists.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextThe case number, set on save from the FC series as series, day-month-year date and a six-digit counter.
OrderIdOrderLookup → OrderThe sales order being financed. The case's Disbursed Amount counts towards this order's Finance Amount. It can be changed on the record page, but changing it does not recalculate either order.
OtherFinancerOther FinancerTextFree-text name of a lender that is not in the Financer list. Not on the shipped forms, and cases recorded this way cannot be grouped or filtered by lender.
OwnerIdOwnerLookup → UserAccountYes
PartnerAccountIdPartner AccountLookup → AccountYour selling company that owns the case, not the applicant. Only partner accounts are offered; if left blank it is filled from the owner's default company. Validated on create and cannot be changed afterwards. Hidden for organisations that run a single company.
RecordTypeIdRecord TypeGuid, hidden
RequestedAmountRequested AmountCurrencyThe loan amount the customer applied for. Cannot be negative, and the Disbursed Amount may not exceed it. Also set by the record page's Finance Calculator when you save it.
RequestedDownPaymentRequested Down PaymentCurrencyWhat the customer pays up front. Cannot be negative. For the record only.
RequestedInterestRateRequested Interest RateDecimalThe annual interest rate applied for, in per cent. The Finance Calculator uses the saved value to work out the EMI.
RequestedTenureMonthsRequested Tenure (In Months)NumberThe loan length applied for, in whole months. A value of 0 or 1 is refused with 'Tenure should not be less than 1'. Also set by the Finance Calculator's tenure buttons when you save it.
StatusStatusPickListThe application's stage: Draft, Documentation, Approval In Process, Approved, or Declined as the off-path outcome. Set through the record page's status timeline one step forward at a time; nothing sets, defaults or checks it. The shipped values are inactive, so the timeline is empty until an administrator activates them.
TenureMonthsTenure MonthsPickListA list of standard tenures (12 to 84 months) kept separately from the numeric requested and approved tenures. Not on the shipped forms and not kept in step with them. Values: 12, 24, 36, 48, 60, 72, 84.
UIPropsUI PropsText
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
BulkDeleteDeleteDeleteDelete the selected records
CloneCloneServerAction (Clone)Create a copy of this record
DeleteDeleteDeleteDelete
DeleteInListDeleteDeleteDelete in list page
EditEditEditEdit
EditInLineEditEditInlineEdit in page
EditInListEditEditInlineEdit
EditListRowEditEditEditListRow
NewNewNewNew

Validations

ValidationApplies toError messageNotes
Disbursed Amount ValidationDisbursedAmount, ErrorDisbursed Amount cannot be greater than the Requested AmountDisbursed Amount Validation
XM_DownPaymentAmountValidationRequestedDownPayment, ErrorRequested Down Payment cannot be NegativeRequested Down Payment cannot be Negative
EMI Amount Rule ValidationEMIOnRequestedAmount, ErrorEMI Amount should be less than or Equal to Disbursed AmountEMI Amount Validation
XM_RequestedAmountValidationRequestedAmount, ErrorRequested Amount cannot be Negative.Requested Amount cannot be Negative
Tenure Rule ValidationAccountId, ErrorTenure should not be less than 1Account Tenure must be greater than 1 month.

Lookup filters

FilterLookup fieldNotes
Branch For Partner AccountBranchIdBranch For Partner Account
Customer Account FilterAccountId
Partner AccountPartnerAccountId