AltScore
Seller Portal

Own Financing in the Hub

A seller builds an own-financing operation in the portal and saves it. Saving is as far as the seller can take it: the simulation then waits in the Hub, where an operator or a credit approver reviews it and decides. Approving records that decision: the simulation becomes Approved, and AltScore records when it was approved and by whom. For now, approving does not create the operation in the credit system, does not reserve the customer's credit and does not create the debt (see Approving a Simulation). Until someone approves it, a simulation is a proposal and nothing more.

The split of work is fixed, and it is the first thing to understand about this screen:

WhoWhereWhat they can do with a simulation
SellerSeller portalSave it, edit it while it is pending or expired, discard it, reactivate it. Never approve it.
OperatorHubSee the organization's most recent simulations, create new ones, set the operation number, discard and reactivate
Credit approverHubApprove, and retry an approval that did not finish
A workflowWorkflow BuilderApprove or discard, through the deal node

How the seller builds and saves the plan is covered in Operation Data and Payment Plan, and what the seller sees once it is saved is in Saved Simulations and History. This page is the Hub side.

Where Simulations Live

In the sidebar, open Loan Management > Activations and choose the Own financing tab, next to Pending and Resolved. Three things have to be in place for the tab to appear: the organization needs the loan management product (without it the Loan Management group is not in the sidebar), your role needs dpa.flow.read to open Activations at all, and the tab itself needs the organization's own-financing feature plus the dpa.own-financing.read permission.

The tab lists the organization's 25 most recent own-financing simulations, newest first, whichever seller saved them and including the ones created in the Hub. There is no paging, no search and no status filter, so older simulations do not appear here and cannot be reached from this screen. The only way to open an older one is with its direct link, or through the API. The columns are:

ColumnWhat it shows
CustomerThe customer's name
CreatedThe day the simulation was saved
Sales orderThe operation number, or a dash when it has none yet
AmountThe amount financed
InstallmentsHow many installments the plan has
Issue dateThe issue date the plan is calculated from
StatusThe simulation's status

Sales order is the operation number. The Hub's list and detail call it the sales order (Sales order, Sales order No., Sales order date), the approval dialog calls it the boleto number, and the Hub's error and warning messages call it the operation number, as the seller portal does (Operation number). All of them are the same number: the one that identifies the operation in your own system and that gets printed on the document the customer signs.

Click a row to open the simulation's detail. When there are no simulations yet, the tab reads No own-financing simulations yet. If the list cannot be loaded, it reads Simulations could not be loaded.

The Hub never shows which seller, route or distributor a simulation is credited to. AltScore records all three when a seller saves a simulation, but neither this list nor the detail displays them, so you will not find them on these screens.

Statuses

A simulation is always in one of six statuses. The full set of transitions is described in Saved Simulations and History; this is what each one means for you in the Hub:

StatusWhat it means hereWhat you can do
Pending approvalSaved and waiting for a decisionApprove, discard
ApprovingBelongs to the full approval process, which is not active today, so a new approval never shows itNothing from the Hub
ApprovedApproved. For now this does not reserve credit or create the debtNothing more: it is final
Approval incompleteOnly a simulation whose approval ran while approving still created the debt can be here: its credit was reserved but the debt was not created. A new approval never reaches itRetry the approval
ExpiredOnly older simulations whose operation was cancelled in the credit system reach this statusReactivate, discard
DiscardedCancelledNothing more: it is final

The Simulations Tab on a Deal

A simulation can also be reached from its deal. In Deals, a deal's page has a Simulations tab that lists up to the 25 most recent simulations linked to that deal, newest first, with the same columns and no paging. The tab follows the same rules as the list above: it needs the own-financing feature and dpa.own-financing.read. When the deal has none, it reads No simulations for this deal yet.

