Toaztr logo
API docs by Redocly

Toaztr API (1.0.0)

Download OpenAPI specification:Download

Introduction

Les API Toaztr sont documentées au format OpenAPI. Elles sont accessibles depuis n'importe quel site ou serveur, toutes les réponses incluant un header Cross-Origin Resource Sharing adapté, comme spécifié sur la spécification W3C.

partenaire

Gestion des partenaires intervenant dans les dossiers clients

Crée un partenaire

Crée un partenaire

Authorizations:
toaztr_auth
Request Body schema: application/json
type
required
string (PartnerType)
Enum: "NOTARY" "ESTATE_AGENT" "BANK" "BROKER" "COLLECTOR_ONE_PERCENT_EMPLOYER" "HOUSE_BUILDER" "DPE_CHECKER" "LAND_SURVEYOR" "BUSINESS_PROVIDER" "ARCHITECT" "REAL_ESTATE_DEVELOPER" "LAWYER" "INSURER" "OTHER"

Type de partenaire ou d'intervenant sur un dossier.

name
string

Nom du partenaire.

object (Address)

Adresse complète. Pour obtenir le code INSEE, utilisez https://geo.api.gouv.fr/adresse.

sub_entity
string

Sous-entité: agence, bureau, etc....

agreement_number
string

Agrément ORIAS, ou n'importe quelle référence légale

object (Contact)

Contact.

Array of objects (Contact)

Liste des contacts au sein du partenaire.

logo_uri
string

Lien vers le logo du partenaire. Par exemple: https://www.toaztr.com/assets/toaztr_logo.png

website
string

Addresse du site web du partenaire.

object (BillingRules)

Régles de facturation.

object (BillingRules)

Régles de facturation.

object (RIB)

IBAN, BIC, RIB

comment
string

Commentaire.

Responses

Request samples