The link between a simulation and a deal is made by the operation number when the simulation is saved: if a deal of that customer carries the same number as its external ID, the simulation is filed under it. A simulation saved without a link, including every simulation saved before deal linking existed, does not appear in this tab, even when its operation number matches. An unlinked simulation can be linked later in three ways: when the customer is added to the deal as its primary contact (or promoted to primary), every unlinked simulation of that customer whose operation number matches the deal's external ID is filed under it; when the seller edits and saves the simulation again; and when the seller opens the simulation's actions in the portal, where the deal is looked up again by operation number (see Simulation Actions). More on deals in the Deals API.

The Simulation Detail

The detail page is titled Own-financing simulation, with the simulation ID under the title. At the top is the status badge and, when the simulation went through a prequalification, a second badge with its result. A short status note can appear next to them, for example Approved without a CMS flow: no credit reserved and no debt emitted on a simulation approved today. It comes as the system wrote it, in English. On the right are the action buttons, which depend on the status and on your permissions (see the next sections). If the simulation cannot be loaded, the page reads Simulations could not be loaded.

Below that, a block of fields:

FieldWhat it is
CustomerThe customer's name, as a link to their profile
Total amount to financeThe amount financed, with its currency
Annual rate (%)The TNA the plan was priced with
Maximum term (months)The maximum term the simulation was saved with
Is refinancingWhether the operation is a refinancing, which changes the VAT rate on interest
Issue dateThe date interest is counted from
Sales order No.The operation number
Sales order dateThe operation date
BranchThe branch number, or the distributor's external ID when the portal takes the branch from the distributor list
Origination fee (1.5%)The origination fee amount. The label always says 1.5%, even when the organization configured a different rate
VAT on interestThe VAT rate applied to interest
CMS flow / CMS debtThe identifiers of the operation and of the debt in the credit system. Today they stay empty, because approval does not create either (see Approving a Simulation)

After the fields comes the amortization table, with the columns Installment, Due Date, Principal, Months, Interest, Interest VAT, Installment Total and Observation, and a Total row at the bottom.

The Prequalification Badge

When the seller prequalified the customer before simulating, the detail shows Prequalification: next to the status, followed by the result. The result is your organization's own decision word, exactly as your evaluation returned it, in whatever language it was written. When the evaluation returned no word, the badge says Approved or Not approved instead. A simulation without a prequalification, such as one created in the Hub, shows no badge at all. How the decision is read is covered in Prequalification.

The badge is information, not a gate. A customer the prequalification rejected can still be approved here: the seller was allowed to continue, and the decision on the credit is yours.

Installments That Need Authorization

An installment that falls beyond the maximum term plus four months needs credit authorization. When at least one does, a warning appears above the table: At least one installment exceeds the maximum term + 4 months: it requires credit authorization. In the table, that row's Observation reads Exceeds term. Requires credit authorization, and the other rows read OK. The warning does not block approval; it tells the approver that this plan needs that authorization.

The Document

The PDF button (its tooltip reads Download the document as PDF) asks AltScore to build the simulation document. It can take tens of seconds, and the button stays disabled while it works. When the document is ready, a toast says The document is ready. and an Open the PDF link appears under the buttons. Your browser may also open the document by itself, but it often blocks that when the wait was long, so use the link. Each press builds a fresh document; if an older link stops opening, press PDF again. If the document cannot be built, the Hub shows We could not build the document. Try again in a few minutes., or The document could not be generated. when AltScore gives no reason.

Approving a Simulation

Approving needs the dpa.own-financing.approve permission. With it, a simulation in Pending approval shows an Approve button. Pressing it opens the confirmation Approve the simulation?.

Approving marks the simulation Approved and records when it was approved and by whom. For now, approving does not create the operation in the credit system, does not reserve the customer's credit and does not create the debt: the status note next to the badge reads Approved without a CMS flow: no credit reserved and no debt emitted, and the CMS flow and CMS debt fields stay empty.

Approval cannot be undone

An approved simulation can no longer be discarded, and nothing in the Hub reverts an approval. The confirmation text and the success message, Simulation approved: the flow was approved and the debt created in the CMS., still describe the full process. For now none of that happens: the status note on the simulation is what tells you what was actually done.

Approval requires the simulation to be in Pending approval and to have an operation number. The customer's credit account is not checked.

When the Operation Number Is Missing

If the simulation has no operation number yet, the confirmation asks for it before anything else. The dialog shows a Sales order No. field with the hint The boleto number is required to approve: it is what gets printed on the document the customer signs. The confirm button stays disabled until the field has something in it.

On confirm, the Hub saves the number first and approves second, never the other way round. Saving the number changes only three things: the number itself, the operation date and the branch, and the operation date and branch keep the values the simulation already had. Nothing in the plan is recalculated, and setting the number here does not link the simulation to a deal. If saving the number fails, for example because another simulation already uses it, the dialog stays open with what you typed, so you can correct it and try again. When AltScore gives no reason for the failure, the Hub shows The boleto number could not be saved.

Saving the number from this dialog also needs the dpa.own-financing.write permission. An approver who only has dpa.own-financing.approve gets an error when confirming, and an operator has to set the number first.

After Approval

The seller sees the new status the next time they open the simulation, and any simulation action configured for approved simulations only becomes available to them (see Simulation Actions).

Retrying an Incomplete Approval

A simulation approved today never reaches Approval incomplete. One can still be in that status if its approval ran while approving still reserved the credit and created the debt, and the debt step failed. Its detail then shows Retry approval to anyone with dpa.own-financing.approve. It opens the confirmation Retry the approval? and re-runs only the debt step: the operation is already approved and the credit already reserved, so nothing before that is repeated. When the retry finishes, the Hub shows Approval completed. and the simulation becomes Approved. If the debt step fails again, the simulation stays in Approval incomplete and the Hub shows The operation was approved but no debt was created. Retry the approval.

Discarding and Reactivating

Both need the dpa.own-financing.write permission.

Discard appears on simulations in Pending approval or Expired. It opens the confirmation Discard the simulation?. Discarding is final and cannot be undone, and if an operation already exists for it in the credit system, that operation is cancelled. When it finishes, the Hub shows Simulation discarded. A discarded simulation releases its operation number, which another simulation can then use. Sellers can discard their own simulations from the portal too.

Reactivate appears only on Expired simulations, and it runs as soon as you press it, without a confirmation. It returns the simulation to Pending approval with the same values, and the Hub shows Simulation reactivated with a fresh flow. Despite that wording, reactivating creates nothing in the credit system: the expired operation stays archived, and the next approval works as described in Approving a Simulation.

If an action fails and AltScore gives no reason, the Hub shows The operation failed.

Approving or Discarding from a Workflow

The deal node of the Workflow Builder can also take the decision on a deal's own-financing simulation, so an approval can be the last step of an automated review. In the node, the row is called Own Financing Simulation. When the node reads, the row returns the simulation. When the node writes, the row becomes an input whose value is the decision at run time: approve or discard, in any capitalization. When the input has no value, the node takes no decision. Any other value stops the step with an error that names the two accepted values.

A few rules apply to that decision:

  • The simulation is found through the deal's external ID, which must hold the operation number. A deal without one cannot decide anything, and the step fails asking for it. The step also fails when no live simulation carries that number; since discarding a simulation releases its number, this is also what happens when the only match was already discarded.
  • The same rules as in the Hub apply. An approval from a workflow needs the operation number and a simulation in Pending approval, and it does exactly what an approval from the Hub does: for now, it marks the simulation Approved without reserving credit or creating the debt.
  • An approval is never repeated. If the simulation is already approved, an approve leaves it as it is and the node adds a notice saying so. A discard on an approved simulation is refused, as it is in the Hub.
  • A test run never decides a live simulation. In test mode, only a test simulation (one saved for a test customer) is approved or discarded; a live one is skipped with a notice.