Content type
application/json
{
  • "type": "NOTARY",
  • "name": "string",
  • "address": {
    },
  • "sub_entity": "string",
  • "agreement_number": "string",
  • "main_contact": {
    },
  • "contacts": [
    ],
  • "logo_uri": "string",
  • "website": "string",
  • "partner_billing_rules": {
    },
  • "customer_billing_rules": {
    },
  • "rib": {
    },
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les partenaires

Liste les partenaires

Authorizations:
toaztr_auth
query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne un partenaire par ID

Retourne un partenaire par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mets à jour un partenaire par ID

Mets à jour un partenaire par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
type
required
string (PartnerType)
Enum: "NOTARY" "ESTATE_AGENT" "BANK" "BROKER" "COLLECTOR_ONE_PERCENT_EMPLOYER" "HOUSE_BUILDER" "DPE_CHECKER" "LAND_SURVEYOR" "BUSINESS_PROVIDER" "ARCHITECT" "REAL_ESTATE_DEVELOPER" "LAWYER" "INSURER" "OTHER"

Type de partenaire ou d'intervenant sur un dossier.

name
string

Nom du partenaire.

object (Address)

Adresse complète. Pour obtenir le code INSEE, utilisez https://geo.api.gouv.fr/adresse.

sub_entity
string

Sous-entité: agence, bureau, etc....

agreement_number
string

Agrément ORIAS, ou n'importe quelle référence légale

object (Contact)

Contact.

Array of objects (Contact)

Liste des contacts au sein du partenaire.

logo_uri
string

Lien vers le logo du partenaire. Par exemple: https://www.toaztr.com/assets/toaztr_logo.png

website
string

Addresse du site web du partenaire.

object (BillingRules)

Régles de facturation.

object (BillingRules)

Régles de facturation.

object (RIB)

IBAN, BIC, RIB

comment
string

Commentaire.

Responses

Request samples

Content type
application/json
{
  • "type": "NOTARY",
  • "name": "string",
  • "address": {
    },
  • "sub_entity": "string",
  • "agreement_number": "string",
  • "main_contact": {
    },
  • "contacts": [
    ],
  • "logo_uri": "string",
  • "website": "string",
  • "partner_billing_rules": {
    },
  • "customer_billing_rules": {
    },
  • "rib": {
    },
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime un partenaire par ID

Supprime un partenaire par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

dossier

Gestion de dossiers clients

Crée un dossier

Crée un dossier

Authorizations:
toaztr_auth
Request Body schema: application/json
name
string

Nom du dossier

assigned_to
string

ID de l'utilisateur à qui est assigné le dossier

copied_from
string

ID du dossier parent, si ce dossier a été créé par copie

status
string (CaseStatus)
Enum: "NEW" "INSTRUCTION" "SENT_TO_BANK" "GRANTED_BANK" "REFUSED_BANK" "CUSTOMER_ACCEPTED" "COMPLETED" "INVOICED" "CLOSED" "CANCELED"

État de l'avancement du dossier.

comment
string

Commentaire sur le dossier

Array of objects
HouseholdDetails (object) or LegalPerson (object)
Array of objects (ActivePartner)

Liste des intervenants sur le dossier: notaire, courtier, conseiller clientèle banque, agent immobilier, etc...

Budget (object) or HouseConstruction (object) or OldProperty (object) or NewProperty (object) or Works (object) or Land (object) or DebtConsolidation (object) or Pinel (object) or BalancingAdjustment (object) or LMNP (object)

Projet.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "assigned_to": "string",
  • "copied_from": "string",
  • "status": "NEW",
  • "comment": "string",
  • "candidate_simulations": [
    ],
  • "actor": {
    },
  • "partners": [
    ],
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les dossiers

Liste les dossiers

Authorizations:
toaztr_auth
query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Liste les dossiers par leur nom

Liste les dossiers par leur nom, la recherche n'est pas sensible à la casse

Authorizations:
toaztr_auth
query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

filter[name]
string

Début du nom du dossier

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Liste les dossiers par leur categorie

Liste les dossiers par leur categorie, la recherche n'est pas sensible à la casse

Authorizations:
toaztr_auth
query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

filter[category]
string

Statut du dossier à filtrer

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne un dossier par ID

Retourne un dossier par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mets à jour un dossier par ID

Mets à jour un dossier par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
name
string

Nom du dossier

assigned_to
string

ID de l'utilisateur à qui est assigné le dossier

copied_from
string

ID du dossier parent, si ce dossier a été créé par copie

status
string (CaseStatus)
Enum: "NEW" "INSTRUCTION" "SENT_TO_BANK" "GRANTED_BANK" "REFUSED_BANK" "CUSTOMER_ACCEPTED" "COMPLETED" "INVOICED" "CLOSED" "CANCELED"

État de l'avancement du dossier.

comment
string

Commentaire sur le dossier

Array of objects
HouseholdDetails (object) or LegalPerson (object)
Array of objects (ActivePartner)

Liste des intervenants sur le dossier: notaire, courtier, conseiller clientèle banque, agent immobilier, etc...

Budget (object) or HouseConstruction (object) or OldProperty (object) or NewProperty (object) or Works (object) or Land (object) or DebtConsolidation (object) or Pinel (object) or BalancingAdjustment (object) or LMNP (object)

Projet.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "assigned_to": "string",
  • "copied_from": "string",
  • "status": "NEW",
  • "comment": "string",
  • "candidate_simulations": [
    ],
  • "actor": {
    },
  • "partners": [
    ],
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime un dossier par ID

Supprime un dossier par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Mets à jour le statut d'un dossier par ID

Mets à jour le statut d'un dossier par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
status
required
string (CaseStatus)
Enum: "NEW" "INSTRUCTION" "SENT_TO_BANK" "GRANTED_BANK" "REFUSED_BANK" "CUSTOMER_ACCEPTED" "COMPLETED" "INVOICED" "CLOSED" "CANCELED"

État de l'avancement du dossier.

Responses

Request samples

Content type
application/json
{
  • "status": "NEW"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mets à jour le status d'un dossier par ID

Mets à jour l'ID de l'utilisateur à qui est assigné le dossier

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
assigned_to
required
string

ID de l'utilisateur.

Responses

Request samples

Content type
application/json
{
  • "assigned_to": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

facturation

Génération de factures à destination des clients et partenaires

Retourne une facture partenaire ou client par ID

Retourne une facture partenaire ou client par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime une facture partenaire ou client par ID

Supprime une facture partenaire ou client par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Génère une facture partenaire ou client

Génère une facture partenaire ou client, depuis les objets dossier, simulation et partners ou leurs IDs.

Authorizations:
toaztr_auth
Request Body schema: application/json

Objets dossier, simulation et partners ou leurs IDs.

One of
type
required
string
Value: "PARTNER_BILLING_PARAMETERS"

Type de paramètres de faturation.

required
object (FundingResults)

Résultats d'un calcul de financement.

required
object (Case)

Dossier emprunteur complet.

required
object (Partner)

Partenaire, et sa liste de contacts.

required
object (Partner)

Partenaire, et sa liste de contacts.

Responses

Request samples

Content type
application/json
Example
{
  • "type": "PARTNER_BILLING_PARAMETERS",
  • "funding_results": {
    },
  • "case": {
    },
  • "partner_from": {
    },
  • "partner_to": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Génère une facture au format Word

Génère une facture au format Word (docx), à partir de son ID.

Authorizations:
toaztr_auth
path Parameters
id
required
string

Responses

financement

Gestion des plans de financement dans un dossier client

Crée un plan

Crée un plan

Authorizations:
toaztr_auth
path Parameters
caseId
required
string

ID du dossier parent

Request Body schema: application/json
One of
maximal_monthly_payment
number >= 0

Mensualité maximale, à ne pas dépasser.

maximal_debt_ratio
number [ 0 .. 100 ]

Pourcentage d'endettement à ne pas dépasser. En général égal à 33% des revenus de l'emprunteur.

object (FundingFees)

Frais relatifs au plan de financement: frais de dossier bancaire et frais de courtage.

required
Array of FreeLoan (object) or PtzLoan (object) or BossLoan (object) or BridgeLoan (object) or SmoothableCharge (object) (AvailableLoan)

Type(s) de prêt à considérer pour la simulation. L'ajout d'un élément dans cette liste ne garanti pas qu'il sera utilisé dans le plan de financement final, si le plan peut être satisfait avec un sous ensemble des lignes, ou si l'emprunteur n'est pas elligible à certain de ces prêts (PTZ...).

GrandiozProfile (object) or MonthlyVaryingProfile (object) or YearlyVaryingProfile (object) or CustomProfile (object)
object (ActivePartner)

Partenaire bancaire actif: il s'agit d'un partenaire issue de la base de partenaires, ayant un role sur le dossier courant.

type
required
string
Default: "BUDGET_PLAN_PARAMETERS"
Value: "BUDGET_PLAN_PARAMETERS"

Type du jeu de paramètres.

name
string

Nom des paramètres

Responses

Request samples

Content type
application/json
Example
{
  • "maximal_monthly_payment": 0,
  • "maximal_debt_ratio": 100,
  • "funding_fees": {
    },
  • "loans": [
    ],
  • "profile": {
    },
  • "bank": {
    },
  • "type": "BUDGET_PLAN_PARAMETERS",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les plans

Liste les plans

Authorizations:
toaztr_auth
path Parameters
caseId
required
string

ID du dossier parent

query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne un plan par ID

Retourne un plan par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

caseId
required
string

ID du dossier parent

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mets à jour un plan par ID

Mets à jour un plan par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

caseId
required
string

ID du dossier parent

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
One of
maximal_monthly_payment
number >= 0

Mensualité maximale, à ne pas dépasser.

maximal_debt_ratio
number [ 0 .. 100 ]

Pourcentage d'endettement à ne pas dépasser. En général égal à 33% des revenus de l'emprunteur.

object (FundingFees)

Frais relatifs au plan de financement: frais de dossier bancaire et frais de courtage.

required
Array of FreeLoan (object) or PtzLoan (object) or BossLoan (object) or BridgeLoan (object) or SmoothableCharge (object) (AvailableLoan)

Type(s) de prêt à considérer pour la simulation. L'ajout d'un élément dans cette liste ne garanti pas qu'il sera utilisé dans le plan de financement final, si le plan peut être satisfait avec un sous ensemble des lignes, ou si l'emprunteur n'est pas elligible à certain de ces prêts (PTZ...).

GrandiozProfile (object) or MonthlyVaryingProfile (object) or YearlyVaryingProfile (object) or CustomProfile (object)
object (ActivePartner)

Partenaire bancaire actif: il s'agit d'un partenaire issue de la base de partenaires, ayant un role sur le dossier courant.

type
required
string
Default: "BUDGET_PLAN_PARAMETERS"
Value: "BUDGET_PLAN_PARAMETERS"

Type du jeu de paramètres.

name
string

Nom des paramètres

Responses

Request samples

Content type
application/json
Example
{
  • "maximal_monthly_payment": 0,
  • "maximal_debt_ratio": 100,
  • "funding_fees": {
    },
  • "loans": [
    ],
  • "profile": {
    },
  • "bank": {
    },
  • "type": "BUDGET_PLAN_PARAMETERS",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime un plan par ID

Supprime un plan par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

caseId
required
string

ID du dossier parent

header Parameters
If-Match
string

ETag de la ressource

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

simulation

Gestion des simulations d'un plan de financement dans un dossier client

Crée une simulation

Crée une simulation

Authorizations:
toaztr_auth
path Parameters
caseId
required
string

ID du dossier parent

planId
required
string

ID des paramètres du plan de financement parent

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les simulations

Liste les simulations

Authorizations:
toaztr_auth
path Parameters
caseId
required
string

ID du dossier parent

planId
required
string

ID des paramètres du plan de financement parent

query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne une simulation par ID

Retourne une simulation par ID

Authorizations:
toaztr_auth
path Parameters
caseId
required
string

ID du dossier parent

planId
required
string

ID des paramètres du plan de financement parent

id
required
string

ID unique de la ressource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime une simulation par ID

Supprime une simulation par ID

Authorizations:
toaztr_auth
path Parameters
caseId
required
string

ID du dossier parent

planId
required
string

ID des paramètres du plan de financement parent

id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

transfert

Gestion des transferts

Crée un transfert

Crée un transfert

Authorizations:
toaztr_auth
Request Body schema: application/json
Any of
type
required
string
Value: "CASE"

Type de transfert.

case_id
string

ID unique du dossier à transférer.

subscription_id
string

ID de la souscription de destination.

include_plans_parameters
boolean
Default: false

Inclusion des plans de financements dans le transfert.

include_simulations
boolean
Default: false

Inclusion des simulations dans le transfert.

delete_after_completion
boolean
Default: false

Supprime le dossier de la souscription courante après l'avoir transféré dans la souscription de destination.

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "case_id": "string",
  • "subscription_id": "string",
  • "include_plans_parameters": false,
  • "include_simulations": false,
  • "delete_after_completion": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les transferts

Liste les transferts

Authorizations:
toaztr_auth
query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne un transfert par ID

Retourne un transfert par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

simulation

Calcule un plan de financement complet relatif à un projet

Calcule une simulation de budget

Calcule une simulation de budget

Authorizations:
toaztr_auth
Request Body schema: application/json
maximal_monthly_payment
number >= 0

Mensualité maximale, à ne pas dépasser.

maximal_debt_ratio
number [ 0 .. 100 ]

Pourcentage d'endettement à ne pas dépasser. En général égal à 33% des revenus de l'emprunteur.

object (FundingFees)

Frais relatifs au plan de financement: frais de dossier bancaire et frais de courtage.

required
Array of FreeLoan (object) or PtzLoan (object) or BossLoan (object) or BridgeLoan (object) or SmoothableCharge (object) (AvailableLoan)

Type(s) de prêt à considérer pour la simulation. L'ajout d'un élément dans cette liste ne garanti pas qu'il sera utilisé dans le plan de financement final, si le plan peut être satisfait avec un sous ensemble des lignes, ou si l'emprunteur n'est pas elligible à certain de ces prêts (PTZ...).

GrandiozProfile (object) or MonthlyVaryingProfile (object) or YearlyVaryingProfile (object) or CustomProfile (object)
object (ActivePartner)

Partenaire bancaire actif: il s'agit d'un partenaire issue de la base de partenaires, ayant un role sur le dossier courant.

object (LightBudget)

Projet de type budget, lorsque l'emprunteur est encore en phase de recherche, avant qu'un bien soit identifié.

LightHouseholdDetails (object) or LightLegalPerson (object)

Responses

Request samples

Content type
application/json
{
  • "maximal_monthly_payment": 0,
  • "maximal_debt_ratio": 100,
  • "funding_fees": {
    },
  • "loans": [
    ],
  • "profile": {
    },
  • "bank": {
    },
  • "project": {
    },
  • "actor": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Calcule une simulation de financement

Calcule une simulation de financement

Authorizations:
toaztr_auth
Request Body schema: application/json
objective
string (SimulationObjective)
Enum: "MINIMIZE_COST" "MINIMIZE_INSTALMENT"

Objectif de la simulation:

  • Minimiser le coût global du plan de financement, et donc saturer la capacitée de remboursement de l'emprunteur. C'est à dire que la mensualité maximale donnée en entrée est systématiquement utilisée.

  • Maximiser le reste à vivre (et donc minimiser la mensualitée): le plan de financement obtenu est plus long et plus coûteux, mais la mensualité est la plus basse possible, et donc le reste à vivre le meilleur possible. Dans ce cas, la mensualité maximale donnée en entrée n'est pas utilisée.

bypass_instalment_constraints
boolean
Default: false

Permet de ne pas tenir compte des contraintes maximal_monthly_payment et maximal_debt_ratio et de renvoyer un plan de financement dans tous les cas, en mode MINIMIZE_INSTALMENT.

maximal_monthly_payment
number >= 0

Mensualité maximale, à ne pas dépasser.

maximal_debt_ratio
number [ 0 .. 100 ]

Pourcentage d'endettement à ne pas dépasser. En général égal à 33% des revenus de l'emprunteur.

object (FundingFees)

Frais relatifs au plan de financement: frais de dossier bancaire et frais de courtage.

required
Array of FreeLoan (object) or PtzLoan (object) or BossLoan (object) or BridgeLoan (object) or SmoothableCharge (object) (AvailableLoan)

Type(s) de prêt à considérer pour la simulation. L'ajout d'un élément dans cette liste ne garanti pas qu'il sera utilisé dans le plan de financement final, si le plan peut être satisfait avec un sous ensemble des lignes, ou si l'emprunteur n'est pas elligible à certain de ces prêts (PTZ...).

GrandiozProfile (object) or MonthlyVaryingProfile (object) or YearlyVaryingProfile (object) or CustomProfile (object)
object (ActivePartner)

Partenaire bancaire actif: il s'agit d'un partenaire issue de la base de partenaires, ayant un role sur le dossier courant.

LightHouseConstruction (object) or LightOldProperty (object) or LightNewProperty (object) or LightWorks (object) or LightLand (object) or LightBalancingAdjustment (object)
LightHouseholdDetails (object) or LightLegalPerson (object)

Responses

Request samples

Content type
application/json
{
  • "objective": "MINIMIZE_COST",
  • "bypass_instalment_constraints": false,
  • "maximal_monthly_payment": 0,
  • "maximal_debt_ratio": 100,
  • "funding_fees": {
    },
  • "loans": [
    ],
  • "profile": {
    },
  • "bank": {
    },
  • "project": {
    },
  • "actor": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Calcule une simulation Pinel

Calcule une simulation Pinel

Authorizations:
toaztr_auth
Request Body schema: application/json
objective
string (SimulationObjective)
Enum: "MINIMIZE_COST" "MINIMIZE_INSTALMENT"

Objectif de la simulation:

  • Minimiser le coût global du plan de financement, et donc saturer la capacitée de remboursement de l'emprunteur. C'est à dire que la mensualité maximale donnée en entrée est systématiquement utilisée.

  • Maximiser le reste à vivre (et donc minimiser la mensualitée): le plan de financement obtenu est plus long et plus coûteux, mais la mensualité est la plus basse possible, et donc le reste à vivre le meilleur possible. Dans ce cas, la mensualité maximale donnée en entrée n'est pas utilisée.

bypass_instalment_constraints
boolean
Default: false

Permet de ne pas tenir compte des contraintes maximal_monthly_payment et maximal_debt_ratio et de renvoyer un plan de financement dans tous les cas, en mode MINIMIZE_INSTALMENT.

maximal_monthly_payment
number >= 0

Mensualité maximale, à ne pas dépasser.

maximal_debt_ratio
number [ 0 .. 100 ]

Pourcentage d'endettement à ne pas dépasser. En général égal à 33% des revenus de l'emprunteur.

object (FundingFees)

Frais relatifs au plan de financement: frais de dossier bancaire et frais de courtage.

required
Array of FreeLoan (object) or PtzLoan (object) or BossLoan (object) or BridgeLoan (object) or SmoothableCharge (object) (AvailableLoan)

Type(s) de prêt à considérer pour la simulation. L'ajout d'un élément dans cette liste ne garanti pas qu'il sera utilisé dans le plan de financement final, si le plan peut être satisfait avec un sous ensemble des lignes, ou si l'emprunteur n'est pas elligible à certain de ces prêts (PTZ...).

GrandiozProfile (object) or MonthlyVaryingProfile (object) or YearlyVaryingProfile (object) or CustomProfile (object)
object (ActivePartner)

Partenaire bancaire actif: il s'agit d'un partenaire issue de la base de partenaires, ayant un role sur le dossier courant.

object (LightPinel)

Projet d'investissement dans le cadre du dispositif Pinel.

RentalInvestmentHouseholdDetails (object) or LightLegalPerson (object)

Responses

Request samples

Content type
application/json
{
  • "objective": "MINIMIZE_COST",
  • "bypass_instalment_constraints": false,
  • "maximal_monthly_payment": 0,
  • "maximal_debt_ratio": 100,
  • "funding_fees": {
    },
  • "loans": [
    ],
  • "profile": {
    },
  • "bank": {
    },
  • "project": {
    },
  • "actor": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Calcule une simulation de consolidation de dettes

Calcule une simulation de consolidation de dettes

Authorizations:
toaztr_auth
Request Body schema: application/json
objective
string (SimulationObjective)
Enum: "MINIMIZE_COST" "MINIMIZE_INSTALMENT"

Objectif de la simulation:

  • Minimiser le coût global du plan de financement, et donc saturer la capacitée de remboursement de l'emprunteur. C'est à dire que la mensualité maximale donnée en entrée est systématiquement utilisée.

  • Maximiser le reste à vivre (et donc minimiser la mensualitée): le plan de financement obtenu est plus long et plus coûteux, mais la mensualité est la plus basse possible, et donc le reste à vivre le meilleur possible. Dans ce cas, la mensualité maximale donnée en entrée n'est pas utilisée.

bypass_instalment_constraints
boolean
Default: false

Permet de ne pas tenir compte des contraintes maximal_monthly_payment et maximal_debt_ratio et de renvoyer un plan de financement dans tous les cas, en mode MINIMIZE_INSTALMENT.

maximal_monthly_payment
number >= 0

Mensualité maximale, à ne pas dépasser.

maximal_debt_ratio
number [ 0 .. 100 ]

Pourcentage d'endettement à ne pas dépasser. En général égal à 33% des revenus de l'emprunteur.

object (FundingFees)

Frais relatifs au plan de financement: frais de dossier bancaire et frais de courtage.

required
Array of FreeLoan (object) or PtzLoan (object) or BossLoan (object) or BridgeLoan (object) or SmoothableCharge (object) (AvailableLoan)

Type(s) de prêt à considérer pour la simulation. L'ajout d'un élément dans cette liste ne garanti pas qu'il sera utilisé dans le plan de financement final, si le plan peut être satisfait avec un sous ensemble des lignes, ou si l'emprunteur n'est pas elligible à certain de ces prêts (PTZ...).

GrandiozProfile (object) or MonthlyVaryingProfile (object) or YearlyVaryingProfile (object) or CustomProfile (object)
object (ActivePartner)

Partenaire bancaire actif: il s'agit d'un partenaire issue de la base de partenaires, ayant un role sur le dossier courant.

object (DebtConsolidation)

Projet de rachat ou de regroupement de crédits.

BaseHouseholdDetails (object) or LightLegalPerson (object)

Responses

Request samples

Content type
application/json
{
  • "objective": "MINIMIZE_COST",
  • "bypass_instalment_constraints": false,
  • "maximal_monthly_payment": 0,
  • "maximal_debt_ratio": 100,
  • "funding_fees": {
    },
  • "loans": [
    ],
  • "profile": {
    },
  • "bank": {
    },
  • "project": {
    },
  • "actor": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Calcule une simulation LMNP

Calcule une simulation LMNP

Authorizations:
toaztr_auth
Request Body schema: application/json
objective
string (SimulationObjective)
Enum: "MINIMIZE_COST" "MINIMIZE_INSTALMENT"

Objectif de la simulation:

  • Minimiser le coût global du plan de financement, et donc saturer la capacitée de remboursement de l'emprunteur. C'est à dire que la mensualité maximale donnée en entrée est systématiquement utilisée.

  • Maximiser le reste à vivre (et donc minimiser la mensualitée): le plan de financement obtenu est plus long et plus coûteux, mais la mensualité est la plus basse possible, et donc le reste à vivre le meilleur possible. Dans ce cas, la mensualité maximale donnée en entrée n'est pas utilisée.

bypass_instalment_constraints
boolean
Default: false

Permet de ne pas tenir compte des contraintes maximal_monthly_payment et maximal_debt_ratio et de renvoyer un plan de financement dans tous les cas, en mode MINIMIZE_INSTALMENT.

maximal_monthly_payment
number >= 0

Mensualité maximale, à ne pas dépasser.

maximal_debt_ratio
number [ 0 .. 100 ]

Pourcentage d'endettement à ne pas dépasser. En général égal à 33% des revenus de l'emprunteur.

object (FundingFees)

Frais relatifs au plan de financement: frais de dossier bancaire et frais de courtage.

required
Array of FreeLoan (object) or PtzLoan (object) or BossLoan (object) or BridgeLoan (object) or SmoothableCharge (object) (AvailableLoan)

Type(s) de prêt à considérer pour la simulation. L'ajout d'un élément dans cette liste ne garanti pas qu'il sera utilisé dans le plan de financement final, si le plan peut être satisfait avec un sous ensemble des lignes, ou si l'emprunteur n'est pas elligible à certain de ces prêts (PTZ...).

GrandiozProfile (object) or MonthlyVaryingProfile (object) or YearlyVaryingProfile (object) or CustomProfile (object)
object (ActivePartner)

Partenaire bancaire actif: il s'agit d'un partenaire issue de la base de partenaires, ayant un role sur le dossier courant.

object (LightLMNP)

Projet d'investissement dans le cadre du dispositif LMNP.

RentalInvestmentHouseholdDetails (object) or LightLegalPerson (object)

Responses

Request samples

Content type
application/json
{
  • "objective": "MINIMIZE_COST",
  • "bypass_instalment_constraints": false,
  • "maximal_monthly_payment": 0,
  • "maximal_debt_ratio": 100,
  • "funding_fees": {
    },
  • "loans": [
    ],
  • "profile": {
    },
  • "bank": {
    },
  • "project": {
    },
  • "actor": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

score

Calcule le score d'un dossier emprunteur

Calcule le score d'un dossier

Calcule le score d'un dossier

Authorizations:
toaztr_auth
Request Body schema: application/json
name
string

Nom du dossier

assigned_to
string

ID de l'utilisateur à qui est assigné le dossier

copied_from
string

ID du dossier parent, si ce dossier a été créé par copie

status
string (CaseStatus)
Enum: "NEW" "INSTRUCTION" "SENT_TO_BANK" "GRANTED_BANK" "REFUSED_BANK" "CUSTOMER_ACCEPTED" "COMPLETED" "INVOICED" "CLOSED" "CANCELED"

État de l'avancement du dossier.

comment
string

Commentaire sur le dossier

Array of objects
HouseholdDetails (object) or LegalPerson (object)
Array of objects (ActivePartner)

Liste des intervenants sur le dossier: notaire, courtier, conseiller clientèle banque, agent immobilier, etc...

Budget (object) or HouseConstruction (object) or OldProperty (object) or NewProperty (object) or Works (object) or Land (object) or DebtConsolidation (object) or Pinel (object) or BalancingAdjustment (object) or LMNP (object)

Projet.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "assigned_to": "string",
  • "copied_from": "string",
  • "status": "NEW",
  • "comment": "string",
  • "candidate_simulations": [
    ],
  • "actor": {
    },
  • "partners": [
    ],
  • "project": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

notaire

Calcule les frais de notaires

Calcule les frais de notaires

Calcule les frais de notaires

Authorizations:
toaztr_auth
Request Body schema: application/json
state
required
string (NotaryFeesState)
Enum: "OLD" "NEW" "LAND"

Etat de l'acquisition, au sens des frais de notaire.

department
string

Département de l'acquisition (laisser vide si le département est inconnu).

price
required
number >= 0

Prix du bien à acquérir.

Responses

Request samples

Content type
application/json
{
  • "state": "OLD",
  • "department": "string",
  • "price": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

impots

Calcule le montant d'imposition

Calcule le montant d'impôts

Calcule le montant d'impôts

Authorizations:
toaztr_auth
Request Body schema: application/json
fiscal_reference_revenue
number >= 0

Revenue fiscal de référence (fiscal_reference_revenue et net_monthly_revenue sont exclusifs).

net_monthly_revenue
number >= 0

Revenue mensuel net (fiscal_reference_revenue et net_monthly_revenue sont exclusifs).

children_in_charge
integer >= 0
Default: 0

Nombre d'enfant(s) à charge.

marital_status
string (MaritalStatus)
Enum: "MARRIED" "SINGLE" "SEPARATED" "WIDOWER" "DIVORCED" "DIVORCE_ONGOING" "PACSED" "LIVING_TOGETHER"

Statut marital

apply_ten_percent_discount
boolean
Default: false

Application (ou pas) des 10% de déduction forfaitaire pour frais réels.

Responses

Request samples

Content type
application/json
{
  • "fiscal_reference_revenue": 0,
  • "net_monthly_revenue": 0,
  • "children_in_charge": 0,
  • "marital_status": "MARRIED",
  • "apply_ten_percent_discount": false
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Assurance vie

Simulation d'un contrat d'assurance vie

Simule un contrat d'assurance vie

Simule un contrat d'assurance vie

Authorizations:
toaztr_auth
Request Body schema: application/json
mode
required
string
Enum: "FINAL_CAPITAL" "INITIAL_CAPITAL" "MONTHLY_PAYMENT" "YEARLY_AVERAGE_PERFORMANCE"

Mode de simulation: grandeur recherchée

required
object
required
Array of objects (LifeInsuranceInstallmentItem)

Liste des versements, incluant le versement initial

Array of objects (LifeInsurancePurchaseItem)

Liste des rachats

Array of objects (LifeInsuranceAdvanceItem)

Liste des avances

Array of objects (LifeInsuranceAdjudicationItem)

Liste des arbitrages

object

Frais sur les opérations du contrat d'assurance vie: versement initial, persement ponctuel, versement régulier, rachat, avance, arbitrage et gestion (du fond euro et UC).

object

Performance annuelle brute de frais de gestion des fonds euro et non euro. Le nombre d'élèments doit correspondre à la durée du contrat, soit le nombre d'années entre les paramètres subscription_date et horizon_date.

object

Impositions des plus-values

Responses

Request samples

Content type
application/json
{
  • "mode": "FINAL_CAPITAL",
  • "contract_parameters": {
    },
  • "installments": [
    ],
  • "purchases": [
    ],
  • "advances": [
    ],
  • "adjudications": [
    ],
  • "fees": {
    },
  • "funds_yearly_performances": {
    },
  • "taxes": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

souscription

Gestion des souscriptions

Ouvre une session de checkout

Checkout une nouvelle souscription

Authorizations:
toaztr_auth
Request Body schema: application/json
success_url
required
string

URL de retour en cas de succès du checkout.

cancel_url
required
string

URL de retour en cas d'échec du checkout.

type
required
string (SubscriptionType)
Enum: "SOLO" "TEAM" "ENTERPRISE" "START" "PROPULSION"

Type de souscription.

Responses

Request samples

Content type
application/json
{
  • "success_url": "string",
  • "cancel_url": "string",
  • "type": "SOLO"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les souscriptions

Liste les souscriptions

Authorizations:
toaztr_auth
query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne une souscription par ID

Retourne une souscription par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Ouvre une session de management de souscription

Manage une souscription

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

Request Body schema: application/json
return_url
required
string

URL de retour.

Responses

Request samples

Content type
application/json
{
  • "return_url": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mets à jour le nom d'une souscription

Mets à jour le nom d'une souscription

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
name
required
string

Nom de la resource.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Crée un item de souscription

Crée un item de souscription

Authorizations:
toaztr_auth
path Parameters
subscriptionId
required
string

ID de la souscription parente

Request Body schema: application/json
type
required
string
Enum: "APIKEY" "APP" "USER" "TEAM"

Type d'item.

ref
required
string

Reference de l'item.

name
string

Nom de l'item.

Responses

Request samples

Content type
application/json
{
  • "type": "APIKEY",
  • "ref": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les items de souscription

Liste les items de souscription

Authorizations:
toaztr_auth
path Parameters
subscriptionId
required
string

ID de la souscription parente

query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne un item de souscription par ID

Retourne un item de souscription par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

subscriptionId
required
string

ID de la souscription parente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime un item de souscription par ID

Supprime un item de souscription par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

subscriptionId
required
string

ID de la souscription parente

header Parameters
If-Match
string

ETag de la ressource

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Mets à jour le nom d'un item de souscription

Mets à jour le nom d'un item de souscription

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

subscriptionId
required
string

ID de la souscription parente

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
name
required
string

Nom de la resource.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

invitation

Gestion des invitations aux souscriptions

Crée une invitation à une souscription

Crée une invitation à une souscription

Authorizations:
toaztr_auth
path Parameters
subscriptionId
required
string

ID de la souscription parente

Request Body schema: application/json
name
string

Nom de l'invitation.

hash
required
string

Hash de l'invitation.

expiry_date
string <date-time>

Date d'expiration.

quantity
integer >= 1
Default: 1

Nombre d'utilisation maximum du code.

used
integer >= 0
Default: 0

Nombre d'utilisation actuelle du code.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hash": "string",
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "used": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les invitations à la souscription

Liste les invitations à la souscription

Authorizations:
toaztr_auth
path Parameters
subscriptionId
required
string

ID de la souscription parente

query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

Retourne une invitation à la souscription par ID

Retourne une invitation à la souscription par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

subscriptionId
required
string

ID de la souscription parente

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Mets à jour une invitation à une souscription par ID

Mets à jour une invitation à une subscription par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

subscriptionId
required
string

ID de la souscription parente

header Parameters
If-Match
string

ETag de la ressource

Request Body schema: application/json
name
string

Nom de l'invitation.

hash
required
string

Hash de l'invitation.

expiry_date
string <date-time>

Date d'expiration.

quantity
integer >= 1
Default: 1

Nombre d'utilisation maximum du code.

used
integer >= 0
Default: 0

Nombre d'utilisation actuelle du code.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "hash": "string",
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "quantity": 1,
  • "used": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime une invitation à une souscription par ID

Supprime une invitation à une souscription par ID

Authorizations:
toaztr_auth
path Parameters
id
required
string

ID unique de la ressource

subscriptionId
required
string

ID de la souscription parente

header Parameters
If-Match
string

ETag de la ressource

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Utilise une invitation

Utilise une invitation

Authorizations:
toaztr_auth
Request Body schema: application/json
token
required
string

Invitation à utiliser.

Responses

Request samples

Content type
application/json
{
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

license

Informations sur la license courante

Retourne la license en cours de l'utilisateur

Retourne la license en cours de l'utilisateur

Authorizations:
toaztr_auth

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Supprime la license en cours de l'utilisateur

Supprime la license en cours de l'utilisateur

Authorizations:
toaztr_auth

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Mets à jour le nom d'une license

Mets à jour le nom d'une license

Authorizations:
toaztr_auth
Request Body schema: application/json
name
required
string

Nom de la resource.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Liste les membres associés à la license de l'utilisateur

Liste les membres associés à la license de l'utilisateur

Authorizations:
toaztr_auth
query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

trace

Accès aux requêtes associées d'une souscription

Liste les requêtes associées à la souscription

Liste les requêtes associées à la souscription

Authorizations:
toaztr_auth
path Parameters
subscriptionId
required
string

ID de la souscription parente

query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}

utilisation

Accès aux enregistrements de l'utilistaion d'une souscription

Liste les enregistrements de l'utilisation d'une souscription

Liste les enregistrements de l'utilisation d'une souscription

Authorizations:
toaztr_auth
path Parameters
subscriptionId
required
string

ID de la souscription parente

query Parameters
page[size]
number [ 0 .. 100 ]
Default: 10

Taille de la page à retourner

page[cursor]
string

Curseur à partir duquel la prochaine page débute

ordering
string
Default: "desc"
Enum: "asc" "desc"

Sens de parcours de la liste

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "links": {
    },
  • "data": [
    ]
}