Creating a Simulation in the Hub

Simulations do not have to come from the portal. With dpa.own-financing.write, the Own financing tab has a New simulation button that opens New own-financing simulation, a five-step wizard: Client, Product, Terms, Installments and Summary. Continue moves to the next step, and the last step ends with Save simulation.

1. Client

Search for the customer by name or ID, from three characters on (the box reads Search client by name or ID (3+ characters)). Each result shows the name and the customer's ID. Pick one to continue.

The wizard does not let you continue with a customer who has no account in the credit system, and says so next to the selected customer: This client has no CMS client: the flow cannot be created.

2. Product

Only credit products with custom amortization are offered, because the installments are typed by hand. If the organization has none, the step reads There are no credit products with custom amortization. Create one from Credit Products. If the products cannot be loaded, it reads Products could not be loaded.

3. Terms

The fields are Total amount to finance, Annual rate (%), Maximum term (months), Issue date, Sales order No., Sales order date, Branch and the Is refinancing switch. The amount must be above zero, the maximum term a whole number of months above zero, the TNA a valid number, and the issue date is required. The operation number is optional here, but the simulation cannot be approved without one.

When a field is wrong, Continue shows the error under it:

FieldMessage
Total amount to financeEnter a valid amount greater than zero.
Maximum term (months)Enter a term in months greater than zero.
Annual rate (%)Enter a valid annual rate.
Issue dateEnter the issue date.

When the seller portal's maximum term is set to Set here (see Configuring the Portal), this field comes filled with that value and cannot be changed, with the hint Cap set in the seller portal settings. Change it there. Any other source for the maximum term leaves the field free here. If the Hub cannot read the portal settings, the field shows The seller portal term cap could not be read. If one is configured, the simulation will be saved with a warning when it exceeds it.

4. Installments

Each row takes a Due date and its Principal, up to 20 rows, with Add installment for a new one. Under the rows, Principal sum compares what you have entered against Total amount to finance, and turns red while they differ. The principal has to add up exactly to that amount, or to the amount plus the origination fee when Finance the origination fees is on in the seller portal settings. With that setting on, Principal sum stays red even when the plan is right, because it only compares against the amount; the amortization table appearing is what confirms the plan adds up.

The amortization table recalculates as you type, once every row has both a date and an amount. Continue stays disabled until there is a valid calculation, so a plan whose principal does not add up, or whose dates are out of order, cannot move on. When the calculation fails, the reason appears under the rows; if AltScore gives none, it reads We could not complete the operation. Try again.

5. Summary and Save

The summary repeats the customer, the product, the terms and the origination fee, followed by the amortization table and, when it applies, the credit authorization warning. Save simulation saves it and opens its detail, with the toast Simulation saved and flow created in the CMS. Despite that wording, saving creates nothing in the credit system. From there, it is approved like any other simulation. If saving fails and AltScore gives no reason, the Hub shows The simulation could not be saved.

Saving can come with warnings. The simulation is saved in every case; the warning tells you what to review:

WarningWhat it means
The plan is longer than the configured maximum term. The simulation was saved anyway; review the installments.The plan runs longer than the maximum term, or the Maximum term (months) entered is above it. The maximum is the one set in the seller portal settings when its source is Set here, and otherwise the credit product's. The plan is saved exactly as entered.
No deal carries that operation number. The simulation was saved anyway, unlinked.No deal has that operation number, so the simulation is not filed under any deal.
More than one deal carries that operation number, so we linked it to none. The simulation was saved anyway.Several deals share the number, so none was chosen.
That operation number belongs to another customer's deal. The simulation was saved anyway, unlinked.The deal with that number does not list this customer.
The simulation was saved, but something was left half done.AltScore returned a warning the Hub does not recognize yet. AltScore's own message, in English, appears under it.

A simulation created in the Hub belongs to no seller, so it does not show up in any seller's history in the portal, and it carries no prequalification.

Errors

The Hub shows its own text for every error it recognizes. When AltScore answers with an error the Hub does not know yet, the Hub shows AltScore's message as it came, in English.

MessageWhat happenedWhat to do
That operation number is already used by another simulation.Another simulation that is not discarded already has that numberUse a different number, or discard the other simulation if it is the duplicate
The operation number is missing. Fill it in before approving.An approval was attempted without an operation numberSet the number; the approval dialog asks for it
The capitals do not add up to the financed amount.The installments' principal does not add up to the amount (plus the origination fee, when the fees are financed)Adjust the installments
The chosen credit product does not exist.The product is not found for the organizationPick another product
The chosen credit product does not allow custom schedules.The product is not a custom-amortization productPick a custom-amortization product
The chosen credit product is disabled.The product exists but is not enabledEnable it, or pick another
The operation was approved but no debt was created. Retry the approval.The debt step of a retried approval failed againUse Retry approval again
The operation does not exist in the credit system. Save the simulation again.A retry was attempted on a simulation with no operation to retry onContact support if it persists
This organisation's credit account is not set up yet, in Settings.The organization's credit account is not configuredConfigure it in Settings
The credit settings define no default currency.The credit settings have no default currencySet one in the credit settings
We could not read the credit settings. Try again in a few minutes. / We could not load the credit products. Try again in a few minutes.The credit system could not be readTry again later
We could not build the document. Try again in a few minutes.The PDF could not be builtTry again later
The simulation cannot be edited in its current state. / The action does not apply to the simulation's current state.The simulation changed status, usually because someone else acted on it firstReload the page and check its status
Own financing is not enabled for this organisation.The organization does not have the own-financing featureAsk for it to be enabled

The messages the seller sees for the same situations are listed in Errors, Warnings and Limits.

Things to Know

Approval is final. There is no way to undo an approval from the Hub, and an approved simulation cannot be discarded. Check the plan, the operation number and the authorization warning before you confirm.

Approving does not reserve credit or create the debt, for now. The simulation becomes Approved and the status note says Approved without a CMS flow: no credit reserved and no debt emitted. The confirmation and the success message still describe the full process; the note is the accurate one.

The lists show only the 25 most recent simulations. Both the Own financing tab and a deal's Simulations tab stop at 25, newest first, with no paging, search or status filter. An older simulation opens only from its direct link or through the API.

The Hub does not show who a simulation is credited to. The seller, route and distributor are recorded when a seller saves, but neither the list nor the detail displays them.

The prequalification never blocks you. A Not approved badge, or your organization's own rejection word, is the record of what the evaluation said, not a lock. The approver decides.

The operation number is unique among live simulations. Two simulations that are not discarded cannot share one. Discarding a simulation frees its number for another.

The operation number is also the link to the deal. It is how a simulation is filed under a deal when it is saved, and how a workflow's deal node finds the simulation to approve or discard. A simulation without one cannot be approved, and does not appear on any deal.

The Hub has no edit button. The only thing you change on a saved simulation from the detail is the operation number, and only through the approval dialog. To change the figures, the seller edits it from the portal while it is pending or expired, or you create a new simulation and discard the old one.

Reactivating does not approve. It puts an expired simulation back in Pending approval; someone still has to approve it.

Simulations created in the Hub have no seller. They do not appear in any seller's history and carry no prequalification badge.

Expired is rare. Only older simulations whose operation was cancelled in the credit system reach it. A simulation saved today has no operation in the credit system, so it does not expire while it waits.

The deal tab only shows linked simulations. If a simulation does not appear on its deal, check its operation number against the deal's external ID. Simulations saved before their deal was created are linked when the customer is added as the deal's primary contact. Simulations saved before deal linking existed are linked only when the seller opens their actions or saves them again in the portal.