# Bienvenue Chez Abby, notre mission est de simplifier la vie des entrepreneurs individuels. Nous fournissons une solution intuitive pour gérer leur activité, depuis la facturation jusqu’à la comptabilité. Vous trouverez ici la documentation de l’API Abby et de son intégration avec Make. Que vous soyez développeur, utilisateur no-code ou expert en automatisation, elle est conçue pour vous accompagner dans vos projets, qu’il s’agisse de connecter Abby à d’autres applications ou même de créer une toute nouvelle application exploitant les outils puissants qu’Abby met à votre disposition.
Sans codeConnectez vos outils sans coder/files/s4iKWBUmf6ikwpLa2ApH/pages/wmfoJifHsJBJTPcqxskD
Pour les développeursApprenez à utiliser notre API/files/brkUB2Kki7jHSDk838Dx/pages/vtNnYSj4zHB8HLpRfxhK
# Démarrer avec Make Grâce à l'intégration Make sur Abby, vous pouvez mettre en place très rapidement des automatisations. Par exemple : * Synchroniser vos contacts Gmail et Abby. * Générer automatiquement une facture dans Abby chaque fois qu'un client achète un produit sur votre boutique Shopify. * Créer une tâche dans Abby quand vous receçez un email. Ces automatisations vous permettent de gagner un temps précieux et de gérer vos activités en toute simplicité ! ### Connecter Make avec Abby 1. Se rendre sur [Make](https://www.make.com/en/login) et créer un compte. 2. Créer un scénario. 3. Ajouter une action ou un déclencheur Abby. ![Ajouter une action depuis l'application Abby Make](https://i.gyazo.com/7e7b7b85c08b36b737a54d3f6d64fcfe.gif) 3\. Autoriser make à accéder à votre compte Abby ![Autoriser Make depuis Abby](/files/WLiKjsXpbenFVeGT7GGs) Et voilà, **Make** à accès à votre compte **Abby** et vous pouvez commencer à créer des automatisations :tada: Vous pouvez également explorer les actions et les déclencheurs que propose Abby. {% content-ref url="/pages/EsJHT0nefP8H4eT4qTqf" %} [Actions](/sans-code/actions) {% endcontent-ref %} {% content-ref url="/pages/7X1mTNvoFmTjFJEkqUZm" %} [Déclencheurs](/sans-code/declencheurs) {% endcontent-ref %} ### Révoquer Make depuis Abby Si vous souhaitez déconnecter Make d'Abby. 1. Rendez-vous dans la page de paramètres d'[intégration](https://my.app-abby.com/settings/integrations). 2. Déconnectez l'application Make. ![Révoquer l'accès Make à votre compte Abby](/files/0P744nOE6UroOF9FnzNZ) **Make** n'a plus accès à **Abby** et, par conséquent, ne pourra plus faire fonctionner les automatisations que vous avez configurées. # Générer une facture La génération de factures avec Make s'effectue en plusieurs actions / étapes.

Les actions doivent se suivre et être connectées ainsi

{% stepper %} {% step %} **"Récupérer mes contacts / organisations"** Utilisez une de ces deux actions pour récupérer vos contacts, cela enverra un ou plusieurs contacts au prochain module et vous permettra de les utiliser sur votre document. Utilisez les filtres pour préciser la recherche ou cibler un contact en particulier.
{% endstep %} {% step %} **"Créer une facture en brouillon"** Connectez ce module au précédent et renseignez le contact que vous souhaitez facturer dans le champ "Identifiant du contact ou de l'organisation". {% hint style="info" %} Cette action génère un ID de facture unique qu'il faudra ensuite utiliser dans les étapes suivantes. {% endhint %} {% endstep %} {% step %} **"Récupérer mes produits"** *(facultatif)* {% hint style="info" %} Cette étape et d'autres suivantes sont optionnelles. Vous pouvez vous en passer si vous préférez utiliser les informations générales par défaut de votre compte Abby. {% endhint %} Si vous souhaitez ajouter des articles présents dans votre bibliothèque d'articles, utilisez cette action pour les chercher, les récupérer et les renseigner sur votre facture. Vous pouvez vous passer de ce module si vous préférez ajouter des articles manuellement dans votre document. {% endstep %} {% step %} **"Ajouter des lignes à une facture"** Cette action vous permet de renseigner les différentes marchandises et services que vous souhaitez faire apparaître sur votre facture. Utilisez les données récupérées précédemment grâce à l'action "Récupérer mes produits" ou ajoutez des produits manuellement si vous n'avez pas besoin d'un remplissage dynamique. {% endstep %} {% step %} **"Modifier les informations générales d'une facture"** *(facultatif)* Utilisez cette action pour définir les informations générales du document tel que les moyens de paiement acceptés, la note d'en-tête, de bas de page ou les conditions générales de vente. {% endstep %} {% step %} **"Mettre à jour les informations temporelles d'une facture"** *(facultatif)* Avec cette action, définissez la date d'émission, le délai de paiement et la date d'échéance. {% endstep %} {% step %} **"Finaliser une facture"** Bravo ! C'est la dernière action à ajouter, elle permet de finaliser la facture et d'y assigner sa numérotation. {% hint style="warning" %} Prenez garde lors de vos essais, une facture finalisée ne peut pas être supprimée. Toute erreur devra être annulée avec un avoir. {% endhint %} {% endstep %} {% endstepper %} # Actions Un module d'action exécute une opération sur Abby, comme créer un client ou modifier une tâche. Trouvez ci-dessous l'ensemble des actions disponibles dans Make pour interagir avec Abby. {% hint style="info" %} L'action dont vous avez besoin n'existe pas encore ? [Proposez-la à la communauté](https://ideas.abby.fr/b/8my55807/feature-ideas). L'équipe Abby étudie vos demandes quotidiennement et la rendra disponible si elle est populaire ! {% endhint %} ## Facturation ### Contacts * **Création** * Créer un nouveau contact * Créer une nouvelle organisation * Créer un nouveau contact d'organisation * **Recherche** * Récupérer mes contacts * Récupérer mes organisations ### Articles * **Créer un produit** * **Récupérer mes produits** ### Documents * Créer une facture en brouillon * Ajouter un ligne à une facture * Modifier les informations générales d'une facture * Mettre à jour les informations temporelles d'une facture * Finaliser une facture * Marquer une facture comme payée ## Comptabilité ### Livre des recettes * Créer une entrée dans le livre de recettes ## Productivité ### Projets * Créer un projet ### Projets * Créer une tâche # Déclencheurs Un déclencheur commence à exécuter un scénario immédiatement après qu'une application ou un service donné ait envoyé des informations à Make sur un événement qui s'est produit. ![Exemple de déclencheur (un message est créé sur Slack quand l'utilisateur reçoit un message sur son téléphone).](/files/Pi5A9FneBfmJRmJRbXWn) ## Déclencheur Abby 1. Ajoutez le module "Nouvel évènement" dans votre scénario ![](/files/de8LwQEmu5m3a9VwK9pM) 2\. Cliquez sur "Add" puis sélectionnez un évènement dans la liste déroulante.
3\. Connectez votre évènement à une autre action ![Envoyer un e-mail avec Gmail lorsqu'un évènement Abby survient](/files/pA3ITp0LkyQoh5a2byg9) ### Liste des évènements
Projet créé ```json { "location": { "address": "string", "additionalAddress": "string", "zipCode": "string", "city": "string", "country": "string" }, "client": [ { "email": "string", "firstname": "string", "lastname": "string", "role": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } ], "customerCompany": { "name": "string", "vatNumber": "string", "siren": "string", "siret": "string", "nafCode": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } } ```
Projet modifié ```json { "location": { "address": "string", "additionalAddress": "string", "zipCode": "string", "city": "string", "country": "string" }, "client": [ { "email": "string", "firstname": "string", "lastname": "string", "role": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } ], "customerCompany": { "name": "string", "vatNumber": "string", "siren": "string", "siret": "string", "nafCode": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } } ```
Projet supprimé ```json { "location": { "address": "string", "additionalAddress": "string", "zipCode": "string", "city": "string", "country": "string" }, "client": [ { "email": "string", "firstname": "string", "lastname": "string", "role": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } ], "customerCompany": { "name": "string", "vatNumber": "string", "siren": "string", "siret": "string", "nafCode": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } } ```
Tâche créée ```json { "location": { "address": "string", "additionalAddress": "string", "zipCode": "string", "city": "string", "country": "string" }, "client": [ { "email": "string", "firstname": "string", "lastname": "string", "role": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } ], "customerCompany": { "name": "string", "vatNumber": "string", "siren": "string", "siret": "string", "nafCode": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } } ```
Tâche modifié ```json { "location": { "address": "string", "additionalAddress": "string", "zipCode": "string", "city": "string", "country": "string" }, "client": [ { "email": "string", "firstname": "string", "lastname": "string", "role": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } ], "customerCompany": { "name": "string", "vatNumber": "string", "siren": "string", "siret": "string", "nafCode": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } } ```
Tache supprimée ```json { "location": { "address": "string", "additionalAddress": "string", "zipCode": "string", "city": "string", "country": "string" }, "client": [ { "email": "string", "firstname": "string", "lastname": "string", "role": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } ], "customerCompany": { "name": "string", "vatNumber": "string", "siren": "string", "siret": "string", "nafCode": "string", "language": "string", "website": "string", "phone": "string", "keywords": "string", "notes": "string" } } ```
# Authentification L'API d'Abby utilise des clés d'authentification pour vérifier les requêtes. Vous pouvez consulter et gérer vos clés depuis les paramètres de votre compte. Vos clés disposent de nombreux droits, veillez à les conserver en sécurité. Évitez de publier votre clé API sur des plateformes publiques comme Github ou côté client. {% hint style="warning" %} Toutes les requêtes doivent être faites en [HTTPS](https://fr.wikipedia.org/wiki/HTTPS). Les appels en HTTP seront rejetés. Les appels sans authentification seront également rejetés. {% endhint %} {% hint style="info" %} **URL:** {% endhint %} ## Créer une clé API Allez sur la page "[integrations](https://my.app-abby.com/settings/integrations)" afin de créer une clé API qui sera associée à votre compte Abby. ![](/files/FAbjKlrVAz6otz7Nk0wN) Depuis la pop-up, vous pouvez définir un nom à votre clé API.
Vous ne pourrez pas modifier le nom de la clé après l'avoir créée
Lorsque vous créez votre clé d'API, Abby vous permet de la copier. Copiez-la et conservez-la avec soin. ![Une nouvelle clé API rien que pour vous](/files/0FyV38uKlMi1WYGeEQnn) Si vous égarez votre clé secrète, vous ne pourrez plus y accéder dans le Dashboard. Vous devrez alors remplacer la clé ou en générer une nouvelle. #### Échanger des clés Si vous perdez votre clé API secrète en production, vous ne pouvez pas la récupérer auprès d'Abby. Vous devez la révoquer pour bloquer toute utilisation. Suivez les étapes pour révoquer votre clé et en générer une nouvelle. 1. Allez sur la page "[integrations](https://my.app-abby.com/settings/integrations)" 2. Révoquez votre ancienne clé API ![](/files/DOwGjMRPBZqvbJXyoW98) 4\. Créer une nouvelle clé API ## Utilisation de l'API Pour utiliser votre clé API avec l'authentification Bearer, assurez-vous de l'inclure dans le header `Authorization` de vos requêtes HTTP. Voici un exemple d'utilisation : * **Base URL** : `https://api.app-abby.com` * **Header Authorization** : `Bearer suk-*****` **Exemple de requête HTTP avec la clé API :** ```http GET /endpoint Host: api.app-abby.com Authorization: Bearer suk-***** ``` # Clients Nous gérons deux types de clients : * Clients particuliers (contact) * Clients professionnels (ou entreprise) Les entreprises peuvent avoir différents contacts pour gérer divers services ou fonctions au sein d'une même entreprise. ## Clients professionnels ## POST /organization > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateOrganizationDto":{"type":"object","properties":{"name":{"type":"string","description":"The official name of the organization"},"commercialName":{"type":"string","description":"The commercial or trading name of the organization"},"emails":{"type":"array","items":{"type":"string"}},"siret":{"type":"string","description":"The SIRET number (required for French organizations)"},"vatNumber":{"type":"string","description":"The VAT number of the organization"},"billingAddress":{"description":"The billing address of the organization","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"deliveryAddress":{"description":"The delivery address of the organization","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"notes":{"type":"string","description":"Additional notes about the organization"},"bankInformations":{"description":"The bank information of the organization","allOf":[{"$ref":"#/components/schemas/BankInformationsDto"}]},"preferences":{"description":"The preferences of the organization","allOf":[{"$ref":"#/components/schemas/ClientPreferencesDto"}]}},"required":["name"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]},"ClientPreferencesDto":{"type":"object","properties":{"language":{"description":"The client's preferred language for billing","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"The client's preferred currency for transactions","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"The client's preferred payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}}},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"ReadOrganizationDto":{"type":"object","properties":{"language":{"description":"The client's preferred language for billing","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"The client's preferred currency for transactions","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"The client's preferred payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}},"id":{"type":"string"},"name":{"type":"string"},"commercialName":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"siret":{"type":"string"},"vatNumber":{"type":"string"},"countContacts":{"type":"number"},"billingAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"deliveryAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"bankInformations":{"$ref":"#/components/schemas/BankInformationsDto"},"notes":{"type":"string"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean"},"test":{"type":"boolean"}},"required":["id","name","commercialName","emails","siret","vatNumber","countContacts","billingAddress","deliveryAddress","bankInformations","notes","createdAt","archivedAt","hasBillings","test"]}}},"paths":{"/organization":{"post":{"operationId":"OrganizationController_createOrganization","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadOrganizationDto"}}}}},"tags":["organization"]}}}} ``` ## PUT /organization/{id} > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateOrganizationDto":{"type":"object","properties":{"name":{"type":"string"},"commercialName":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"siret":{"type":"string"},"vatNumber":{"type":"string"},"billingAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"deliveryAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"bankInformations":{"$ref":"#/components/schemas/BankInformationsDto"},"notes":{"type":"string"},"preferences":{"$ref":"#/components/schemas/ClientPreferencesDto"}},"required":["name"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]},"ClientPreferencesDto":{"type":"object","properties":{"language":{"description":"The client's preferred language for billing","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"The client's preferred currency for transactions","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"The client's preferred payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}}},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"ReadOrganizationDto":{"type":"object","properties":{"language":{"description":"The client's preferred language for billing","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"The client's preferred currency for transactions","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"The client's preferred payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}},"id":{"type":"string"},"name":{"type":"string"},"commercialName":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"siret":{"type":"string"},"vatNumber":{"type":"string"},"countContacts":{"type":"number"},"billingAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"deliveryAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"bankInformations":{"$ref":"#/components/schemas/BankInformationsDto"},"notes":{"type":"string"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean"},"test":{"type":"boolean"}},"required":["id","name","commercialName","emails","siret","vatNumber","countContacts","billingAddress","deliveryAddress","bankInformations","notes","createdAt","archivedAt","hasBillings","test"]}}},"paths":{"/organization/{id}":{"put":{"operationId":"OrganizationController_updateOrganization","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganizationDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadOrganizationDto"}}}}},"tags":["organization"]}}}} ``` ## GET /organizations > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"OrganizationOrderBy":{"type":"string","enum":["name","createdAt"]},"OrderDirection":{"type":"string","enum":["ASC","DESC"]},"ReadOrganizationsDto":{"type":"object","properties":{"countWithoutFilters":{"type":"number"},"totalDocs":{"type":"number"},"limit":{"type":"number"},"totalPages":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"},"nextPage":{"type":"number"},"page":{"type":"number"},"prevPage":{"type":"number"},"docs":{"type":"array","items":{"$ref":"#/components/schemas/ReadOrganizationDto"}}},"required":["countWithoutFilters","totalDocs","limit","totalPages","hasNextPage","hasPrevPage","nextPage","page","prevPage","docs"]},"ReadOrganizationDto":{"type":"object","properties":{"language":{"description":"The client's preferred language for billing","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"The client's preferred currency for transactions","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"The client's preferred payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}},"id":{"type":"string"},"name":{"type":"string"},"commercialName":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"siret":{"type":"string"},"vatNumber":{"type":"string"},"countContacts":{"type":"number"},"billingAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"deliveryAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"bankInformations":{"$ref":"#/components/schemas/BankInformationsDto"},"notes":{"type":"string"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean"},"test":{"type":"boolean"}},"required":["id","name","commercialName","emails","siret","vatNumber","countContacts","billingAddress","deliveryAddress","bankInformations","notes","createdAt","archivedAt","hasBillings","test"]},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]}}},"paths":{"/organizations":{"get":{"operationId":"OrganizationsController_retrieveOrganizations","parameters":[{"name":"page","required":true,"in":"query","schema":{"type":"number"}},{"name":"limit","required":true,"in":"query","schema":{"type":"number"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"orderBy","required":false,"in":"query","schema":{"$ref":"#/components/schemas/OrganizationOrderBy"}},{"name":"orderDirection","required":false,"in":"query","schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"archived","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadOrganizationsDto"}}}}},"tags":["organization"]}}}} ``` ## DELETE /organization/{organizationId} > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/organization/{organizationId}":{"delete":{"operationId":"OrganizationController_deleteOrganization","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["organization"]}}}} ``` ## Clients particuliers Dans le cas où vous souhaitez enregister un client particulier, vous pouvez créer un contact. ## POST /contact > Create a new contact ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateContactDto":{"type":"object","properties":{"firstname":{"type":"string","description":"The first name of the contact"},"lastname":{"type":"string","description":"The last name of the contact"},"phone":{"type":"string","description":"The phone number of the contact"},"jobTitle":{"type":"string","description":"The job title of the contact"},"emails":{"description":"The email addresses of the contact","type":"array","items":{"type":"string"}},"notes":{"type":"string","description":"Additional notes about the contact"},"billingAddress":{"description":"The billing address of the contact","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"deliveryAddress":{"description":"The delivery address of the contact","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"bankInformations":{"description":"The bank information of the contact","allOf":[{"$ref":"#/components/schemas/BankInformationsDto"}]},"preferences":{"description":"The preferences of the contact","allOf":[{"$ref":"#/components/schemas/ClientPreferencesDto"}]}},"required":["firstname","lastname"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]},"ClientPreferencesDto":{"type":"object","properties":{"language":{"description":"The client's preferred language for billing","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"The client's preferred currency for transactions","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"The client's preferred payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}}},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"ReadContactDto":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID"},"emails":{"description":"Contact email addresses","type":"array","items":{"type":"string"}},"organization":{"description":"Organization information","allOf":[{"$ref":"#/components/schemas/ContactOrganizationDto"}]},"defaultContact":{"type":"boolean","description":"Whether this is the default contact"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean","description":"Whether the contact has billings"},"test":{"type":"boolean","description":"Whether this is a test contact"},"phone":{"type":"string","description":"Contact phone number"},"firstname":{"type":"string","description":"Contact first name"},"lastname":{"type":"string","description":"Contact last name"},"billingAddress":{"description":"Billing address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"deliveryAddress":{"description":"Delivery address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"jobTitle":{"type":"string","description":"Contact job title"},"bankInformations":{"description":"Bank information","allOf":[{"$ref":"#/components/schemas/BankInformationsDto"}]},"hasTiersPrestation":{"type":"boolean","description":"Whether the contact has third-party services"},"notes":{"type":"string","description":"Additional notes about the contact"},"language":{"description":"Contact language preference","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"Preferred currency","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"Accepted payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"required":["id","createdAt","hasBillings","test","firstname","lastname","hasTiersPrestation"]},"ContactOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"archivedAt":{"type":"number","description":"Organization archival timestamp"}},"required":["id","name"]}}},"paths":{"/contact":{"post":{"operationId":"ContactController_createContact","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactDto"}}}},"responses":{"201":{"description":"The contact has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadContactDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"summary":"Create a new contact","tags":["contact"]}}}} ``` ## Retrieve contacts > Get a paginated list of contacts for the current company ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ContactOrderBy":{"type":"string","enum":["name","createdAt"]},"OrderDirection":{"type":"string","enum":["ASC","DESC"]},"ReadContactsDto":{"type":"object","properties":{"countWithoutFilters":{"type":"number"},"totalDocs":{"type":"number"},"limit":{"type":"number"},"totalPages":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"},"nextPage":{"type":"number"},"page":{"type":"number"},"prevPage":{"type":"number"},"docs":{"type":"array","items":{"$ref":"#/components/schemas/ReadContactListItemDto"}}},"required":["countWithoutFilters","totalDocs","limit","totalPages","hasNextPage","hasPrevPage","nextPage","page","prevPage","docs"]},"ReadContactListItemDto":{"type":"object","properties":{"archivedAt":{"type":"number","description":"Contact archival timestamp"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"test":{"type":"boolean","description":"Whether this is a test contact"},"defaultContact":{"type":"boolean","description":"Whether this is the default contact"},"emails":{"description":"Contact email addresses","type":"array","items":{"type":"string"}},"hasBillings":{"type":"boolean","description":"Whether the contact has billings"},"id":{"type":"string","description":"Contact ID"},"fullname":{"type":"string","description":"Contact full name"},"organization":{"description":"Organization information","allOf":[{"$ref":"#/components/schemas/ContactListOrganizationDto"}]},"tiersPrestation":{"description":"Third-party service information","allOf":[{"$ref":"#/components/schemas/TiersPrestationDto"}]}},"required":["createdAt","test","hasBillings","id","fullname"]},"ContactListOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"archivedAt":{"type":"number","description":"Organization archival timestamp"}},"required":["id","name"]},"TiersPrestationDto":{"type":"object","properties":{"state":{"description":"Client state","allOf":[{"$ref":"#/components/schemas/ClientState"}]}},"required":["state"]},"ClientState":{"type":"string","enum":["synced","pending","end_user_action_required","error"],"description":"Current client state"}}},"paths":{"/contacts":{"get":{"description":"Get a paginated list of contacts for the current company","operationId":"ContactsController_retrieveContacts","parameters":[{"name":"page","required":false,"in":"query","schema":{"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"type":"number"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"orderBy","required":false,"in":"query","schema":{"$ref":"#/components/schemas/ContactOrderBy"}},{"name":"orderDirection","required":false,"in":"query","schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"archived","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"forCertificate","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved contacts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadContactsDto"}}}},"401":{"description":""},"500":{"description":""}},"summary":"Retrieve contacts","tags":["contact"]}}}} ``` ## GET /contact/{id} > Get a contact by ID ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadContactDto":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID"},"emails":{"description":"Contact email addresses","type":"array","items":{"type":"string"}},"organization":{"description":"Organization information","allOf":[{"$ref":"#/components/schemas/ContactOrganizationDto"}]},"defaultContact":{"type":"boolean","description":"Whether this is the default contact"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean","description":"Whether the contact has billings"},"test":{"type":"boolean","description":"Whether this is a test contact"},"phone":{"type":"string","description":"Contact phone number"},"firstname":{"type":"string","description":"Contact first name"},"lastname":{"type":"string","description":"Contact last name"},"billingAddress":{"description":"Billing address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"deliveryAddress":{"description":"Delivery address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"jobTitle":{"type":"string","description":"Contact job title"},"bankInformations":{"description":"Bank information","allOf":[{"$ref":"#/components/schemas/BankInformationsDto"}]},"hasTiersPrestation":{"type":"boolean","description":"Whether the contact has third-party services"},"notes":{"type":"string","description":"Additional notes about the contact"},"language":{"description":"Contact language preference","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"Preferred currency","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"Accepted payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"required":["id","createdAt","hasBillings","test","firstname","lastname","hasTiersPrestation"]},"ContactOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"archivedAt":{"type":"number","description":"Organization archival timestamp"}},"required":["id","name"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]}}},"paths":{"/contact/{id}":{"get":{"operationId":"ContactController_getContact","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"The contact has been successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadContactDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Contact not found"}},"summary":"Get a contact by ID","tags":["contact"]}}}} ``` ## DELETE /contact/{id} > Delete a contact ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/contact/{id}":{"delete":{"operationId":"ContactController_deleteContact","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"401":{"description":"Unauthorized"},"404":{"description":"Contact not found"},"default":{"description":"The contact has been successfully deleted."}},"summary":"Delete a contact","tags":["contact"]}}}} ``` ## PUT /contact/{id} > Update a contact ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateContactDto":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"billingAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"deliveryAddress":{"$ref":"#/components/schemas/ClientAddressDto"},"bankInformations":{"$ref":"#/components/schemas/BankInformationsDto"},"preferences":{"$ref":"#/components/schemas/ClientPreferencesDto"}},"required":["firstname","lastname"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]},"ClientPreferencesDto":{"type":"object","properties":{"language":{"description":"The client's preferred language for billing","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"The client's preferred currency for transactions","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"The client's preferred payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}}},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"ReadContactDto":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID"},"emails":{"description":"Contact email addresses","type":"array","items":{"type":"string"}},"organization":{"description":"Organization information","allOf":[{"$ref":"#/components/schemas/ContactOrganizationDto"}]},"defaultContact":{"type":"boolean","description":"Whether this is the default contact"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean","description":"Whether the contact has billings"},"test":{"type":"boolean","description":"Whether this is a test contact"},"phone":{"type":"string","description":"Contact phone number"},"firstname":{"type":"string","description":"Contact first name"},"lastname":{"type":"string","description":"Contact last name"},"billingAddress":{"description":"Billing address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"deliveryAddress":{"description":"Delivery address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"jobTitle":{"type":"string","description":"Contact job title"},"bankInformations":{"description":"Bank information","allOf":[{"$ref":"#/components/schemas/BankInformationsDto"}]},"hasTiersPrestation":{"type":"boolean","description":"Whether the contact has third-party services"},"notes":{"type":"string","description":"Additional notes about the contact"},"language":{"description":"Contact language preference","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"Preferred currency","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"Accepted payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"required":["id","createdAt","hasBillings","test","firstname","lastname","hasTiersPrestation"]},"ContactOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"archivedAt":{"type":"number","description":"Organization archival timestamp"}},"required":["id","name"]}}},"paths":{"/contact/{id}":{"put":{"operationId":"ContactController_updateContact","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactDto"}}}},"responses":{"200":{"description":"The contact has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadContactDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Contact not found"}},"summary":"Update a contact","tags":["contact"]}}}} ``` ## Les contacts d'entreprise Pour une meilleure organisation, vous avez la possibilité d'enregistrer différents contacts affiliés à une entreprise spécifique. ## POST /organization/{id}/contact > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateOrganizationContactDto":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"notes":{"type":"string"}},"required":["firstname","lastname"]},"ReadContactDto":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID"},"emails":{"description":"Contact email addresses","type":"array","items":{"type":"string"}},"organization":{"description":"Organization information","allOf":[{"$ref":"#/components/schemas/ContactOrganizationDto"}]},"defaultContact":{"type":"boolean","description":"Whether this is the default contact"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean","description":"Whether the contact has billings"},"test":{"type":"boolean","description":"Whether this is a test contact"},"phone":{"type":"string","description":"Contact phone number"},"firstname":{"type":"string","description":"Contact first name"},"lastname":{"type":"string","description":"Contact last name"},"billingAddress":{"description":"Billing address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"deliveryAddress":{"description":"Delivery address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"jobTitle":{"type":"string","description":"Contact job title"},"bankInformations":{"description":"Bank information","allOf":[{"$ref":"#/components/schemas/BankInformationsDto"}]},"hasTiersPrestation":{"type":"boolean","description":"Whether the contact has third-party services"},"notes":{"type":"string","description":"Additional notes about the contact"},"language":{"description":"Contact language preference","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"Preferred currency","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"Accepted payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"required":["id","createdAt","hasBillings","test","firstname","lastname","hasTiersPrestation"]},"ContactOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"archivedAt":{"type":"number","description":"Organization archival timestamp"}},"required":["id","name"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]}}},"paths":{"/organization/{id}/contact":{"post":{"operationId":"OrganizationController_createOrganizationContact","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrganizationContactDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadContactDto"}}}}},"tags":["organization"]}}}} ``` ## PUT /organization/contact/{id} > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateOrganizationContactDto":{"type":"object","properties":{"firstname":{"type":"string"},"lastname":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}},"notes":{"type":"string"},"defaultContact":{"type":"boolean"}},"required":["firstname","lastname"]},"ReadContactDto":{"type":"object","properties":{"id":{"type":"string","description":"Contact ID"},"emails":{"description":"Contact email addresses","type":"array","items":{"type":"string"}},"organization":{"description":"Organization information","allOf":[{"$ref":"#/components/schemas/ContactOrganizationDto"}]},"defaultContact":{"type":"boolean","description":"Whether this is the default contact"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"archivedAt":{"type":"number","description":"Contact archival timestamp"},"hasBillings":{"type":"boolean","description":"Whether the contact has billings"},"test":{"type":"boolean","description":"Whether this is a test contact"},"phone":{"type":"string","description":"Contact phone number"},"firstname":{"type":"string","description":"Contact first name"},"lastname":{"type":"string","description":"Contact last name"},"billingAddress":{"description":"Billing address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"deliveryAddress":{"description":"Delivery address","allOf":[{"$ref":"#/components/schemas/ClientAddressDto"}]},"jobTitle":{"type":"string","description":"Contact job title"},"bankInformations":{"description":"Bank information","allOf":[{"$ref":"#/components/schemas/BankInformationsDto"}]},"hasTiersPrestation":{"type":"boolean","description":"Whether the contact has third-party services"},"notes":{"type":"string","description":"Additional notes about the contact"},"language":{"description":"Contact language preference","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"currency":{"description":"Preferred currency","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"paymentMethods":{"type":"array","description":"Accepted payment methods","items":{"$ref":"#/components/schemas/PaymentMethod"}}},"required":["id","createdAt","hasBillings","test","firstname","lastname","hasTiersPrestation"]},"ContactOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"archivedAt":{"type":"number","description":"Organization archival timestamp"}},"required":["id","name"]},"ClientAddressDto":{"type":"object","properties":{"address":{"type":"string","description":"The street address of the client","nullable":true},"complement":{"type":"string","description":"Additional address information","nullable":true},"city":{"type":"string","description":"The city of the address","nullable":true},"zipCode":{"type":"string","description":"The zip code or postal code of the address","nullable":true},"state":{"type":"string","description":"The state or province of the address"},"country":{"description":"The country of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["address","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BankInformationsDto":{"type":"object","properties":{"iban":{"type":"string","description":"International Bank Account Number"},"bic":{"type":"string","description":"Bank Identifier Code"},"holder":{"type":"string","description":"Name of the account holder"}},"required":["iban","bic","holder"]},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]}}},"paths":{"/organization/contact/{id}":{"put":{"operationId":"OrganizationController_updateOrganizationContact","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganizationContactDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadContactDto"}}}}},"tags":["organization"]}}}} ``` ## GET /organization/{id}/contacts > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadContactListItemDto":{"type":"object","properties":{"archivedAt":{"type":"number","description":"Contact archival timestamp"},"createdAt":{"type":"number","description":"Contact creation timestamp"},"test":{"type":"boolean","description":"Whether this is a test contact"},"defaultContact":{"type":"boolean","description":"Whether this is the default contact"},"emails":{"description":"Contact email addresses","type":"array","items":{"type":"string"}},"hasBillings":{"type":"boolean","description":"Whether the contact has billings"},"id":{"type":"string","description":"Contact ID"},"fullname":{"type":"string","description":"Contact full name"},"organization":{"description":"Organization information","allOf":[{"$ref":"#/components/schemas/ContactListOrganizationDto"}]},"tiersPrestation":{"description":"Third-party service information","allOf":[{"$ref":"#/components/schemas/TiersPrestationDto"}]}},"required":["createdAt","test","hasBillings","id","fullname"]},"ContactListOrganizationDto":{"type":"object","properties":{"id":{"type":"string","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"archivedAt":{"type":"number","description":"Organization archival timestamp"}},"required":["id","name"]},"TiersPrestationDto":{"type":"object","properties":{"state":{"description":"Client state","allOf":[{"$ref":"#/components/schemas/ClientState"}]}},"required":["state"]},"ClientState":{"type":"string","enum":["synced","pending","end_user_action_required","error"],"description":"Current client state"}}},"paths":{"/organization/{id}/contacts":{"get":{"operationId":"OrganizationController_retrieveOrganizationContacts","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ReadContactListItemDto"}}}}}},"tags":["organization"]}}}} ``` ## Changer le contact par défaut d'une entreprise ## PATCH /organization/{organizationId}/default-contact > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SetDefaultContactDto":{"type":"object","properties":{"defaultContactId":{"type":"string"}},"required":["defaultContactId"]}}},"paths":{"/organization/{organizationId}/default-contact":{"patch":{"operationId":"OrganizationController_setDefaultContact","parameters":[{"name":"organizationId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetDefaultContactDto"}}}},"responses":{"200":{"description":""}},"tags":["organization"]}}}} ``` # Factures Une facture est un document associé à un client, qui peut être un contact, une organisation ou un contact d'organisation. Ils contiennent des lignes de factures ainsi que des informations générales. Une facture créée est dans un état brouillon tant qu'elle n'a pas été finalisée. ## POST /v2/billing/invoice/{customerId} > Create a new invoice with a customerId that can be a contactId or an organizationId ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/invoice/{customerId}":{"post":{"operationId":"InvoiceController_createInvoiceByContactOrOrganizationId_v2","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"201":{"description":"Invoice created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadInvoiceDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"summary":"Create a new invoice with a customerId that can be a contactId or an organizationId","tags":["invoice"]}}}} ``` ## PATCH /v2/billing/{billingId}/lines > Update billing lines ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateBillingLinesDto":{"type":"object","properties":{"lines":{"description":"Array of billing lines, each representing a product or service","type":"array","items":{"$ref":"#/components/schemas/UpdateLineDto"}},"discount":{"description":"Optional discount to be applied to the entire billing","allOf":[{"$ref":"#/components/schemas/DiscountDto"}]}},"required":["lines"]},"UpdateLineDto":{"type":"object","properties":{"generatedId":{"type":"string","description":"Warning: Client-side generated line id. This field will be deprecated and will be removed in the future."},"productId":{"type":"string","description":"Unique identifier of the product, if applicable"},"unitPrice":{"type":"number","description":"Price per unit in cents (e.g., 1500 for 15.00 euros)"},"quantity":{"type":"number","description":"Quantity of the product or service"},"quantityUnit":{"description":"Unit of measurement for the quantity (e.g., UNIT, HOUR, KILOGRAM)","nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string","description":"Name or short description of the product or service"},"reference":{"type":"string","description":"Product reference or SKU, if applicable"},"description":{"type":"string","description":"Detailed description of the product or service"},"type":{"description":"Type of the product or service (e.g., SALE_OF_GOODS, SERVICE)","nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"description":"VAT code applicable to the product or service","allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"description":"Personal service activity only available for products compatible with the tax credit","allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"discount":{"description":"Optional discount to be applied to the billing line","allOf":[{"$ref":"#/components/schemas/DiscountDto"}]},"isDeliveryOfGoods":{"type":"boolean","description":"Mark a product line as delivery of goods to display it on document"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT). Requires the tax included unit price feature to be enabled.","default":false}},"required":["unitPrice","quantity","quantityUnit","designation","type","vatCode"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"DiscountMode":{"type":"number","enum":[1,2]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]}}},"paths":{"/v2/billing/{billingId}/lines":{"patch":{"operationId":"BillingController_updateLines_v2","parameters":[{"name":"billingId","required":true,"in":"path","description":"ID of the billing to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingLinesDto"}}}},"responses":{"200":{"description":"Billing lines updated successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadEstimateDto"},{"$ref":"#/components/schemas/ReadAssetDto"}]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Billing not found"}},"summary":"Update billing lines","tags":["Billing"]}}}} ``` ## The ReadInvoiceDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}}} ``` ## The ReadEstimateDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]}}}} ``` ## The ReadAssetDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}}} ``` ## PATCH /v2/billing/invoice/{invoiceId}/general-informations > Update invoice general informations ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateInvoiceGeneralInformationsDto":{"type":"object","properties":{"headerNote":{"type":"string","description":"Custom note to be displayed in the header of the billing"},"footerNote":{"type":"string","description":"Custom note to be displayed in the footer of the billing"},"generalTermsAndConditionsOfSale":{"type":"string","description":"General terms and conditions of sale to be included in the billing"},"mentionMediator":{"type":"string","description":"Mention mediateur to be included in the billing"},"paymentMethods":{"type":"array","description":"Array of accepted payment methods for the billing","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"},"vatMention":{"description":"Vat mention applicable for a billing","allOf":[{"$ref":"#/components/schemas/VatMention"}]},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"isOnlinePaymentActivated":{"type":"boolean","description":"Indicates if online payment is activated for this invoice"},"reminder":{"description":"Reminder settings for the invoice","allOf":[{"$ref":"#/components/schemas/BillingReminderDto"}]}}},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/invoice/{invoiceId}/general-informations":{"patch":{"operationId":"InvoiceController_updateInvoiceGeneralInformations_v2","parameters":[{"name":"invoiceId","required":true,"in":"path","description":"ID of the invoice to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInvoiceGeneralInformationsDto"}}}},"responses":{"200":{"description":"Invoice general informations updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadInvoiceDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Update invoice general informations","tags":["invoice"]}}}} ``` ## PATCH /v2/billing/invoice/{invoiceId}/timeline > Update invoice timeline ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateInvoiceTimelineDto":{"type":"object","properties":{"emittedAt":{"type":"number","description":"The timestamp when the invoice was emitted"},"paymentDelay":{"description":"The payment delay for the invoice","allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"customDueDate":{"type":"number","description":"Custom due date for the invoice when payment delay is OTHER"},"deliveryDate":{"type":"number","description":"The timestamp for delivery date","nullable":true}},"required":["emittedAt","paymentDelay"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/invoice/{invoiceId}/timeline":{"patch":{"operationId":"InvoiceController_updateTimeline_v2","parameters":[{"name":"invoiceId","required":true,"in":"path","description":"ID of the invoice to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInvoiceTimelineDto"}}}},"responses":{"200":{"description":"Invoice timeline updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadInvoiceDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Update invoice timeline","tags":["invoice"]}}}} ``` ## Finaliser une facture Une fois que la facture en brouillon est prête, vous pouvez finaliser le document. Une document finalisé ne peut-être modifié par la suite. Un numéro de facture lui sera attribué. > L'ancien endpoint `/v2/billing/invoice/{invoiceId}finalize` a été déprécié en faveur de celui-ci dessous ## PATCH /v2/billing/{billingId}/finalize > Finalize a billing document ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]}}},"paths":{"/v2/billing/{billingId}/finalize":{"patch":{"operationId":"BillingController_finalize_v2","parameters":[{"name":"billingId","required":true,"in":"path","description":"ID of the billing to finalize","schema":{"type":"string"}}],"responses":{"200":{"description":"Billing finalized successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadEstimateDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"},{"$ref":"#/components/schemas/ReadAssetDto"}]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Finalize a billing document","tags":["Billing"]}}}} ``` ## The ReadInvoiceDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}}} ``` ## The ReadEstimateDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]}}}} ``` ## The ReadAdvanceDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"DiscountMode":{"type":"number","enum":[1,2]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}}} ``` ## The ReadAssetDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}}} ``` ## Télécharger un document Vous pouvez télécharger un document en format PDF et spécifier la langue appliquée sur le document ## GET /v2/billing/{billingId}/download > Download a billing document ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]}}},"paths":{"/v2/billing/{billingId}/download":{"get":{"operationId":"BillingController_downloadPDF_v2","parameters":[{"name":"billingId","required":true,"in":"path","schema":{"type":"string"}},{"name":"locale","required":false,"in":"query","description":"Locale for the PDF generation","schema":{"$ref":"#/components/schemas/BillingLocale"}}],"responses":{"200":{"description":"","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Billing document not found"}},"summary":"Download a billing document","tags":["Billing"]}}}} ``` ## Marquer une facture comme payée Une fois une facture finalisée encaissée, vous pouvez la marquer comme payée en associant un ou plusieurs paiements. La somme des montants des paiements (en centimes) doit correspondre au montant restant à régler de la facture. ## Mark an invoice as paid > Associates one or more payments to a finalized invoice to record its cashing. The sum of payment amounts (in cents) must match the invoice's remaining amount with tax. Use this endpoint to mark an invoice as paid via the public API. ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]},{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReconciliateInvoiceDto":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/components/schemas/PaymentDto"}}},"required":["payments"]},"PaymentDto":{"type":"object","properties":{"amount":{"type":"number","description":"The amount of the payment in cents"},"receivedAt":{"type":"string","description":"The date of the payment"},"method":{"description":"The payment method used","allOf":[{"$ref":"#/components/schemas/PaymentMethod"}]},"otherMethod":{"type":"string","description":"The other payment method used"},"transactionId":{"type":"string","description":"The transaction id associated to the payment"},"regulations":{"$ref":"#/components/schemas/RegulationsDto"}},"required":["amount","receivedAt","method"]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"RegulationsDto":{"type":"object","properties":{"commission":{"type":"number"},"lossOfValueChangeRate":{"type":"number"}}}}},"paths":{"/v2/accounting-billing/invoice/{invoiceId}/reconciliate":{"post":{"description":"Associates one or more payments to a finalized invoice to record its cashing. The sum of payment amounts (in cents) must match the invoice's remaining amount with tax. Use this endpoint to mark an invoice as paid via the public API.","operationId":"AccountingBillingController_reconciliateInvoice_v2","parameters":[{"name":"invoiceId","required":true,"in":"path","description":"ID of the invoice to mark as paid","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReconciliateInvoiceDto"}}}},"responses":{"200":{"description":"Invoice marked as paid successfully"},"400":{"description":"Invalid payment amount or invoice not finalized"},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Mark an invoice as paid","tags":["Accounting billing-v2"]}}}} ``` ## Marquer une facture comme non payée Si une facture a été marquée comme payée par erreur, vous pouvez annuler cet état pour la repasser en non payée. Les paiements associés sont retirés. ## Mark an invoice as unpaid > Removes the payments associated to an invoice and resets its paid state. Use this endpoint to revert a previously paid invoice. ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]},{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/v2/accounting-billing/invoice/{invoiceId}/mark-as-unpaid":{"post":{"description":"Removes the payments associated to an invoice and resets its paid state. Use this endpoint to revert a previously paid invoice.","operationId":"AccountingBillingController_markInvoiceAsUnpaid_v2","parameters":[{"name":"invoiceId","required":true,"in":"path","description":"ID of the invoice to mark as unpaid","schema":{"type":"string"}}],"responses":{"200":{"description":"Invoice marked as unpaid successfully"},"400":{"description":"Invoice is not paid"},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Mark an invoice as unpaid","tags":["Accounting billing-v2"]}}}} ``` # Devis Un devis est un document associé à un client (contact, organisation ou contact d'organisation). Il contient des lignes ainsi que des informations générales. Le devis peut être de type `estimate` (devis) ou `purchase_order` (bon de commande). Un devis créé est dans un état brouillon tant qu'il n'a pas été finalisé. Une fois finalisé, il peut être signé/refusé par le client, et donner lieu à des acomptes ou à une facture finale. ## Créer un devis L'identifiant `customerId` peut correspondre à un `contactId` ou à un `organizationId`. Précisez `estimateType` pour créer un devis (`estimate`) ou un bon de commande (`purchase_order`). ## POST /v2/billing/estimate/{customerId} > Create a new estimate with a customerId that can be a contactId or an organizationId ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateEstimateByCustomerIdDto":{"type":"object","properties":{"estimateType":{"default":"estimate","allOf":[{"$ref":"#/components/schemas/EstimateType"}]}}},"EstimateType":{"type":"string","enum":["estimate","purchase_order"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{customerId}":{"post":{"operationId":"EstimateController_createEstimateByContactOrOrganizationId_v2","parameters":[{"name":"customerId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEstimateByCustomerIdDto"}}}},"responses":{"201":{"description":"Estimate created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"summary":"Create a new estimate with a customerId that can be a contactId or an organizationId","tags":["estimate"]}}}} ``` ## Mettre à jour les lignes du devis Les lignes d'un devis sont mises à jour via l'endpoint partagé de billing. ## PATCH /v2/billing/{billingId}/lines > Update billing lines ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateBillingLinesDto":{"type":"object","properties":{"lines":{"description":"Array of billing lines, each representing a product or service","type":"array","items":{"$ref":"#/components/schemas/UpdateLineDto"}},"discount":{"description":"Optional discount to be applied to the entire billing","allOf":[{"$ref":"#/components/schemas/DiscountDto"}]}},"required":["lines"]},"UpdateLineDto":{"type":"object","properties":{"generatedId":{"type":"string","description":"Warning: Client-side generated line id. This field will be deprecated and will be removed in the future."},"productId":{"type":"string","description":"Unique identifier of the product, if applicable"},"unitPrice":{"type":"number","description":"Price per unit in cents (e.g., 1500 for 15.00 euros)"},"quantity":{"type":"number","description":"Quantity of the product or service"},"quantityUnit":{"description":"Unit of measurement for the quantity (e.g., UNIT, HOUR, KILOGRAM)","nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string","description":"Name or short description of the product or service"},"reference":{"type":"string","description":"Product reference or SKU, if applicable"},"description":{"type":"string","description":"Detailed description of the product or service"},"type":{"description":"Type of the product or service (e.g., SALE_OF_GOODS, SERVICE)","nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"description":"VAT code applicable to the product or service","allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"description":"Personal service activity only available for products compatible with the tax credit","allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"discount":{"description":"Optional discount to be applied to the billing line","allOf":[{"$ref":"#/components/schemas/DiscountDto"}]},"isDeliveryOfGoods":{"type":"boolean","description":"Mark a product line as delivery of goods to display it on document"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT). Requires the tax included unit price feature to be enabled.","default":false}},"required":["unitPrice","quantity","quantityUnit","designation","type","vatCode"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"DiscountMode":{"type":"number","enum":[1,2]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]}}},"paths":{"/v2/billing/{billingId}/lines":{"patch":{"operationId":"BillingController_updateLines_v2","parameters":[{"name":"billingId","required":true,"in":"path","description":"ID of the billing to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingLinesDto"}}}},"responses":{"200":{"description":"Billing lines updated successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadEstimateDto"},{"$ref":"#/components/schemas/ReadAssetDto"}]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Billing not found"}},"summary":"Update billing lines","tags":["Billing"]}}}} ``` ## Mettre à jour les informations générales ## PATCH /v2/billing/estimate/{estimateId}/general-informations > Update estimate general informations ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateEstimateGeneralInformationsDto":{"type":"object","properties":{"headerNote":{"type":"string","description":"Custom note to be displayed in the header of the billing"},"footerNote":{"type":"string","description":"Custom note to be displayed in the footer of the billing"},"generalTermsAndConditionsOfSale":{"type":"string","description":"General terms and conditions of sale to be included in the billing"},"mentionMediator":{"type":"string","description":"Mention mediateur to be included in the billing"},"paymentMethods":{"type":"array","description":"Array of accepted payment methods for the billing","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"},"vatMention":{"description":"Vat mention applicable for a billing","allOf":[{"$ref":"#/components/schemas/VatMention"}]},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]}}},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/general-informations":{"patch":{"operationId":"EstimateController_updateGeneralInformations_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEstimateGeneralInformationsDto"}}}},"responses":{"200":{"description":"Estimate general informations updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Estimate not found"}},"summary":"Update estimate general informations","tags":["estimate"]}}}} ``` ## Mettre à jour la timeline (dates d'émission, expiration, etc.) ## PATCH /v2/billing/estimate/{estimateId}/timeline > Update estimate timeline ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateEstimateTimelineDto":{"type":"object","properties":{"emittedAt":{"type":"number","description":"The timestamp when the invoice was emitted"},"paymentDelay":{"description":"The payment delay for the invoice","allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"customDueDate":{"type":"number","description":"Custom due date for the invoice when payment delay is OTHER"},"deliveryDate":{"type":"number","description":"The timestamp for delivery date","nullable":true},"expiredAt":{"type":"number","description":"The timestamp when the estimate expired"}},"required":["emittedAt","paymentDelay","expiredAt"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/timeline":{"patch":{"operationId":"EstimateController_updateTimeline_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEstimateTimelineDto"}}}},"responses":{"200":{"description":"Estimate timeline updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Update estimate timeline","tags":["estimate"]}}}} ``` ## Mettre à jour la langue du devis ## PUT /v2/billing/estimate/{estimateId}/locale > Update estimate locale ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateBillingLocaleDto":{"type":"object","properties":{"locale":{"description":"The locale of the billing document","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]}},"required":["locale"]},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/locale":{"put":{"operationId":"EstimateController_updateLocale_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingLocaleDto"}}}},"responses":{"200":{"description":"Estimate locale updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Estimate not found"}},"summary":"Update estimate locale","tags":["estimate"]}}}} ``` ## Mettre à jour la devise du devis ## PUT /v2/billing/estimate/{estimateId}/currency > Update asset currency ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateBillingCurrencyDto":{"type":"object","properties":{"currency":{"description":"The currency which will be used with the billing","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyRate":{"type":"number","description":"The conversion rate from the billing currency to the new currency"}},"required":["currency"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/currency":{"put":{"operationId":"EstimateController_updateCurrency_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingCurrencyDto"}}}},"responses":{"200":{"description":"Asset currency updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Estimate not found"}},"summary":"Update asset currency","tags":["estimate"]}}}} ``` ## Configurer les acomptes (advance lines) Permet de définir la liste des acomptes (échéancier) attachés au devis. Chaque acompte sera matérialisable en facture d'acompte une fois le devis finalisé. ## PATCH /v2/billing/estimate/{estimateId}/advance-lines > Update estimate advance lines ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/AdvanceItemDto"}}},"required":["advances"]},"AdvanceItemDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/advance-lines":{"patch":{"operationId":"EstimateController_updateAdvanceLines_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEstimateAdvanceLinesDto"}}}},"responses":{"200":{"description":"Estimate advance lines updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"404":{"description":"Estimate not found"}},"summary":"Update estimate advance lines","tags":["estimate"]}}}} ``` ## The ReadEstimateDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]}}}} ``` ## The ReadAdvanceDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"DiscountMode":{"type":"number","enum":[1,2]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}}} ``` ## Finaliser un devis Une fois le devis prêt, finalisez-le pour lui attribuer un numéro officiel. Un devis finalisé ne peut plus être modifié. ## PATCH /v2/billing/{billingId}/finalize > Finalize a billing document ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]}}},"paths":{"/v2/billing/{billingId}/finalize":{"patch":{"operationId":"BillingController_finalize_v2","parameters":[{"name":"billingId","required":true,"in":"path","description":"ID of the billing to finalize","schema":{"type":"string"}}],"responses":{"200":{"description":"Billing finalized successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadEstimateDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"},{"$ref":"#/components/schemas/ReadAssetDto"}]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Finalize a billing document","tags":["Billing"]}}}} ``` ## Signer / Refuser un devis Une fois finalisé, un devis (ou bon de commande) peut être signé ou refusé par le client. Les opérations inverses (`unsign`, `unrefuse`) permettent de revenir en arrière. ### Signer ## PATCH /v2/billing/estimate/{estimateId}/sign > Sign estimate or purchase order ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/sign":{"patch":{"operationId":"EstimateController_sign_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate or purchase order to sign","schema":{"type":"string"}}],"responses":{"200":{"description":"Estimate or purchase order signed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Sign estimate or purchase order","tags":["estimate"]}}}} ``` ### Annuler la signature ## PATCH /v2/billing/estimate/{estimateId}/unsign > Unsign estimate or purchase order ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/unsign":{"patch":{"operationId":"EstimateController_unsign_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate or purchase order to unsign","schema":{"type":"string"}}],"responses":{"200":{"description":"Estimate or purchase order unsigned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Unsign estimate or purchase order","tags":["estimate"]}}}} ``` ### Refuser ## PATCH /v2/billing/estimate/{estimateId}/refuse > Refuse estimate or purchase order ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/refuse":{"patch":{"operationId":"EstimateController_refuse_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate or purchase order to refuse","schema":{"type":"string"}}],"responses":{"200":{"description":"Estimate or purchase order refused successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Refuse estimate or purchase order","tags":["estimate"]}}}} ``` ### Annuler le refus ## PATCH /v2/billing/estimate/{estimateId}/unrefuse > Unrefuse estimate or purchase order ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}},"paths":{"/v2/billing/estimate/{estimateId}/unrefuse":{"patch":{"operationId":"EstimateController_unrefuse_v2","parameters":[{"name":"estimateId","required":true,"in":"path","description":"ID of the estimate or purchase order to unrefuse","schema":{"type":"string"}}],"responses":{"200":{"description":"Estimate or purchase order unrefused successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadEstimateDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Unrefuse estimate or purchase order","tags":["estimate"]}}}} ``` ## Créer une facture d'acompte depuis un devis ## POST /v2/billing/estimate/{id}/advance > Create invoice advance ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"DiscountMode":{"type":"number","enum":[1,2]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]}}},"paths":{"/v2/billing/estimate/{id}/advance":{"post":{"operationId":"EstimateController_createAdvance_v2","parameters":[{"name":"id","required":true,"in":"path","description":"ID of the estimate to update","schema":{"type":"string"}}],"responses":{"200":{"description":"Invoice advance created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAdvanceDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Create invoice advance","tags":["estimate"]}}}} ``` ## The ReadAdvanceDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"DiscountMode":{"type":"number","enum":[1,2]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]}}}} ``` ## The ReadEstimateDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]}}}} ``` ## Télécharger un devis Vous pouvez télécharger un devis en PDF et spécifier la langue appliquée sur le document. ## GET /v2/billing/{billingId}/download > Download a billing document ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]}}},"paths":{"/v2/billing/{billingId}/download":{"get":{"operationId":"BillingController_downloadPDF_v2","parameters":[{"name":"billingId","required":true,"in":"path","schema":{"type":"string"}},{"name":"locale","required":false,"in":"query","description":"Locale for the PDF generation","schema":{"$ref":"#/components/schemas/BillingLocale"}}],"responses":{"200":{"description":"","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Billing document not found"}},"summary":"Download a billing document","tags":["Billing"]}}}} ``` # Avoirs Créez des avoirs depuis une facture, un acompte ou de zéro, puis finalisez-les. Un avoir est un document de facturation qui annule ou rembourse tout ou partie d'une facture ou d'un acompte. Comme les autres documents, il est associé à un client (contact, organisation ou contact d'organisation) et contient des lignes ainsi que des informations générales. Un avoir créé est dans un état brouillon (`draft`) tant qu'il n'a pas été finalisé. Une fois finalisé, il reçoit un numéro officiel et ne peut plus être modifié. ## Créer un avoir depuis une facture Crée un avoir en brouillon rattaché à la facture d'origine. Les lignes de la facture sont reprises et ajustées au prorata du montant restant dû (les acomptes déjà émis sont déduits) : sans acompte, l'avoir couvre 100 % de la facture. ## POST /v2/billing/invoice/{invoiceId}/asset > Create asset from invoice ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/invoice/{invoiceId}/asset":{"post":{"operationId":"InvoiceController_createAsset_v2","parameters":[{"name":"invoiceId","required":true,"in":"path","description":"ID of the invoice to create asset from","schema":{"type":"string"}}],"responses":{"200":{"description":"Asset created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Create asset from invoice","tags":["invoice"]}}}} ``` > Pour annuler intégralement une facture en une seule opération, utilisez plutôt `POST /v2/billing/invoice/{invoiceId}/cancel` : l'avoir généré couvre la totalité de la facture et est directement finalisé. ## Créer un avoir depuis un acompte L'acompte doit être finalisé (un acompte en brouillon est refusé) et ne pas déjà avoir d'avoir associé. ## POST /v2/billing/advance/{advanceId}/asset > Create asset from advance ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/advance/{advanceId}/asset":{"post":{"operationId":"AdvanceController_createAsset_v2","parameters":[{"name":"advanceId","required":true,"in":"path","description":"ID of the invoice to create asset from","schema":{"type":"string"}}],"responses":{"200":{"description":"Asset created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Advance not found"}},"summary":"Create asset from advance","tags":["advance"]}}}} ``` ## Créer un avoir vierge Crée un avoir en brouillon sans document parent, dont les lignes sont à définir ensuite. ## POST /v2/billing/asset > Create a new asset ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateAssetDto":{"type":"object","properties":{"billingCustomerId":{"type":"string"},"opportunityId":{"type":"string"}}},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/asset":{"post":{"operationId":"AssetController_createAsset_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssetDto"}}}},"responses":{"201":{"description":"Asset created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"}},"summary":"Create a new asset","tags":["asset"]}}}} ``` ### Corps de requête (`CreateAssetDto`) Renseignez **soit** `billingCustomerId`, **soit** `opportunityId` : les deux champs s'excluent mutuellement et l'un des deux est obligatoire. * `billingCustomerId` : identifiant du client de facturation (UUID) * `opportunityId` : identifiant de l'opportunité (UUID) #### Exemple ```json { "billingCustomerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ``` ## Récupérer un avoir ## GET /v2/billing/asset/{assetId} > Get an asset by ID ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/asset/{assetId}":{"get":{"operationId":"AssetController_getAsset_v2","parameters":[{"name":"assetId","required":true,"in":"path","description":"ID of the asset to retrieve","schema":{"type":"string"}}],"responses":{"200":{"description":"Asset retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"404":{"description":"Asset not found"}},"summary":"Get an asset by ID","tags":["asset"]}}}} ``` ## The ReadAssetDto object ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"components":{"schemas":{"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}}} ``` ## Lister les avoirs Le listing est commun à tous les documents de facturation : filtrez sur `type=asset` pour ne récupérer que les avoirs. ## GET /v2/billings > List billing documents ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"BillingState":{"type":"string","enum":[1,2,3,4,5]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingRangeType":{"type":"string","enum":["paidAt","signedAt","refusedAt","date","validityDate","dueDate"]},"ReadBillingCollectionDto":{"type":"object","properties":{"countWithoutFilters":{"type":"number"},"totalDocs":{"type":"number"},"limit":{"type":"number"},"totalPages":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"},"nextPage":{"type":"number"},"page":{"type":"number"},"prevPage":{"type":"number"},"docs":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingCollectionItemDto"}}},"required":["countWithoutFilters","totalDocs","limit","totalPages","hasNextPage","hasPrevPage","nextPage","page","prevPage","docs"]},"ReadBillingCollectionItemDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"emittedAt":{"type":"number"},"dueAt":{"type":"number"},"customer":{"$ref":"#/components/schemas/ReadCustomerDto"},"paidAt":{"type":"number"},"refundAt":{"type":"number"},"signedAt":{"type":"number"},"refusedAt":{"type":"number"},"expiredAt":{"type":"number"},"archivedAt":{"type":"number"},"nextBillingAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"totalAmountWithoutTaxAfterDiscount":{"type":"number"},"totalAmountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"paymentMethodUsed":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethodUsedDto"}},"billedAmountWithTax":{"type":"number"},"cancelledAmountWithoutTax":{"type":"number"},"cancelledAmountWithTax":{"type":"number"},"lastReminderSentAt":{"type":"number"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"lastDownloadAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"parent":{"$ref":"#/components/schemas/ParentBillingDto"},"createdFromInvoice":{"type":"string"},"hasFinalInvoice":{"type":"boolean"},"isFinalInvoiceCanceled":{"type":"boolean","description":"Whether the final invoice associated with this advance is fully canceled"},"finalInvoiceNumber":{"type":"string","description":"Number of the final invoice associated with this advance"},"hasAdvances":{"type":"boolean"},"isDeletable":{"type":"boolean"},"finalizable":{"type":"boolean"},"isEditable":{"type":"boolean"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/ElectronicSignatureDto"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"paymentRequest":{"$ref":"#/components/schemas/PaymentRequestDto"},"tiersPrestationIsActivatedForThisBilling":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsCollectionItemDto"},"remainingReconciliateAmount":{"type":"number"},"hasAssociatedTransaction":{"type":"boolean"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"canceledAt":{"type":"number"},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}}},"required":["id","type","state","emittedAt","customer","totalAmountWithoutTaxAfterDiscount","totalAmountWithTaxAfterDiscount","isDeletable","finalizable","currencyCode","compatibilityVersion","createdAt","updatedAt"]},"ReadCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier"},"legacyId":{"type":"string","description":"Legacy system identifier"},"paymentMethods":{"description":"List of payment method identifiers","type":"array","items":{"type":"string"}},"currency":{"description":"Preferred currency code","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"Customer first name"},"lastname":{"type":"string","description":"Customer last name"},"phoneNumber":{"type":"string","description":"Contact phone number"},"emails":{"description":"List of email addresses","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address information","allOf":[{"$ref":"#/components/schemas/ReadCustomerAddressDto"}]},"deliveryAddress":{"description":"Delivery address information","allOf":[{"$ref":"#/components/schemas/ReadCustomerAddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language code"},"name":{"type":"string","description":"Business name"},"commercialName":{"type":"string","description":"Commercial/trading name"},"siren":{"type":"string","description":"SIREN number"},"siret":{"type":"string","description":"SIRET number"},"nafCode":{"type":"string","description":"NAF/APE code"},"vatNumber":{"type":"string","description":"VAT identification number"},"token":{"type":"string","description":"Customer token"},"tiersPrestationIsActivated":{"type":"boolean","description":"Tiers prestation activation status"},"tiersPrestation":{"description":"Tiers prestation details","allOf":[{"$ref":"#/components/schemas/ReadTiersPrestationDto"}]},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadCustomerDto"}]},"contactId":{"type":"string","description":"Associated contact ID"},"organizationId":{"type":"string","description":"Associated organization ID"},"isDefault":{"type":"boolean","description":"Default status flag"},"test":{"type":"boolean","description":"Test account flag"},"archivedAt":{"type":"number","description":"Archived at"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"ReadCustomerAddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of address"},"line2":{"type":"string","description":"Second line of address"},"city":{"type":"string","description":"City name"},"zipCode":{"type":"string","description":"Postal/ZIP code"},"country":{"description":"Country code enum value","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"ReadTiersPrestationDto":{"type":"object","properties":{"idClient":{"type":"string","description":"Client identifier"},"registeredAt":{"type":"number","description":"Registration timestamp"},"status":{"description":"Current client state","allOf":[{"$ref":"#/components/schemas/ClientState"}]}},"required":["idClient","registeredAt","status"]},"ClientState":{"type":"string","enum":["synced","pending","end_user_action_required","error"],"description":"Current client state"},"PaymentMethodUsedDto":{"type":"object","properties":{"value":{"type":"string"},"other":{"type":"string"},"paymentAmount":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["value","paymentAmount"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ParentBillingDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]}},"required":["id","number","type"]},"ElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"ConvertedAmountsCollectionItemDto":{"type":"object","properties":{"totalAmountWithoutTaxAfterDiscount":{"type":"number"},"totalAmountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"}},"required":["totalAmountWithoutTaxAfterDiscount","totalAmountWithTaxAfterDiscount"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]}}},"paths":{"/v2/billings":{"get":{"operationId":"BillingsController_getBillings_v2","parameters":[{"name":"page","required":true,"in":"query","schema":{"type":"number"}},{"name":"limit","required":true,"in":"query","schema":{"type":"number"}},{"name":"search","required":false,"in":"query","schema":{"type":"string"}},{"name":"state","required":false,"in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/BillingState"}}},{"name":"late","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"type","required":false,"in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/BillingType"}}},{"name":"tiersPrestationIsActivatedForThisBilling","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"customerId","required":false,"in":"query","schema":{"type":"string"}},{"name":"organizationId","required":false,"in":"query","schema":{"type":"string"}},{"name":"opportunityId","required":false,"in":"query","schema":{"type":"string"}},{"name":"countWithoutFilters","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"test","required":true,"in":"query","schema":{"type":"boolean"}},{"name":"archived","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"range","required":false,"in":"query","schema":{"type":"array","items":{"type":"string"}}},{"name":"rangeType","required":false,"in":"query","schema":{"$ref":"#/components/schemas/BillingRangeType"}},{"name":"onlyReminderActive","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"onlyOnlineSignature","required":false,"in":"query","schema":{"type":"boolean"}},{"name":"onlyOnlinePayment","required":false,"in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The billings records","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadBillingCollectionDto"}}}}},"summary":"List billing documents","tags":["Billings"]}}}} ``` ### Paramètres de requête Champs requis : * `page` : numéro de page (à partir de `1`) * `limit` : nombre d'éléments par page * `test` : `true` pour lister les documents du mode test Champs optionnels : * `type` : types de documents (tableau, voir valeurs ci-dessous) * `state` : états des documents (tableau, voir valeurs ci-dessous) * `search` : terme de recherche (numéro, client, etc.) * `customerId` : filtre sur un contact * `organizationId` : filtre sur une organisation * `opportunityId` : filtre sur une opportunité * `archived` : `true` pour ne lister que les documents archivés * `late` : `true` pour ne lister que les documents en retard * `range` : bornes de dates `[from, to]`, à utiliser avec `rangeType` * `rangeType` : date sur laquelle s'applique `range` (voir valeurs ci-dessous) * `onlyReminderActive` : documents avec relance active * `onlyOnlineSignature` : documents avec signature en ligne * `onlyOnlinePayment` : documents avec paiement en ligne #### `type` (BillingType) * `invoice` * `estimate` * `purchase_order` * `advance` * `asset` #### `state` (BillingState) * `draft` * `finalized` * `signed` * `refused` * `paid` #### `rangeType` (BillingRangeType) * `emittedAt` * `paidAt` * `signedAt` * `expiredAt` * `dueAt` * `refusedAt` #### Exemple ```http GET /v2/billings?page=1&limit=20&test=false&type=asset&state=finalized ``` ## Mettre à jour les lignes de l'avoir Les lignes d'un avoir sont mises à jour via l'endpoint partagé de billing. ## PATCH /v2/billing/{billingId}/lines > Update billing lines ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateBillingLinesDto":{"type":"object","properties":{"lines":{"description":"Array of billing lines, each representing a product or service","type":"array","items":{"$ref":"#/components/schemas/UpdateLineDto"}},"discount":{"description":"Optional discount to be applied to the entire billing","allOf":[{"$ref":"#/components/schemas/DiscountDto"}]}},"required":["lines"]},"UpdateLineDto":{"type":"object","properties":{"generatedId":{"type":"string","description":"Warning: Client-side generated line id. This field will be deprecated and will be removed in the future."},"productId":{"type":"string","description":"Unique identifier of the product, if applicable"},"unitPrice":{"type":"number","description":"Price per unit in cents (e.g., 1500 for 15.00 euros)"},"quantity":{"type":"number","description":"Quantity of the product or service"},"quantityUnit":{"description":"Unit of measurement for the quantity (e.g., UNIT, HOUR, KILOGRAM)","nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string","description":"Name or short description of the product or service"},"reference":{"type":"string","description":"Product reference or SKU, if applicable"},"description":{"type":"string","description":"Detailed description of the product or service"},"type":{"description":"Type of the product or service (e.g., SALE_OF_GOODS, SERVICE)","nullable":true,"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"description":"VAT code applicable to the product or service","allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"description":"Personal service activity only available for products compatible with the tax credit","allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"discount":{"description":"Optional discount to be applied to the billing line","allOf":[{"$ref":"#/components/schemas/DiscountDto"}]},"isDeliveryOfGoods":{"type":"boolean","description":"Mark a product line as delivery of goods to display it on document"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT). Requires the tax included unit price feature to be enabled.","default":false}},"required":["unitPrice","quantity","quantityUnit","designation","type","vatCode"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"DiscountMode":{"type":"number","enum":[1,2]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]}}},"paths":{"/v2/billing/{billingId}/lines":{"patch":{"operationId":"BillingController_updateLines_v2","parameters":[{"name":"billingId","required":true,"in":"path","description":"ID of the billing to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingLinesDto"}}}},"responses":{"200":{"description":"Billing lines updated successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadEstimateDto"},{"$ref":"#/components/schemas/ReadAssetDto"}]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Billing not found"}},"summary":"Update billing lines","tags":["Billing"]}}}} ``` ## Mettre à jour les informations générales ## PATCH /v2/billing/asset/{assetId}/general-informations > Update asset general informations ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateAssetGeneralInformationsDto":{"type":"object","properties":{"headerNote":{"type":"string","description":"Custom note to be displayed in the header of the billing"},"footerNote":{"type":"string","description":"Custom note to be displayed in the footer of the billing"},"generalTermsAndConditionsOfSale":{"type":"string","description":"General terms and conditions of sale to be included in the billing"},"mentionMediator":{"type":"string","description":"Mention mediateur to be included in the billing"},"paymentMethods":{"type":"array","description":"Array of accepted payment methods for the billing","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"},"vatMention":{"description":"Vat mention applicable for a billing","allOf":[{"$ref":"#/components/schemas/VatMention"}]},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]}}},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/asset/{assetId}/general-informations":{"patch":{"operationId":"AssetController_updateGeneralInformations_v2","parameters":[{"name":"assetId","required":true,"in":"path","description":"ID of the asset to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetGeneralInformationsDto"}}}},"responses":{"200":{"description":"Asset general informations updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Asset not found"}},"summary":"Update asset general informations","tags":["asset"]}}}} ``` ## Mettre à jour la timeline (date d'émission, échéance, etc.) ## PATCH /v2/billing/asset/{assetId}/timeline > Update asset timeline ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateAssetTimelineDto":{"type":"object","properties":{"emittedAt":{"type":"number","description":"The timestamp when the invoice was emitted"},"paymentDelay":{"description":"The payment delay for the invoice","allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"customDueDate":{"type":"number","description":"Custom due date for the invoice when payment delay is OTHER"},"deliveryDate":{"type":"number","description":"The timestamp for delivery date","nullable":true}},"required":["emittedAt","paymentDelay"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/asset/{assetId}/timeline":{"patch":{"operationId":"AssetController_updateTimeline_v2","parameters":[{"name":"assetId","required":true,"in":"path","description":"ID of the asset to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssetTimelineDto"}}}},"responses":{"200":{"description":"Asset timeline updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Asset not found"}},"summary":"Update asset timeline","tags":["asset"]}}}} ``` ## Mettre à jour la langue de l'avoir ## PUT /v2/billing/asset/{assetId}/locale > Update asset locale ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateBillingLocaleDto":{"type":"object","properties":{"locale":{"description":"The locale of the billing document","allOf":[{"$ref":"#/components/schemas/BillingLocale"}]}},"required":["locale"]},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/asset/{assetId}/locale":{"put":{"operationId":"AssetController_updateLocale_v2","parameters":[{"name":"assetId","required":true,"in":"path","description":"ID of the asset to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingLocaleDto"}}}},"responses":{"200":{"description":"Asset locale updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Asset not found"}},"summary":"Update asset locale","tags":["asset"]}}}} ``` ## Mettre à jour la devise de l'avoir ## PUT /v2/billing/asset/{assetId}/currency > Update asset currency ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateBillingCurrencyDto":{"type":"object","properties":{"currency":{"description":"The currency which will be used with the billing","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyRate":{"type":"number","description":"The conversion rate from the billing currency to the new currency"}},"required":["currency"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]}}},"paths":{"/v2/billing/asset/{assetId}/currency":{"put":{"operationId":"AssetController_updateCurrency_v2","parameters":[{"name":"assetId","required":true,"in":"path","description":"ID of the asset to update","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBillingCurrencyDto"}}}},"responses":{"200":{"description":"Asset currency updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAssetDto"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Asset not found"}},"summary":"Update asset currency","tags":["asset"]}}}} ``` ## Finaliser un avoir Une fois l'avoir en brouillon prêt, finalisez-le pour lui attribuer un numéro officiel. Un document finalisé ne peut plus être modifié. ## PATCH /v2/billing/{billingId}/finalize > Finalize a billing document ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadInvoiceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"isOnlinePaymentActivated":{"type":"boolean"},"isFinalInvoice":{"type":"boolean"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"reminder":{"$ref":"#/components/schemas/ReminderDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"paymentRequest":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PaymentRequestDto"}]},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"frequency":{"$ref":"#/components/schemas/FrequencyDto"},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDiscountDisbursement":{"type":"boolean"},"expiredAt":{"type":"number"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","dueAt","isReminderActivated","isOnlinePaymentActivated","isFinalInvoice","lines","total","displaySettings","hasAssociatedTransaction","includeDiscountDisbursement"]},"BillingType":{"type":"number","enum":[1,2,3,4,5]},"BillingState":{"type":"string","enum":[1,2,3,4,5]},"ReadBillingCustomerDto":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the customer"},"legacyId":{"type":"string","description":"Legacy identifier of the customer"},"currency":{"description":"Preferred currency of the customer","allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"firstname":{"type":"string","description":"First name of the customer"},"lastname":{"type":"string","description":"Last name of the customer"},"phoneNumber":{"type":"string","description":"Phone number of the customer"},"emails":{"description":"Email addresses of the customer","type":"array","items":{"type":"string"}},"billingAddress":{"description":"Billing address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddress":{"description":"Delivery address of the customer","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"deliveryAddressIsSame":{"type":"boolean","description":"Tell if delivery and billing address are deep equal or not"},"language":{"type":"string","description":"Preferred language of the customer"},"name":{"type":"string","description":"Full name of the customer"},"commercialName":{"type":"string","description":"Commercial name of the customer"},"siren":{"type":"string","description":"SIREN number of the customer"},"siret":{"type":"string","description":"SIRET number of the customer"},"nafCode":{"type":"string","description":"NAF code of the customer"},"vatNumber":{"type":"string","description":"VAT number of the customer"},"token":{"type":"string","description":"Token associated with the customer"},"parent":{"description":"Parent customer information","allOf":[{"$ref":"#/components/schemas/ReadBillingCustomerDto"}]},"contactId":{"type":"string","description":"Contact identifier associated with the customer"},"organizationId":{"type":"string","description":"Organization identifier associated with the customer"},"isDefault":{"type":"boolean","description":"Indicates if this is the default customer"},"test":{"type":"boolean","description":"Indicates if this is a test customer"}},"required":["id","legacyId","billingAddress","deliveryAddressIsSame","token","test"]},"CurrencyCode":{"type":"string","enum":["EUR","GBP","CHF","USD","AUD","CAD","JPY","CNH","CZK","DKK","BGN","PLN","HUF","RON","SEK","NOK","TRY","BRL","HKD","ILS","INR","KRW","MXN","XPF","XOF","XAF"],"description":"Preferred currency of the customer"},"AddressDto":{"type":"object","properties":{"line1":{"type":"string","description":"First line of the address"},"line2":{"type":"string","description":"Second line of the address"},"city":{"type":"string","description":"City of the address"},"zipCode":{"type":"string","description":"Zip code of the address"},"country":{"description":"Country code of the address","allOf":[{"$ref":"#/components/schemas/CountryCode"}]}},"required":["line1","city","zipCode","country"]},"CountryCode":{"type":"string","enum":["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AN","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KR","XK","KP","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],"description":"Country code of the address"},"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]},"OpportunityDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]},"ReadCurrencyDto":{"type":"object","properties":{"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currencyDate":{"type":"number"},"currencyRate":{"type":"number"},"origin":{"allOf":[{"$ref":"#/components/schemas/CurrencyOrigin"}]}},"required":["currencyCode","currencyDate","currencyRate","origin"]},"CurrencyOrigin":{"type":"string","enum":["ECB","USER","FIXED"]},"ReadFileDto":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"extension":{"type":"string"},"mimeType":{"type":"string"},"url":{"type":"string"},"relativeUrl":{"type":"string"},"isCertified":{"type":"boolean"},"isCertifiable":{"type":"boolean"}},"required":["id","name","extension","mimeType","url","relativeUrl"]},"FinalizeRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"BillingWarningDto":{"type":"object","properties":{"title":{"type":"string"},"message":{"type":"string"}},"required":["title","message"]},"ReadBillingEmitterDto":{"type":"object","properties":{"name":{"type":"string"},"fullName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"commercialName":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"rcsNumber":{"type":"string","nullable":true},"rsacNumber":{"type":"string","nullable":true},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"sapAgreementNumber":{"type":"string"},"hasVat":{"type":"boolean"}}},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"ReadBankInformationDto":{"type":"object","properties":{"bic":{"type":"string"},"iban":{"type":"string"},"holder":{"type":"string"}},"required":["bic","iban","holder"]},"BillingLegalsDto":{"type":"object","properties":{"headerNote":{"type":"string"},"footerNote":{"type":"string"},"generalTermsAndConditionsOfSale":{"type":"string"},"mentionMediator":{"type":"string"},"vatMention":{"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"paymentMethods":{"type":"array","items":{"$ref":"#/components/schemas/PaymentMethod"}},"otherPaymentMethod":{"type":"string","description":"Other payment method"}},"required":["vatMention","paymentMethods"]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]},"PaymentMethod":{"type":"string","enum":["transfer","direct_debit","credit_card","cheque","universal_employment_service_cheque","cash","paypal","stripe","other"]},"BillingCompatibilityVersion":{"type":"string","enum":["V1","V2","V3"]},"PaymentDelay":{"type":"string","enum":["at_reception","end_of_month","seven_days","ten_days","fifteen_days","thirty_days","thirty_days_end_of_month","forty_five_days","forty_five_days_end_of_month","sixty_days","sixty_days_end_of_month","ninety_days","ninety_days_end_of_month","one_hundred_and_twenty_days","other"]},"ReadBillingDetailsLineDto":{"type":"object","properties":{"generatedId":{"type":"string"},"id":{"type":"string"},"unitPrice":{"type":"number"},"unitPriceHT":{"type":"number"},"productId":{"type":"string"},"quantity":{"type":"number"},"quantityUnit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"reference":{"type":"string"},"description":{"type":"string"},"isDeliveryOfGoods":{"type":"boolean"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"discount":{"$ref":"#/components/schemas/DiscountLineDto"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsLineDto"},"isTaxIncluded":{"type":"boolean","description":"Indicates whether the unit price includes tax (TTC) or excludes tax (HT)"}},"required":["unitPrice","unitPriceHT","designation","isDeliveryOfGoods","priceWithoutTaxBeforeDiscount","discountAmount","discount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]},"DiscountLineDto":{"type":"object","properties":{"amount":{"type":"number","description":"Montant de la remise, 1000 pour 10% ou 10€"},"mode":{"description":"Mode de la réduction en pourcentage ou en euros","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]}},"required":["amount","mode"]},"DiscountMode":{"type":"number","enum":[1,2]},"ConvertedAmountsLineDto":{"type":"object","properties":{"priceWithoutTaxBeforeDiscount":{"type":"number"},"discountAmount":{"type":"number"},"priceWithoutTaxAfterDiscount":{"type":"number"},"vatAmount":{"type":"number"},"priceTotalTax":{"type":"number"}},"required":["priceWithoutTaxBeforeDiscount","priceWithoutTaxAfterDiscount","vatAmount","priceTotalTax"]},"ReadInvoiceTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ReadInvoiceTotalWithoutConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"VatDetailDto":{"type":"object","properties":{"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"amount":{"type":"number"},"vatRate":{"type":"number"}},"required":["vatCode","amount","vatRate"]},"ReadInvoiceTotalWithoutConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"discountAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"ReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean"},"frequency":{"allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number"},"active":{"type":"boolean"},"recipients":{"type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active","recipients"]},"ReminderFrequency":{"type":"string","enum":["on_due_date","every_week"],"description":"The frequency at which reminders should be sent"},"DiscountDto":{"type":"object","properties":{"mode":{"description":"The mode of discount application, either percentage or fixed amount","allOf":[{"$ref":"#/components/schemas/DiscountMode"}]},"amount":{"type":"number","description":"The amount for the discount (1000 for 10% or 10€)"}},"required":["mode","amount"]},"LatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LatePenalty":{"type":"string","enum":["three_time_legal_rate","bce_director_rate_plus_ten_points","other"]},"BillingLumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"LumpSumCompensation":{"type":"number","enum":[1,2]},"BillingDiscountAdvancePaymentDto":{"type":"object","properties":{"value":{"description":"Type de remise sur acompte","allOf":[{"$ref":"#/components/schemas/DiscountAdvancePayment"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DiscountAdvancePayment":{"type":"string","enum":["none","other"],"description":"Type de remise sur acompte"},"DisplayBillingSettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayEstimateNumber":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"PaymentRequestDto":{"type":"object","properties":{"idDemandePaiement":{"type":"string"},"dateDebutEmploi":{"type":"number"},"dateFinEmploi":{"type":"number"},"dateVirement":{"type":"number"},"advanceAlreadyPayed":{"type":"number"},"advancePaymentDate":{"type":"number"},"mntVirement":{"type":"number"},"statut":{"allOf":[{"$ref":"#/components/schemas/PaymentRequestStatusUrssafTp"}]}},"required":["dateDebutEmploi","dateFinEmploi"]},"PaymentRequestStatusUrssafTp":{"type":"string","enum":[0,"10","20","30","40","50","60","70","110","111","120","112","ERR_PARTICULIER_INCONNU","ERR_CMPT_BLOQUE","ERR_FACTURE_DOUBLON","ERR_NBRE_PREST_MAX","ERR_DATE_FUTUR","ERR_DATE_PAIEMENT_AVANT_EXP","ERR_PERIODE_EMPLOI_MOIS_NON_UNIQUE","ERR_DATE_FIN_AVANT_DATE_DEB","ERR_MONTANT_ACOMPTE","ERR_TOTAL_PRESTATIONS","ERR_CODE_NATURE","ERR_CODE_ACTIVITE","ERR_CODE_ACTIVITE_NATURE","ERR_MNT_PREST_HT_TVA","ERR_MNT_PREST_TTC","ERR_VALEUR_NEGATIVE","ERR_PRESTATAIRE_EMETTEUR_INCONNU","ERR_LIEN_PARTICULIER_PRESTATAIRE","ERR_PRESTATAIRE_FACTURATION_INCONNU","ERR_CRITERE_RECHERCHE_VIDE","ERR_DGFIP_R2P_INCONNU","ERR_DATE_NAISSANCE_FUTUR","ERR_LIEU_NAISSANCE_DEPT","ERR_LIEU_NAISSANCE_COMN","ERR_LIEU_NAISSANCE_PAYS","ERR_DGFIP_IMPOTPART_INCONNU","ERR_CONTACT","ERR_CONTACT_ADRESSE_TYPE_VOIE","ERR_CONTACT_ADRESSE_LETTRE_VOIE","ERR_CONTACT_ADRESSE_TYPEVOIE","ERR_CONTACT_ADRESSE_LIBELLEVOIE","ERR_CONTACT_ADRESSE_INFORMATION_SUPPLEMENTAIRE","ERR_CONTACT_ADRESSE_COMMUNE","ERR_COORDONNEES_BANCAIRES","ERR_FORMAT_VALEUR","ERR_NBRE_MAX_RESULTAT","ERR_RECHERCHE_VIDE","ERR_ECV_PARTICULIERS_EXISTENT","ERREUR_REFERENCE_PARTICULIER_EXISTANTE_TYPE","ERR_LIEU_NAISSANCE_OBLIGATOIRE","ERREUR_LIEU_NAISSANCE_INVALIDE","ERR_RECHERCHE_PARTICULIER","ERR_FORMAT_NUMINTERVENANT","ERR_NUMINTERVENANT_MANQUANT","ERR_NUMINTERVENANT_BLOQUE","ERR_MANDAT_ECHU","ERREUR_VALIDATION","ERREUR_TECHNIQUE","ERREUR_INCONNUE"]},"ReadEstimateDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"expiredAt":{"type":"number"},"refusedAt":{"type":"number"},"signedAt":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/EstimateTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"latePenalty":{"$ref":"#/components/schemas/LatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/LumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"advances":{"type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"advanceEstimateLines":{"$ref":"#/components/schemas/ReadEstimateAdvanceLinesDto"},"withElectronicSignature":{"type":"boolean"},"electronicSignature":{"$ref":"#/components/schemas/EstimateElectronicSignatureDto"},"dueAt":{"type":"number"},"electronicSignatureRequirements":{"type":"array","items":{"$ref":"#/components/schemas/ElectronicSignatureRequirementDto"}},"hasFinalInvoice":{"type":"boolean"},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","expiredAt","lines","total","displaySettings","advances","advanceEstimateLines","withElectronicSignature","electronicSignature","electronicSignatureRequirements","hasFinalInvoice","includeDiscountDisbursement"]},"EstimateTotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","amountWithoutTaxBeforeDiscountWithoutDisbursement","remainingAmountWithoutTaxWithoutDisbursement"]},"ConvertedAmountsDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingAmountToBill":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"billedAmountWithoutTax":{"type":"number"},"billedAmountWithTax":{"type":"number"},"remainingAmountWithoutTaxWithoutDisbursement":{"type":"number"},"amountWithoutTaxBeforeDiscountWithoutDisbursement":{"type":"number"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingAmountToBill","vatDetails","billedAmountWithoutTax","billedAmountWithTax","remainingAmountWithoutTaxWithoutDisbursement","amountWithoutTaxBeforeDiscountWithoutDisbursement"]},"LumpSumCompensationDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LumpSumCompensation"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"DisplaySettingsDto":{"type":"object","properties":{"displayFullName":{"type":"boolean"},"displayEmail":{"type":"boolean"},"displayPhoneNumber":{"type":"boolean"},"displaySAPAgreement":{"type":"boolean"},"displayLegalStatus":{"type":"boolean"},"displayRequiredMentionsProduct":{"type":"boolean"},"displayGoodForApproval":{"type":"boolean"},"displayMemberOfAnApprovedAssociation":{"type":"boolean"},"displayAbbyLogo":{"type":"boolean"},"displayTitle":{"type":"boolean"}},"required":["displayFullName","displayEmail","displayPhoneNumber","displaySAPAgreement","displayLegalStatus","displayRequiredMentionsProduct","displayMemberOfAnApprovedAssociation","displayAbbyLogo","displayTitle"]},"ReadAdvanceDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"dueAt":{"type":"number"},"paidAt":{"type":"number"},"lastReminderSentAt":{"type":"number"},"isReminderActivated":{"type":"boolean"},"designation":{"type":"string"},"isOnlinePaymentActivated":{"type":"boolean"},"description":{"type":"string"},"total":{"$ref":"#/components/schemas/TotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"displaySettings":{"$ref":"#/components/schemas/DisplaySettingsDto"},"parent":{"$ref":"#/components/schemas/ReadEstimateDto"},"advanceMode":{"allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"advancePercentage":{"type":"number"},"advanceAmount":{"type":"number"},"reminder":{"$ref":"#/components/schemas/BillingReminderDto"},"latePenalty":{"$ref":"#/components/schemas/BillingLatePenaltyDto"},"lumpSumCompensation":{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"hasAssociatedTransaction":{"type":"boolean","description":"Indicates if the customer has an associated transaction"},"includeDisbursement":{"type":"boolean","description":"Indicates if the advance includes disbursement"},"canceledAt":{"type":"number"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","paymentDelay","isReminderActivated","designation","isOnlinePaymentActivated","total","displaySettings","advanceMode","advancePercentage","advanceAmount","hasAssociatedTransaction","includeDisbursement"]},"TotalDto":{"type":"object","properties":{"amountWithoutTaxBeforeDiscount":{"type":"number"},"amountWithoutTaxAfterDiscount":{"type":"number"},"amountWithTaxAfterDiscount":{"type":"number"},"remainingAmountWithoutTax":{"type":"number"},"remainingAmountWithTax":{"type":"number"},"remainingReconciliateAmount":{"type":"number"},"vatDetails":{"type":"array","items":{"$ref":"#/components/schemas/VatDetailDto"}},"discountAmount":{"type":"number"},"convertedAmounts":{"$ref":"#/components/schemas/ConvertedAmountsDto"}},"required":["amountWithoutTaxBeforeDiscount","amountWithoutTaxAfterDiscount","amountWithTaxAfterDiscount","remainingAmountWithoutTax","remainingAmountWithTax","remainingReconciliateAmount","vatDetails"]},"AdvanceMode":{"type":"string","enum":["AMOUNT","PERCENTAGE"],"description":"The mode of the advance (amount or percentage)"},"BillingReminderDto":{"type":"object","properties":{"inCopy":{"type":"boolean","description":"Indicates if the sender should be in copy of the reminder"},"frequency":{"description":"The frequency at which reminders should be sent","allOf":[{"$ref":"#/components/schemas/ReminderFrequency"}]},"numberOfRemindersToSend":{"type":"number","description":"The number of reminders to be sent"},"active":{"type":"boolean","description":"Indicates if the reminder is active"},"recipients":{"description":"Array of email addresses to receive the reminder","type":"array","items":{"type":"string"}}},"required":["inCopy","frequency","numberOfRemindersToSend","active"]},"BillingLatePenaltyDto":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/LatePenalty"}]},"otherValue":{"type":"string","description":"Description custom si `value` vaut `other`"}},"required":["value"]},"ReadEstimateAdvanceLinesDto":{"type":"object","properties":{"advances":{"description":"Array of advance items","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceItemLineDto"}},"totals":{"description":"Totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]},"convertedTotals":{"description":"Converted totals of the advance items","allOf":[{"$ref":"#/components/schemas/ReadAdvanceItemLineTotalsDto"}]}},"required":["advances","totals","convertedTotals"]},"ReadAdvanceItemLineDto":{"type":"object","properties":{"value":{"type":"number","description":"The value of the advance (amount or percentage)"},"mode":{"description":"The mode of the advance (amount or percentage)","allOf":[{"$ref":"#/components/schemas/AdvanceMode"}]},"paymentCondition":{"description":"Payment condition for the advance","allOf":[{"$ref":"#/components/schemas/PaymentCondition"}]},"customPaymentCondition":{"type":"string","description":"Custom payment condition if OTHER is selected","nullable":true}},"required":["value","mode"]},"PaymentCondition":{"type":"string","enum":["SIGNATURE","ORDER","OTHER"]},"ReadAdvanceItemLineTotalsDto":{"type":"object","properties":{"totalAmountWithoutTax":{"type":"number","description":"Total amount of all advances"},"totalAmountWithTax":{"type":"number","description":"Total amount of all advances after discount"},"remainingTotalAmountWithoutTax":{"type":"number","description":"Remaining total amount without tax"},"remainingTotalAmountWithTax":{"type":"number","description":"Remaining total amount with tax"}},"required":["totalAmountWithoutTax","totalAmountWithTax","remainingTotalAmountWithoutTax","remainingTotalAmountWithTax"]},"EstimateElectronicSignatureDto":{"type":"object","properties":{"id":{"type":"string"},"canceledAt":{"type":"number","nullable":true},"procedureId":{"type":"string","nullable":true},"magicLink":{"type":"string","nullable":true},"signedAt":{"type":"number","nullable":true},"refusedAt":{"type":"number","nullable":true},"status":{"allOf":[{"$ref":"#/components/schemas/ElectronicSignatureStatus"}]}},"required":["id","canceledAt","procedureId","magicLink","signedAt","refusedAt","status"]},"ElectronicSignatureStatus":{"type":"string","enum":["requested","activated","on_going","refused","signed","cancelled"]},"ElectronicSignatureRequirementDto":{"type":"object","properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"]},"FrequencyDto":{"type":"object","properties":{"id":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"nextBillingAt":{"type":"string","nullable":true},"frequency":{"type":"number"},"interval":{"allOf":[{"$ref":"#/components/schemas/FrequencyInterval"}]},"finalizeInvoice":{"type":"boolean"},"sendByMail":{"type":"boolean"},"inCopy":{"type":"boolean"}},"required":["id","from","to","frequency","interval","finalizeInvoice","sendByMail","inCopy"]},"FrequencyInterval":{"type":"string","enum":["day","week","month","year"]},"ReadAssetDto":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string","description":"Title of the billing document"},"type":{"allOf":[{"$ref":"#/components/schemas/BillingType"}]},"state":{"allOf":[{"$ref":"#/components/schemas/BillingState"}]},"customer":{"$ref":"#/components/schemas/ReadBillingCustomerDto"},"locale":{"allOf":[{"$ref":"#/components/schemas/BillingLocale"}]},"emittedAt":{"type":"number"},"archivedAt":{"type":"number"},"opportunity":{"$ref":"#/components/schemas/OpportunityDto"},"locked":{"type":"boolean"},"finalizable":{"type":"boolean"},"test":{"type":"boolean"},"isEditable":{"type":"boolean"},"currencyCode":{"allOf":[{"$ref":"#/components/schemas/CurrencyCode"}]},"currency":{"$ref":"#/components/schemas/ReadCurrencyDto"},"lastDownloadAt":{"type":"number"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ReadFileDto"}},"finalizeRequirements":{"type":"array","items":{"$ref":"#/components/schemas/FinalizeRequirementDto"}},"warnings":{"type":"array","items":{"$ref":"#/components/schemas/BillingWarningDto"}},"emitter":{"$ref":"#/components/schemas/ReadBillingEmitterDto"},"bankInformation":{"$ref":"#/components/schemas/ReadBankInformationDto"},"billingLegals":{"$ref":"#/components/schemas/BillingLegalsDto"},"createdAt":{"type":"number"},"updatedAt":{"type":"number"},"deliveryDate":{"type":"number"},"compatibilityVersion":{"allOf":[{"$ref":"#/components/schemas/BillingCompatibilityVersion"}]},"isDeletable":{"type":"boolean"},"displayDeliveryAddress":{"type":"boolean"},"finalizedAt":{"type":"number"},"lastSendByEmailAt":{"type":"number"},"themeId":{"type":"string","description":"ID of the theme applied to this document when set"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ReadBillingDetailsLineDto"}},"total":{"$ref":"#/components/schemas/ReadInvoiceTotalDto"},"discount":{"$ref":"#/components/schemas/DiscountDto"},"parent":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"}]},"advances":{"description":"Advances deducted from the asset total (for V3+ assets from final invoice)","type":"array","items":{"$ref":"#/components/schemas/ReadAdvanceDto"}},"refundAt":{"type":"number"},"latePenalty":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLatePenaltyDto"}]},"lumpSumCompensation":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingLumpSumCompensationDto"}]},"discountAdvancePayment":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/BillingDiscountAdvancePaymentDto"}]},"displaySettings":{"$ref":"#/components/schemas/DisplayBillingSettingsDto"},"dueAt":{"type":"number"},"paymentDelay":{"allOf":[{"$ref":"#/components/schemas/PaymentDelay"}]},"includeDiscountDisbursement":{"type":"boolean"}},"required":["id","type","state","customer","locale","emittedAt","finalizable","test","isEditable","currencyCode","currency","attachments","finalizeRequirements","warnings","emitter","billingLegals","createdAt","updatedAt","compatibilityVersion","isDeletable","displayDeliveryAddress","lines","total","displaySettings","paymentDelay","includeDiscountDisbursement"]}}},"paths":{"/v2/billing/{billingId}/finalize":{"patch":{"operationId":"BillingController_finalize_v2","parameters":[{"name":"billingId","required":true,"in":"path","description":"ID of the billing to finalize","schema":{"type":"string"}}],"responses":{"200":{"description":"Billing finalized successfully","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ReadInvoiceDto"},{"$ref":"#/components/schemas/ReadEstimateDto"},{"$ref":"#/components/schemas/ReadAdvanceDto"},{"$ref":"#/components/schemas/ReadAssetDto"}]}}}},"401":{"description":"Unauthorized"},"404":{"description":"Invoice not found"}},"summary":"Finalize a billing document","tags":["Billing"]}}}} ``` ## Télécharger un avoir Vous pouvez télécharger un avoir en PDF et spécifier la langue appliquée sur le document. ## GET /v2/billing/{billingId}/download > Download a billing document ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"BillingLocale":{"type":"string","enum":["fr","en","de","it","nl","pt","es"]}}},"paths":{"/v2/billing/{billingId}/download":{"get":{"operationId":"BillingController_downloadPDF_v2","parameters":[{"name":"billingId","required":true,"in":"path","schema":{"type":"string"}},{"name":"locale","required":false,"in":"query","description":"Locale for the PDF generation","schema":{"$ref":"#/components/schemas/BillingLocale"}}],"responses":{"200":{"description":"","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Billing document not found"}},"summary":"Download a billing document","tags":["Billing"]}}}} ``` ## Envoyer un avoir par email ## POST /v2/billing/{billingId}/send-by-email > Send billing document by email ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"SendBillingByEmailDto":{"type":"object","properties":{"emails":{"description":"List of email addresses to send the billing document to","maxItems":10,"type":"array","items":{"type":"string"}},"subject":{"type":"string","description":"Email subject","maxLength":255},"content":{"type":"string","description":"Email content (HTML supported)"},"inCopy":{"type":"boolean","description":"Whether to send a copy to the sender","default":false}},"required":["emails","subject","content"]}}},"paths":{"/v2/billing/{billingId}/send-by-email":{"post":{"operationId":"BillingController_sendByEmail_v2","parameters":[{"name":"billingId","required":true,"in":"path","description":"ID of the billing document to send","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendBillingByEmailDto"}}}},"responses":{"204":{"description":"Email sent successfully"},"400":{"description":"Too many emails sent for this billing"},"401":{"description":"Unauthorized"},"403":{"description":"Plan feature not available"},"404":{"description":"Billing document not found"}},"summary":"Send billing document by email","tags":["Billing"]}}}} ``` # Produits Créez des produits dans le catalogue et configurez type, unité et code TVA. Créez et gérez des produits dans votre catalogue. ## Lister les produits Récupère les produits du catalogue, paginés et filtrables. ## GET /v2/catalog > List products with pagination ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CatalogOrderBy":{"type":"string","enum":["createdAt","designation"]},"OrderDirection":{"type":"string","enum":["ASC","DESC"]},"ReadCatalogCollectionDto":{"type":"object","properties":{"countWithoutFilters":{"type":"number"},"totalDocs":{"type":"number"},"limit":{"type":"number"},"totalPages":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"},"nextPage":{"type":"number"},"page":{"type":"number"},"prevPage":{"type":"number"},"docs":{"type":"array","items":{"$ref":"#/components/schemas/ReadProductListItemDto"}}},"required":["countWithoutFilters","totalDocs","limit","totalPages","hasNextPage","hasPrevPage","nextPage","page","prevPage","docs"]},"ReadProductListItemDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"unit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"description":{"type":"string","nullable":true},"reference":{"type":"string","nullable":true},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"isDeliveryOfGood":{"type":"boolean"},"taxesIncluded":{"type":"boolean"},"purchasePrice":{"type":"number","description":"Purchase price per unit without taxes"},"productMargin":{"type":"number","description":"Product margin"},"unitPrice":{"type":"number","description":"Price per unit without taxes"},"priceWithoutTaxes":{"type":"number","description":"Total price without taxes"},"vatAmount":{"type":"number","description":"VAT amount"},"priceWithTaxes":{"type":"number","description":"Total price including taxes"},"stock":{"type":"number","description":"Stock"}},"required":["id","type","unit","designation","vatCode","isDeliveryOfGood","taxesIncluded","unitPrice","priceWithoutTaxes","vatAmount","priceWithTaxes","stock"]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]}}},"paths":{"/v2/catalog":{"get":{"operationId":"CatalogController_paginate_v2","parameters":[{"name":"page","required":true,"in":"query","description":"The page number to retrieve","schema":{"minimum":1,"type":"number"}},{"name":"limit","required":true,"in":"query","description":"The number of items per page","schema":{"minimum":1,"type":"number"}},{"name":"search","required":false,"in":"query","description":"Optional search term to filter the catalog","schema":{"type":"string"}},{"name":"orderBy","required":false,"in":"query","description":"Optional order by to filter the catalog","schema":{"$ref":"#/components/schemas/CatalogOrderBy"}},{"name":"orderDirection","required":false,"in":"query","description":"Optional order direction to filter the catalog","schema":{"$ref":"#/components/schemas/OrderDirection"}},{"name":"sapCompatible","required":false,"in":"query","description":"Optional sap compatible to filter the catalog","schema":{"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadCatalogCollectionDto"}}}}},"summary":"List products with pagination","tags":["catalog"]}}}} ``` ### Paramètres de requête Champs requis : * `page` : numéro de page (à partir de `1`) * `limit` : nombre d'éléments par page Champs optionnels : * `search` : terme de recherche (filtre sur la désignation, la référence, etc.) * `orderBy` : champ de tri (voir valeurs ci-dessous) * `orderDirection` : sens du tri (`ASC` ou `DESC`) * `sapCompatible` : `true` pour ne lister que les produits compatibles avec une comptabilité SAP #### `orderBy` (CatalogOrderBy) * `createdAt` (défaut) * `designation` #### `orderDirection` (OrderDirection) * `ASC` * `DESC` #### Exemple ```http GET /v2/catalog?page=1&limit=20&search=widget&orderBy=designation&orderDirection=ASC ``` ### Réponse (`ReadCatalogCollectionDto`) Réponse paginée contenant un tableau `docs` de produits, ainsi que les métadonnées de pagination (`total`, `page`, `limit`, `pages`, etc.). ## Récupérer un produit Renvoie le détail complet d'un produit à partir de son identifiant. ## GET /v2/catalog/product/{productId} > Retrieve a product by id ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ReadProductDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"description":"Type of the product","allOf":[{"$ref":"#/components/schemas/ProductType"}]},"unit":{"description":"Unit of measurement for the product","allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string","description":"Name or title of the product"},"description":{"type":"string","nullable":true,"description":"Detailed description of the product"},"reference":{"type":"string","nullable":true,"description":"Product reference code"},"vatCode":{"description":"VAT code applicable to this product","allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"nullable":true,"description":"Personal service activity classification, if applicable","allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"isDeliveryOfGood":{"type":"boolean","description":"Indicates if the product involves delivery of physical goods"},"taxesIncluded":{"type":"boolean","description":"Indicates if the prices include taxes"},"purchasePrice":{"type":"number","description":"Purchase price per unit without taxes"},"productMargin":{"type":"number","description":"Product margin"},"lockUnitPrice":{"type":"boolean","description":"Indicates if the unit price is locked"},"unitPrice":{"type":"number","description":"Price per unit without taxes"},"priceWithoutTaxes":{"type":"number","description":"Total price without taxes"},"vatAmount":{"type":"number","description":"VAT amount"},"priceWithTaxes":{"type":"number","description":"Total price including taxes"},"stock":{"type":"number","description":"Stock"}},"required":["id","type","unit","designation","vatCode","isDeliveryOfGood","taxesIncluded","unitPrice","priceWithoutTaxes","vatAmount","priceWithTaxes","stock"]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]}}},"paths":{"/v2/catalog/product/{productId}":{"get":{"operationId":"CatalogController_retrieve_v2","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadProductDto"}}}}},"summary":"Retrieve a product by id","tags":["catalog"]}}}} ``` ### Paramètres de chemin * `productId` : identifiant du produit ### Réponse (`ReadProductDto`) Renvoie l'objet produit complet avec ses prix, sa TVA, son stock, sa description, etc. ## Créer un produit ## POST /v2/catalog/product > Create a new product ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateProductDto":{"type":"object","properties":{"type":{"description":"The type of the product","allOf":[{"$ref":"#/components/schemas/ProductType"}]},"unit":{"description":"The unit of measurement for the product","allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string","description":"The name or title of the product"},"amountInCents":{"type":"number","description":"The price of the product in cents"},"purchasePrice":{"type":"number","description":"The purchase price of the product in cents"},"productMargin":{"type":"number","description":"The margin of the product in percentage"},"lockUnitPrice":{"type":"boolean","description":"Whether the unit price is locked or not calculating from purchase price and product margin","default":false},"taxesIncluded":{"type":"boolean","description":"Whether the amount includes taxes"},"vatCode":{"description":"The VAT code applicable to the product","default":"FR_00HT","allOf":[{"$ref":"#/components/schemas/VatCode"}]},"isDeliveryOfGood":{"type":"boolean","description":"Whether the product involves delivery of a physical good"},"description":{"type":"string","description":"Detailed description of the product"},"reference":{"type":"string","description":"Product reference or SKU"},"stock":{"type":"number","description":"The stock quantity"}},"required":["type","unit","designation"]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"ReadProductDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"description":"Type of the product","allOf":[{"$ref":"#/components/schemas/ProductType"}]},"unit":{"description":"Unit of measurement for the product","allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string","description":"Name or title of the product"},"description":{"type":"string","nullable":true,"description":"Detailed description of the product"},"reference":{"type":"string","nullable":true,"description":"Product reference code"},"vatCode":{"description":"VAT code applicable to this product","allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"nullable":true,"description":"Personal service activity classification, if applicable","allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"isDeliveryOfGood":{"type":"boolean","description":"Indicates if the product involves delivery of physical goods"},"taxesIncluded":{"type":"boolean","description":"Indicates if the prices include taxes"},"purchasePrice":{"type":"number","description":"Purchase price per unit without taxes"},"productMargin":{"type":"number","description":"Product margin"},"lockUnitPrice":{"type":"boolean","description":"Indicates if the unit price is locked"},"unitPrice":{"type":"number","description":"Price per unit without taxes"},"priceWithoutTaxes":{"type":"number","description":"Total price without taxes"},"vatAmount":{"type":"number","description":"VAT amount"},"priceWithTaxes":{"type":"number","description":"Total price including taxes"},"stock":{"type":"number","description":"Stock"}},"required":["id","type","unit","designation","vatCode","isDeliveryOfGood","taxesIncluded","unitPrice","priceWithoutTaxes","vatAmount","priceWithTaxes","stock"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]}}},"paths":{"/v2/catalog/product":{"post":{"operationId":"CatalogController_create_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadProductDto"}}}}},"summary":"Create a new product","tags":["catalog"]}}}} ``` ### Corps de requête (`CreateProductDto`) Champs requis : * `type` : type de produit (ex: `service_delivery`) * `unit` : unité de mesure (ex: `unit`) * `designation` : libellé du produit Champs optionnels : * `amountInCents` : prix de vente en centimes * `purchasePrice` : prix d'achat en centimes * `productMargin` : marge en pourcentage * `lockUnitPrice` : bloque le prix unitaire * `taxesIncluded` : prix TTC si `true` * `vatCode` : code TVA (défaut `FR_00HT`) * `isDeliveryOfGood` : livraison d'un bien physique * `description` : description détaillée (HTML nettoyé) * `reference` : référence / SKU * `stock` : stock disponible ### Valeurs possibles Les champs `type` et `unit` attendent des **chaînes** (`string`) en `snake_case`. #### `type` (ProductType) * `sale_of_goods` * `service_delivery` * `commercial_or_craft_services` * `sale_of_manufactured_goods` * `disbursement` #### `unit` (ProductUnit)
Voir toutes les valeurs ``` unit gram hour day week fixed_rate year character line license article month kilogram kilometer liter batch meter square_meter cubic_meter linear_meter person ton word page leaflet paragraph minute overnight_stay ```
#### `vatCode` (VatCode) Le champ `vatCode` attend une chaîne (`string`). Valeurs disponibles : * `FR_210` * `FR_550` * `FR_850` * `FR_1000` * `FR_2000` * `FR_00HT` (défaut) * `FR_00UE` * `FR_0HUE` #### Exemple ```json { "type": "service_delivery", "unit": "unit", "designation": "Premium Widget", "amountInCents": 1999, "taxesIncluded": true, "vatCode": "FR_00HT", "isDeliveryOfGood": true, "description": "High-quality widget for various applications", "reference": "WIDGET-001", "stock": 20 } ``` ## Mettre à jour un produit > Le verbe HTTP est `PUT`. **Tous** les champs requis de `UpdateProductDto` doivent être envoyés à chaque appel (pas uniquement les champs modifiés), sinon ils seront écrasés ou refusés en validation. ## PUT /v2/catalog/product/{productId} > Update a product ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"UpdateProductDto":{"type":"object","properties":{"type":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"unit":{"allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string"},"amountInCents":{"type":"number","description":"The price of the product in cents"},"purchasePrice":{"type":"number","description":"The purchase price of the product in cents"},"productMargin":{"type":"number","description":"The margin of the product in percentage"},"lockUnitPrice":{"type":"boolean","description":"Whether the unit price is locked or not calculating from purchase price and product margin","default":false},"taxesIncluded":{"type":"boolean"},"vatCode":{"allOf":[{"$ref":"#/components/schemas/VatCode"}]},"isDeliveryOfGood":{"type":"boolean"},"description":{"type":"string"},"reference":{"type":"string"},"stock":{"type":"number"}},"required":["type","unit","designation","vatCode"]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"ProductUnit":{"type":"number","enum":[14,1,2,3,22,23,24,25,26,21,20,4,5,6,7,8,9,10,11,12,13,15,16,17,18,19,27,28]},"VatCode":{"type":"string","enum":["FR_210","FR_550","FR_850","FR_1000","FR_2000","FR_00HT","FR_00UE","FR_0HUE"]},"ReadProductDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"description":"Type of the product","allOf":[{"$ref":"#/components/schemas/ProductType"}]},"unit":{"description":"Unit of measurement for the product","allOf":[{"$ref":"#/components/schemas/ProductUnit"}]},"designation":{"type":"string","description":"Name or title of the product"},"description":{"type":"string","nullable":true,"description":"Detailed description of the product"},"reference":{"type":"string","nullable":true,"description":"Product reference code"},"vatCode":{"description":"VAT code applicable to this product","allOf":[{"$ref":"#/components/schemas/VatCode"}]},"personalServiceActivity":{"nullable":true,"description":"Personal service activity classification, if applicable","allOf":[{"$ref":"#/components/schemas/PersonalServiceActivity"}]},"isDeliveryOfGood":{"type":"boolean","description":"Indicates if the product involves delivery of physical goods"},"taxesIncluded":{"type":"boolean","description":"Indicates if the prices include taxes"},"purchasePrice":{"type":"number","description":"Purchase price per unit without taxes"},"productMargin":{"type":"number","description":"Product margin"},"lockUnitPrice":{"type":"boolean","description":"Indicates if the unit price is locked"},"unitPrice":{"type":"number","description":"Price per unit without taxes"},"priceWithoutTaxes":{"type":"number","description":"Total price without taxes"},"vatAmount":{"type":"number","description":"VAT amount"},"priceWithTaxes":{"type":"number","description":"Total price including taxes"},"stock":{"type":"number","description":"Stock"}},"required":["id","type","unit","designation","vatCode","isDeliveryOfGood","taxesIncluded","unitPrice","priceWithoutTaxes","vatAmount","priceWithTaxes","stock"]},"PersonalServiceActivity":{"type":"string","enum":["GARDE_ENFANT_HANDICAPE","ACCOMPAGNEMENT_ENFANT_HANDICAPE","AIDE_HUMAINE","CONDUITE_VEHICULE_PERSONNEL","AIDE_AU_DEPLACEMENT","ENTRETIEN_DE_LA_MAISON","JARDINAGE","BRICOLAGE","GARDE_ENFANT_PLUS_DE_6_ANS","SOUTIEN_SCOLAIRE_COURS_A_DOMICILE","SOIN_ESTHETIQUE_A_DOMICILE","PREPARATION_REPAS_A_DOMICILE","LIVRAISON_REPAS_A_DOMICILE","COLLECTE_ET_LIVRAISON_DE_LINGE_REPASSE","LIVRAISON_COURSES_A_DOMICILE","ASSISTANCE_INFORMATIQUE","SOINS_ET_PROMENADES_ANIMAUX_DE_COMPAGNIE_POUR_PERSONNES_DEPENDANTES","MAINTENANCE_ENTRETIEN_ET_VIGILANCE_DE_LA_RESIDENCE_PRINCIPALE","ASSISTANCE_ADMINISTRATIVE","ACCOMPAGNEMENT_ENFANT_PLUS_DE_6_ANS","TELEASSISTANCE","INTERPRETE_LANGUE_DES_SIGNES","CONDUITE_VEHICULE_PERSONNEL_EN_CAS_INVALIDITE_TEMPORAIRE","ACCOMPAGNEMENT_DEPLACEMENTS_EN_DEHORS_DU_DOMICILE","ASSISTANCE_PERSONNES_TEMPORAIREMENT_DEPENDANTES_A_DOMICILE","COORDINATION_ET_GESTION","DIVERS_NON_ELIGIBLE"]}}},"paths":{"/v2/catalog/product/{productId}":{"put":{"operationId":"CatalogController_update_v2","parameters":[{"name":"productId","required":true,"in":"path","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadProductDto"}}}}},"summary":"Update a product","tags":["catalog"]}}}} ``` ### Paramètres de chemin * `productId` : identifiant du produit à mettre à jour ### Corps de requête (`UpdateProductDto`) Champs requis : * `type` : type de produit (voir [valeurs](#type-producttype)) * `unit` : unité de mesure (voir [valeurs](#unit-productunit)) * `designation` : libellé du produit * `vatCode` : code TVA (voir [valeurs](#vatcode-vatcode)) Champs optionnels : * `amountInCents` : prix de vente en centimes * `purchasePrice` : prix d'achat en centimes * `productMargin` : marge en pourcentage * `lockUnitPrice` : bloque le prix unitaire (défaut `false`) * `taxesIncluded` : prix TTC si `true` * `isDeliveryOfGood` : livraison d'un bien physique * `description` : description détaillée (HTML nettoyé) * `reference` : référence / SKU * `stock` : stock disponible #### Exemple ```json { "type": "service_delivery", "unit": "unit", "designation": "Premium Widget", "amountInCents": 2499, "vatCode": "FR_00HT", "taxesIncluded": true, "isDeliveryOfGood": true, "description": "Updated description", "reference": "WIDGET-001", "stock": 15 } ``` ### Réponse Renvoie le produit mis à jour (`ReadProductDto`). # Livre des recettes ## POST /incomeBook > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateIncomeBookItemDto":{"type":"object","properties":{"paidAt":{"format":"date-time","type":"string","default":"2022-03-01"},"paymentMethodUsed":{"type":"object","default":{"value":1}},"vatAmount":{"type":"number"},"vatId":{"type":"number"},"client":{"type":"string"},"priceWithoutTax":{"type":"number"},"priceTotalTax":{"type":"number"},"reference":{"type":"string"},"productType":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"isSap":{"type":"boolean"},"isTaxIncluded":{"type":"boolean"},"file":{"type":"object"}},"required":["client","priceWithoutTax","priceTotalTax","productType"]},"ProductType":{"type":"number","enum":[1,2,3,4,5]},"ReadIncomeBookItemDto":{"type":"object","properties":{"_id":{"type":"string"},"billing":{"type":"object"},"transactionId":{"type":"string"},"billingObject":{"type":"object"},"paymentMethodUsed":{"$ref":"#/components/schemas/ReadPaymentMethodUsed"},"priceTotalTax":{"type":"number"},"priceWithoutTax":{"type":"number"},"productType":{"allOf":[{"$ref":"#/components/schemas/ProductType"}]},"reference":{"type":"string"},"vatAmount":{"type":"number"},"vatId":{"type":"number"},"vatMention":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/VatMention"}]},"isTaxIncluded":{"type":"boolean"}},"required":["_id","paymentMethodUsed","priceTotalTax","priceWithoutTax","productType","reference","vatAmount"]},"ReadPaymentMethodUsed":{"type":"object","properties":{"value":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodLegacy"}]},"other":{"type":"string"}},"required":["value"]},"PaymentMethodLegacy":{"type":"number","enum":[1,2,3,4,5,6,7,8,9]},"VatMention":{"type":"number","enum":[1,2,3,4,5,6,13,7,8,9,10,11,12,14,15,16,17,18,19,20,21]}}},"paths":{"/incomeBook":{"post":{"operationId":"IncomeBookController_postIncomeBookItem","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIncomeBookItemDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadIncomeBookItemDto"}}}}},"tags":["IncomeBook"]}}}} ``` ## DELETE /incomeBook/{id} > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/incomeBook/{id}":{"delete":{"operationId":"IncomeBookController_deletePurchaseIncomeBookItem","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["IncomeBook"]}}}} ``` # Livre des achats ## POST /v2/purchaseRegister > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"CreateAccountingBookDto":{"type":"object","properties":{"valueDate":{"format":"date-time","type":"string"},"paymentMethodUsed":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodLegacy"}]},"otherPaymentMethodUsed":{"type":"string"},"amount":{"type":"number"},"thirdPartyId":{"type":"string"},"label":{"type":"string"},"reference":{"type":"string"},"files":{"type":"array","items":{"type":"string"}},"entries":{"type":"array","items":{"$ref":"#/components/schemas/AnnotateEntryDto"}}},"required":["valueDate","paymentMethodUsed","amount","thirdPartyId","label","entries"]},"PaymentMethodLegacy":{"type":"number","enum":[1,2,3,4,5,6,7,8,9]},"AnnotateEntryDto":{"type":"object","properties":{"vatId":{"type":"number"},"accountingAccountNumber":{"type":"number"},"isPersonal":{"type":"boolean"},"amount":{"type":"number"}},"required":["isPersonal","amount"]},"ReadAccountingBookDto":{"type":"object","properties":{"id":{"type":"string"},"valueDate":{"format":"date-time","type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/AccountingBookType"}]},"files":{"type":"array","items":{"type":"string"}},"label":{"type":"string"},"reference":{"type":"string"},"paymentMethodUsed":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodLegacy"}]},"otherPaymentMethodUsed":{"type":"string"},"thirdPartyId":{"type":"string"},"thirdParty":{"$ref":"#/components/schemas/ReadThirdPartyDto"},"amount":{"type":"number"},"vatAmount":{"type":"number"},"hasTransaction":{"type":"boolean"},"fileCount":{"type":"boolean"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/ReadEntryDto"}},"oldNature":{"type":"string"},"companyId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","valueDate","type","label","paymentMethodUsed","thirdPartyId","thirdParty","amount","vatAmount","hasTransaction","fileCount","entries","companyId","createdAt","updatedAt"]},"AccountingBookType":{"type":"string","enum":["income","purchase"]},"ReadThirdPartyDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"allOf":[{"$ref":"#/components/schemas/ThirdPartyType"}]},"additionalAddress":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"companyId":{"type":"string"},"commercialName":{"type":"string"},"contacts":{"type":"array","items":{"$ref":"#/components/schemas/LegacyReadContactDto"}},"country":{"type":"string"},"keywords":{"type":"string"},"language":{"type":"string"},"nafCode":{"type":"string"},"name":{"type":"string"},"notes":{"type":"string"},"phone":{"type":"string"},"siren":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"website":{"type":"string"},"zipCode":{"type":"string"},"accountingAccountId":{"type":"string"},"accountingAccount":{"type":"object"},"createdAt":{"format":"date-time","type":"string"},"deletedAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","type","companyId","accountingAccountId"]},"ThirdPartyType":{"type":"string","enum":["provider","customer"]},"LegacyReadContactDto":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"firstname":{"type":"string"},"keywords":{"type":"string"},"language":{"type":"string"},"lastname":{"type":"string"},"notes":{"type":"string"},"phone":{"type":"string"},"thirdPartyId":{"type":"string"},"role":{"type":"string"},"website":{"type":"string"}},"required":["id"]},"ReadEntryDto":{"type":"object","properties":{"id":{"type":"string"},"valueDate":{"type":"object"},"label":{"type":"string"},"fullLabel":{"type":"string"},"debit":{"type":"number"},"credit":{"type":"number"},"amount":{"type":"number"},"parent":{"type":"boolean"},"vatRate":{"type":"object"},"vatAmount":{"type":"number"},"vatId":{"type":"number"},"transactionId":{"type":"string"},"lockedAt":{"type":"object"},"lockedBy":{"type":"object"},"transaction":{"$ref":"#/components/schemas/ReadTransactionDto"},"isPersonal":{"type":"boolean"},"companyId":{"type":"string"},"company":{"$ref":"#/components/schemas/ReadCompanyDto"},"accountingAccountId":{"type":"string"},"accountingAccount":{"$ref":"#/components/schemas/ReadAccountingAccountDto"},"hasBeenUpdatedByUser":{"type":"boolean"},"isAnnotatedWithRules":{"type":"boolean"},"updatedAt":{"type":"object"},"createdAt":{"type":"object"}},"required":["id","valueDate","label","fullLabel","debit","credit","amount","parent","vatRate","vatAmount","vatId","transactionId","lockedAt","lockedBy","isPersonal","companyId","hasBeenUpdatedByUser","isAnnotatedWithRules","updatedAt","createdAt"]},"ReadTransactionDto":{"type":"object","properties":{"id":{"type":"string"},"account":{"$ref":"#/components/schemas/ReadAccountDto"},"accountId":{"type":"string"},"amount":{"type":"number"},"bridgeAccountId":{"type":"number"},"bridgeCategoryId":{"type":"number"},"bridgeTransactionId":{"type":"number"},"currencyCode":{"type":"string"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/ReadEntryDto"}},"fullLabel":{"type":"string"},"isDeleted":{"type":"boolean"},"isFuture":{"type":"boolean"},"label":{"type":"string"},"paymentMethod":{"allOf":[{"$ref":"#/components/schemas/PaymentMethodLegacy"}]},"otherPaymentMethodUsed":{"type":"object"},"showClientSide":{"type":"boolean"},"hasAccountingBook":{"type":"boolean"},"fileCount":{"type":"number"},"operationType":{"allOf":[{"$ref":"#/components/schemas/OperationType"}]},"suggestedAccountingAccount":{"$ref":"#/components/schemas/ReadSuggestedAccountingAccountDto"},"thirdPartyId":{"type":"object"},"thirdParty":{"$ref":"#/components/schemas/ReadThirdPartyDto"},"lockedAt":{"type":"object"},"lockedBy":{"type":"object"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"bridgeUpdatedAt":{"format":"date-time","type":"string"},"valueDate":{"format":"date-time","type":"string"}},"required":["id","account","accountId","amount","bridgeAccountId","bridgeCategoryId","bridgeTransactionId","currencyCode","entries","fullLabel","isDeleted","isFuture","label","paymentMethod","otherPaymentMethodUsed","showClientSide","hasAccountingBook","operationType","thirdPartyId","thirdParty","lockedAt","lockedBy","createdAt","updatedAt","bridgeUpdatedAt","valueDate"]},"ReadAccountDto":{"type":"object","properties":{"id":{"type":"string"},"isNew":{"type":"boolean"},"accountingAccountId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"currencyCode":{"type":"string"},"bridgeAccountId":{"type":"number"},"bridgeItemId":{"type":"number"},"bankinItemId":{"type":"string"},"bankListId":{"type":"number"},"bankList":{"type":"object"},"isSynchronized":{"type":"boolean"},"synchronizedAt":{"type":"object"},"desynchronizedAt":{"type":"object"},"startSynchronizedAt":{"type":"object"},"firstSynchronizedAt":{"type":"object"},"lastSyncAt":{"type":"object"},"companyId":{"type":"string"},"accountBalance":{"type":"array","items":{"type":"string"}},"bridgeUpdatedAt":{"format":"date-time","type":"string"},"numberOfTransactionsToAnnotate":{"type":"number"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["accountingAccountId","name","type","currencyCode","bridgeAccountId","bridgeItemId","bankinItemId","bankListId","isSynchronized","synchronizedAt","desynchronizedAt","startSynchronizedAt","firstSynchronizedAt","lastSyncAt","companyId","bridgeUpdatedAt"]},"OperationType":{"type":"string","enum":["sale","purchase","refund","asset"]},"ReadSuggestedAccountingAccountDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"abbyProfessionalAccountingAccountNumber":{"type":"number"},"abbyPersonalAccountingAccountNumber":{"type":"number"}},"required":["id","name"]},"ReadCompanyDto":{"type":"object","properties":{"id":{"type":"string"},"activity":{"$ref":"#/components/schemas/ReadActivityDto"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ReadStripeProductDto"}},"productsCompany":{"type":"array","items":{"$ref":"#/components/schemas/ReadCompanyStripeProductDto"}},"additionalAddress":{"type":"string"},"address":{"type":"string"},"caseNumberCommercialCourt":{"type":"string","nullable":true,"deprecated":true},"category":{"type":"string"},"city":{"$ref":"#/components/schemas/ReadCityDto"},"cityId":{"type":"string"},"cityName":{"type":"string","nullable":true,"description":"Free-text city name. Effective city: city?.name ?? cityName."},"commercialCourt":{"type":"string","nullable":true,"deprecated":true},"commercialCourtCode":{"type":"string","nullable":true,"deprecated":true},"rcsGreffeCode":{"type":"string","nullable":true},"rsacGreffeCode":{"type":"string","nullable":true},"commercialName":{"type":"string"},"creationActivityDescription":{"type":"string"},"creationDate":{"format":"date-time","type":"string"},"creationFinishedAt":{"format":"date-time","type":"string"},"registeredType":{"allOf":[{"$ref":"#/components/schemas/RegisteredType"}]},"opportunityType":{"allOf":[{"$ref":"#/components/schemas/OpportunityType"}]},"currentStep":{"allOf":[{"$ref":"#/components/schemas/CreationCompanyStep"}]},"currentDashboardStep":{"allOf":[{"$ref":"#/components/schemas/CreationDashboardStep"}]},"creationId":{"type":"string"},"declarationRecurrence":{"allOf":[{"$ref":"#/components/schemas/Recurrence"}]},"declarationPlatform":{"allOf":[{"$ref":"#/components/schemas/DeclarationPlatform"}]},"hasVat":{"type":"boolean"},"hasAcre":{"type":"boolean"},"impositionType":{"allOf":[{"$ref":"#/components/schemas/ImpositionType"}]},"inseeImmatriculationDate":{"format":"date-time","type":"string"},"legalStatus":{"allOf":[{"$ref":"#/components/schemas/LegalStatus"}]},"taxSystem":{"allOf":[{"$ref":"#/components/schemas/TaxSystem"}]},"nafCode":{"type":"string"},"name":{"type":"string"},"otherActivity":{"type":"string"},"secondaryActivity":{"type":"string"},"rcsImmatriculationDate":{"format":"date-time","type":"string"},"rcsNumber":{"type":"string"},"rmNumber":{"type":"string","deprecated":true},"rneNumber":{"type":"string"},"rsacNumber":{"type":"string"},"rnaNumber":{"type":"string"},"selectedRegisters":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/RegisterType"}},"departmentRmImmatriculation":{"type":"string"},"registeredAt":{"format":"date-time","type":"string"},"shareCapital":{"type":"number"},"siren":{"type":"string"},"siret":{"type":"string"},"vatNumber":{"type":"string"},"vatRecurrence":{"allOf":[{"$ref":"#/components/schemas/Recurrence"}]},"zipCode":{"type":"string"},"trackingCompanySteps":{"type":"array","items":{"$ref":"#/components/schemas/ReadTrackingCompanyStepDto"}},"notes":{"type":"array","items":{"$ref":"#/components/schemas/ReadNoteDto"}},"referent":{"$ref":"#/components/schemas/ReadUserDto"},"signatureFileId":{"type":"string"},"referentId":{"type":"string"},"addressType":{"allOf":[{"$ref":"#/components/schemas/AddressType"}]},"recordNumber":{"type":"string"},"customerId":{"type":"string"},"declarationUserId":{"type":"string"},"declarationUser":{"$ref":"#/components/schemas/ReadUserDto"},"startDeclarationAt":{"format":"date-time","type":"string"},"endDeclarationAt":{"format":"date-time","type":"string"},"verifiedAt":{"format":"date-time","type":"string"},"sapAgreementDate":{"format":"date-time","type":"string"},"firstVatReportingDate":{"format":"date-time","type":"string"}},"required":["id","city","referent"]},"ReadActivityDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"},"liberalType":{"allOf":[{"$ref":"#/components/schemas/LiberalType"}]},"isRegulated":{"type":"boolean"},"parentId":{"type":"number"},"parent":{"$ref":"#/components/schemas/ReadParentActivityDto"},"hidden":{"type":"boolean"},"isSap":{"type":"boolean"}},"required":["id","name","isRegulated","parent","hidden","isSap"]},"LiberalType":{"type":"number","enum":[1,2,3]},"ReadParentActivityDto":{"type":"object","properties":{"id":{"type":"number"},"name":{"type":"string"}},"required":["id","name"]},"ReadStripeProductDto":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/StripeProductType"}]},"productId":{"type":"string"},"multiple":{"type":"boolean"},"recurring":{"type":"boolean"},"trial":{"type":"object"},"requireCreditCard":{"type":"boolean"}},"required":["id","productId","multiple","recurring","trial","requireCreditCard"]},"StripeProductType":{"type":"string","enum":["abby_plus","acre","cfe","abby_free","abby_start","abby_creation_start","abby_creation_start_premium","abby_creation_start_business","abby_pro","abby_business","abby_ce","meeting_with_an_expert","formation_client","formation_communiquer","formation_client_communiquer_discount","billing_template_2","billing_template_3","abby_academie_marketing_communication","abby_academie_creation","abby_contact"]},"ReadCompanyStripeProductDto":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"company":{"$ref":"#/components/schemas/ReadCompanyDto"},"productId":{"allOf":[{"$ref":"#/components/schemas/StripeProductType"}]},"product":{"$ref":"#/components/schemas/ReadStripeProductDto"},"amount":{"type":"number"},"frequency":{"allOf":[{"$ref":"#/components/schemas/StripeProductFrequency"}]},"subscriptionId":{"type":"string"},"consumedAt":{"format":"date-time","type":"string"},"manuallyAdded":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"failedBillingDueDate":{"format":"date-time","type":"string"},"lastFailedAt":{"format":"date-time","type":"string"},"failedInvoiceUrl":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"lockUntil":{"format":"date-time","type":"string"},"deletedAt":{"format":"date-time","type":"string"},"canceledAt":{"format":"date-time","type":"string"},"trialAt":{"format":"date-time","type":"string"},"lastPaidAt":{"format":"date-time","type":"string"},"extendedTrialAt":{"format":"date-time","type":"string"}},"required":["id","companyId","productId"]},"StripeProductFrequency":{"type":"string","enum":["year","month","semiannual"]},"ReadCityDto":{"type":"object","properties":{"cityCode":{"type":"string"},"name":{"type":"string"}},"required":["cityCode","name"]},"RegisteredType":{"type":"number","enum":[1,2,3]},"OpportunityType":{"type":"string","enum":["orders","projects","opportunities"]},"CreationCompanyStep":{"type":"string","enum":["creation_requested","files_requested","declaration_sent","declaration_refused","company_created","urssaf_account_created","impots_account_created","acre_requested","cfe_declared","all_files_deposed","has_file_refused","all_files_validated","none"]},"CreationDashboardStep":{"type":"string","enum":["files_to_validate","declaration_to_do","declaration_in_progress","pending_declaration","declaration_to_report","declaration_refused","declaration_pending_denial","declaration_to_retry","regularisation_gu","refus_gu","to_call_cfe","declared","declaration_accepted","to_call","ended","abandoned","none"]},"Recurrence":{"type":"number","enum":[1,2,3]},"DeclarationPlatform":{"type":"number","enum":[6,1,2,3,4,5]},"ImpositionType":{"type":"number","enum":[1,2]},"LegalStatus":{"type":"number","enum":[1,2,3,4,5,6,7,8,9,10,11,12,13,14]},"TaxSystem":{"type":"string","enum":["micro_bic","micro_bnc","micro_bic_or_bnc","micro_ba","micro_foncier","micro_revenu_foncier_ir_2072_2044","reel_simplifie_ir_2033_2031","reel_normal_ir_2033_2031","reel_simplifie_is_2033_2065","reel_normal_is_2050_2065","declaration_controlee_2035","association_non_lucratif"]},"RegisterType":{"type":"string","enum":["RCS","RNE","RSAC","RNA"]},"ReadTrackingCompanyStepDto":{"type":"object","properties":{"companyId":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"currentStep":{"allOf":[{"$ref":"#/components/schemas/CreationCompanyStep"}]},"currentDashboardStep":{"allOf":[{"$ref":"#/components/schemas/CreationDashboardStep"}]},"referentId":{"type":"string"},"referentFullname":{"type":"string"},"authorId":{"type":"string"},"authorFullname":{"type":"string"}},"required":["companyId","createdAt","currentStep","currentDashboardStep"]},"ReadNoteDto":{"type":"object","properties":{"id":{"type":"string"},"author":{"$ref":"#/components/schemas/ReadUserDto"},"authorId":{"type":"string"},"company":{"$ref":"#/components/schemas/ReadCompanyDto"},"companyId":{"type":"string"},"text":{"type":"string"}},"required":["id","authorId","companyId","text"]},"ReadUserDto":{"type":"object","properties":{"id":{"type":"string"},"affiliationUrl":{"type":"string"},"affilaeClickId":{"type":"string"},"isCMA":{"type":"boolean"},"createdAt":{"format":"date-time","type":"string"},"birthDate":{"type":"object"},"email":{"type":"string"},"fullName":{"type":"string"},"firebaseToken":{"type":"string"},"profilePictureId":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"phone":{"type":"string"},"zipCode":{"type":"string"},"socialSecurityNumber":{"type":"string"},"companies":{"type":"array","items":{"$ref":"#/components/schemas/ReadCompanyDto"}},"civility":{"allOf":[{"$ref":"#/components/schemas/Civility"}]},"provider":{"allOf":[{"$ref":"#/components/schemas/ProviderSignUp"}]},"onboardingAt":{"format":"date-time","type":"string"},"onboardingId":{"type":"string"},"updatedAt":{"format":"date-time","type":"string"},"wantsActivityStartAt":{"format":"date-time","type":"string"}},"required":["id"]},"Civility":{"type":"number","enum":[1,2]},"ProviderSignUp":{"type":"string","enum":["google.com","facebook.com","apple.com","password","custom"]},"AddressType":{"type":"number","enum":[4,1,3,2]},"ReadAccountingAccountDto":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"number"},"color":{"type":"string"},"description":{"type":"string"},"icon":{"type":"string"},"isHidden":{"type":"boolean"},"isPersonal":{"type":"boolean"},"isVatRelated":{"type":"boolean"},"name":{"type":"string"},"number":{"type":"number"},"position":{"type":"number"},"tags":{"type":"array","items":{"type":"string"}},"parentId":{"type":"string"},"parent":{"$ref":"#/components/schemas/ReadAccountingAccountDto"},"companyId":{"type":"string"},"company":{"$ref":"#/components/schemas/ReadCompanyDto"},"entryCount":{"type":"number"},"lastUsedAt":{"format":"date-time","type":"string"},"entries":{"type":"array","items":{"type":"string"}}},"required":["id","category","color","description","icon","isHidden","isPersonal","isVatRelated","name","number","tags"]}}},"paths":{"/v2/purchaseRegister":{"post":{"operationId":"PurchaseRegisterController_createPurchaseRegisterItem_v2","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountingBookDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadAccountingBookDto"}}}}},"tags":["PurchaseRegister"]}}}} ``` ## DELETE /v2/purchaseRegister/{id} > ```json {"openapi":"3.0.0","info":{"title":"Abby API","version":"1.0"},"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}}},"paths":{"/v2/purchaseRegister/{id}":{"delete":{"operationId":"PurchaseRegisterController_deletePurchaseRegisterItem_v2","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}}],"responses":{"200":{"description":""}},"tags":["PurchaseRegister"]}}}} ``` # Erreurs Abby utilise les codes HTTP pour indiquer le succès ou l'échec des requêtes envoyées à l'API. En cas d'échec, elle renvoie une erreur correspondant au code d'état approprié. Les codes d'état se répartissent en trois catégories : * Les codes 2xx indiquent que la requête a réussi. * Les codes 4xx signalent une erreur liée aux informations fournies. * Les codes 5xx, plus rares, indiquent un problème côté serveur. #### Attributs En cas d'erreur, l'API renvoie un JSON décrivant les détails de l'erreur. ```json { "type": "api_error" | "authentication_error" | "rsc_error", "code": "internal_server_error" | "not_found" | ... "message": "Details de l'erreur" "param": "Le paramètre incorrect" } ``` #### Code de status HTTP
200 - OKTout s'est correctement exécuté
201 - CreatedLa ressource a été correctement créée
400 - Bad RequestLa requête contient de mauvais paramètres
401 - UnauthorizedLa clé API n'est pas valide
403 - ForbiddenLa clé API n'a pas l'accès requis
404 - Not FoundLa ressource n'a pas été trouvée
429 - Too Many RequestsTrop de requêtes ont été envoyées à l'API
500, 502, 503 - Server ErrorsUn problème est arrivé côté Abby
#### Types d'erreurs
api_errorUn problème est survenu côté API
authentication_errorLa clé API n'est pas valide
rsc_errorLa ressource ou les paramètres sont invalides
#### Codes d'erreur
internal_server_errorUne erreur est survenue sur l'API
token_failureLa clé API n'est pas valide
validation_errorLes paramètres de la requête sont incorrects
not_foundLa ressource est introuvable
bad_requestCertains paramètres ne sont valides
forbiddenLa clé API n'a pas les permissions requises
# SDK Le SDK **Abby Node.js, Bun & Deno** est la librairie officielle de l’API Abby. Il évite d’écrire vos requêtes HTTP à la main. Il ajoute du typage TypeScript et de la validation runtime. * NPM : * GitHub : ### Quand l’utiliser Utilisez le SDK si vous développez : * Un backend Node.js. * Un script Bun. * Une app Deno. Pour du no-code, utilisez Make. ### Prérequis * Node.js `>= 18`, Bun `>= 1`, ou Deno `>= 2`. * Une clé API Abby. La création et la gestion de la clé est décrite dans [Authentification](/api/authentification). {% hint style="warning" %} Gardez la clé API côté serveur. Ne l’exposez jamais au navigateur. Ne la commitez jamais. {% endhint %} ### Installation {% tabs %} {% tab title="npm" %} ```bash npm install @abby-inc/node ``` {% endtab %} {% tab title="yarn" %} ```bash yarn add @abby-inc/node ``` {% endtab %} {% tab title="pnpm" %} ```bash pnpm add @abby-inc/node ``` {% endtab %} {% tab title="bun" %} ```bash bun add @abby-inc/node ``` {% endtab %} {% tab title="deno" %} ```typescript import Abby from 'npm:@abby-inc/node'; ``` {% endtab %} {% endtabs %} ### Démarrage rapide #### Initialisation ```typescript import Abby from '@abby-inc/node'; const abby = new Abby('your_api_key'); ``` #### Exemple simple ```typescript import Abby from '@abby-inc/node'; const abby = new Abby('your_api_key'); async function main() { const { data: me } = await abby.company.getMe(); console.log(`Welcome back, ${me.user.firstname}!`); const { data: contacts } = await abby.contact.retrieveContacts({ query: { limit: 10 }, }); console.log(`Found ${contacts.docs.length} contacts.`); } main().catch(console.error); ``` ### Services Le SDK expose des services par domaine métier. La liste ci-dessous suit le README. * `abby.company` : infos société et préférences. * `abby.invoice` : factures. * `abby.estimate` : devis. * `abby.contact` : contacts (clients). * `abby.organization` : organisations. * `abby.billing` : utilitaires de facturation (PDF, emails). * `abby.opportunity` : CRM et opportunités. * `abby.asset` : immobilisations. * `abby.advance` : acomptes. Pour la doc API dans GitBook : * [Clients](/api/clients) * [Factures](/api/factures) * [Livre des recettes](/api/livre-des-recettes) * [Livre des achats](/api/livre-des-achats) ### Configuration Vous pouvez passer des options au constructeur. ```typescript import Abby from '@abby-inc/node'; const abby = new Abby('your_api_key', { baseUrl: 'https://api.app-abby.com', timeout: 30000, headers: { 'X-Custom-Header': 'value', }, }); ``` Options : * `baseUrl` (défaut `https://api.app-abby.com`) : base URL de l’API. * `timeout` (défaut `30000`) : timeout en millisecondes. * `headers` : headers ajoutés à toutes les requêtes. * `fetch` (défaut `globalThis.fetch`) : fetch custom (proxy, logs, tests). ### Fetch custom et proxy Le SDK accepte un `fetch` custom. Ça sert pour un proxy, des logs, ou des tests. Proxy avec `undici` : ```typescript import Abby from '@abby-inc/node'; import { fetch as undiciFetch, ProxyAgent } from 'undici'; const proxyAgent = new ProxyAgent('http://proxy.example.com:8080'); const abby = new Abby('your_api_key', { fetch: (url, init) => undiciFetch(url, { ...init, dispatcher: proxyAgent, }), }); ``` Logging simple : ```typescript import Abby from '@abby-inc/node'; const abby = new Abby('your_api_key', { fetch: async (url, init) => { console.log(`[Abby SDK] ${init?.method ?? 'GET'} ${url}`); const start = Date.now(); const response = await globalThis.fetch(url, init); console.log(`[Abby SDK] ${response.status} in ${Date.now() - start}ms`); return response; }, }); ``` ### Gestion des erreurs Le SDK lève des erreurs en cas de réponse 4xx/5xx. Vous pouvez router par code HTTP. ```typescript try { await abby.invoice.getInvoice({ path: { invoiceId: 'inv_invalid' }, }); } catch (error) { if (error.status === 404) { console.error('Invoice not found'); } else if (error.status === 401) { console.error('Invalid API key'); } else { console.error('Unexpected error:', error.message); } } ``` Pour les détails, voir [Erreurs](/api/erreurs). ### Événements (listeners) Vous pouvez écouter globalement erreurs et réponses. C’est utile pour du logging centralisé. Écouter toutes les erreurs : ```typescript import Abby from '@abby-inc/node'; const abby = new Abby('your_api_key'); abby.on('error', (error) => { console.error(`API Error: ${error.status} ${error.statusText}`); console.error(`URL: ${error.method} ${error.url}`); console.error(`Message: ${error.message}`); console.error(`Duration: ${error.duration}ms`); }); ``` Écouter toutes les réponses : ```typescript abby.on('response', (response) => { console.log(`${response.method} ${response.url} - ${response.status} (${response.duration}ms)`); }); ``` Supprimer un listener : ```typescript const errorHandler = (error) => console.error(error); abby.on('error', errorHandler); abby.off('error', errorHandler); ``` ### Interceptors Les interceptors hookent le cycle request/response. ```typescript const client = abby.getClient(); client.interceptors.request.use((request) => { request.headers.set('X-Request-ID', crypto.randomUUID()); return request; }); client.interceptors.response.use((response) => { console.log(`API Response: ${response.status}`); return response; }); ``` ### Requêtes “raw” Utilisez le client HTTP si un endpoint manque. La clé API et les headers SDK sont ajoutés automatiquement. ```typescript import Abby from '@abby-inc/node'; const abby = new Abby('your_api_key'); const client = abby.getClient(); const { data } = await client.get({ url: '/v2/some/endpoint', }); const { data: result } = await client.post({ url: '/v2/some/endpoint', body: { field: 'value' }, }); ``` ### Validation (Zod) Le SDK valide requêtes et réponses avec [Zod](https://zod.dev). Une `ZodError` est levée si ça ne matche pas le schéma. ```typescript import Abby from '@abby-inc/node'; import { ZodError } from 'zod'; const abby = new Abby('your_api_key'); try { await abby.contact.createContact({ body: {} }); } catch (error) { if (error instanceof ZodError) { console.error('Validation failed:', error.errors); } } ``` Vous pouvez aussi utiliser les schémas exportés : ```typescript import { z } from 'zod'; import { zCreateContactDto, zReadContactDto } from '@abby-inc/node'; type CreateContactInput = z.infer; type Contact = z.infer; const input = { firstname: 'John', lastname: 'Doe', email: 'john@example.com', }; zCreateContactDto.parse(input); ``` ### TypeScript Le SDK est écrit en TypeScript. Il expose des types pour les DTOs. ```typescript import Abby, { ReadMeDto } from '@abby-inc/node'; const abby = new Abby('your_api_key'); async function getCompanyData() { const { data }: { data: ReadMeDto } = await abby.company.getMe(); return data; } ``` # Démarrer avec le MCP ## Qu'est-ce que le MCP ? Le **Model Context Protocol (MCP)** est un protocole ouvert qui permet aux assistants IA d'interagir directement avec des outils et services externes. Grâce au serveur MCP d'Abby, vous pouvez piloter votre gestion (facturation, clients, catalogue, déclarations URSSAF) depuis n'importe quel client IA compatible. ## Clients compatibles Le serveur MCP d'Abby est compatible avec tout client supportant le transport **StreamableHTTP** : * **Claude Desktop** (Anthropic) * **Cursor** * **Tout client compatible MCP** ## URL du serveur {% hint style="info" %} **URL MCP :** `https://api.abby.fr/mcp`\ **Transport :** StreamableHTTP {% endhint %} ## Authentification Le serveur MCP d'Abby utilise **OAuth 2.0** pour authentifier les requêtes. Le flux est le suivant : 1. Le client MCP envoie une première requête au serveur 2. Le serveur répond avec un code `401` et un header `WWW-Authenticate` contenant l'URL d'autorisation 3. Le client redirige l'utilisateur vers la page d'autorisation Abby 4. L'utilisateur autorise l'accès à son compte Abby 5. Le client reçoit un token d'accès (Bearer token) 6. Toutes les requêtes suivantes incluent le header `Authorization: Bearer ` {% hint style="warning" %} Le flux OAuth est géré automatiquement par les clients compatibles (Claude Desktop, Cursor, etc.). Vous n'avez pas à implémenter le flux manuellement. {% endhint %} ## Configuration dans Claude Desktop Ajoutez la configuration suivante dans votre fichier de configuration Claude Desktop : ```json { "mcpServers": { "abby": { "url": "https://api.abby.fr/mcp" } } } ``` Claude Desktop détectera automatiquement le flux OAuth et vous guidera dans l'autorisation. ## Configuration dans Cursor Dans les paramètres de Cursor, ajoutez un nouveau serveur MCP : * **Nom :** Abby * **Type :** StreamableHTTP * **URL :** `https://api.abby.fr/mcp` ## Outils disponibles Une fois connecté, vous avez accès à **40 outils** répartis en 4 domaines : | Domaine | Outils | Description | | ----------------------------------------------- | ------ | ----------------------------------------------- | | [Facturation](/mcp/facturation) | 19 | Factures, devis, acomptes, avoirs, statistiques | | [Catalogue](/mcp/catalogue) | 5 | Produits et services | | [Clients](/mcp/clients) | 15 | Contacts et organisations | | [Déclarations URSSAF](/mcp/declarations-urssaf) | 2 | Estimation CA et déclaration | # Facturation Les outils de facturation permettent de gérer l'ensemble du cycle de vie des documents : factures, devis, bons de commande, acomptes et avoirs. {% hint style="warning" %} Tous les montants sont exprimés en **centimes** (100€ = 10000). Consultez les [conventions](/mcp/conventions) pour plus de détails. {% endhint %} ## Consultation ### `get-billings` Récupère les documents de facturation avec pagination et filtres avancés. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | --------- | ------ | ------------------------------------------------------------------------------------ | | `page` | number | Non | Numéro de page (défaut : 1) | | `limit` | number | Non | Résultats par page, max 100 (défaut : 10) | | `type` | string\[] | Non | Types : `invoice`, `estimate`, `advance`, `asset`, `purchase_order` | | `state` | string\[] | Non | États : `draft`, `finalized`, `signed`, `refused`, `paid` | | `search` | string | Non | Recherche par numéro, titre ou nom client | | `customerId` | string | Non | Filtrer par identifiant client | | `archived` | boolean | Non | Filtrer par statut d'archivage | | `late` | boolean | Non | Uniquement les documents en retard | | `rangeFrom` | string | Non | Début de la plage de dates (ISO 8601) | | `rangeTo` | string | Non | Fin de la plage de dates (ISO 8601) | | `rangeType` | string | Non | Champ de date : `emittedAt`, `dueAt`, `paidAt`, `signedAt`, `expiredAt`, `refusedAt` | **Réponse** ```json { "success": true, "total": 42, "page": 1, "limit": 10, "totalPages": 5, "hasNextPage": true, "hasPrevPage": false, "billings": [ { "id": "string", "type": "invoice", "number": "FA-2025-001", "title": "string", "state": "finalized", "emittedAt": "2025-01-15T00:00:00.000Z", "customer": { "id": "string", "name": "Dupont SARL", "email": "contact@dupont.fr" }, "totalAmountWithTax": 12000, "totalAmountWithoutTax": 10000, "currencyCode": "EUR", "archived": false, "dueAt": "2025-02-15T00:00:00.000Z", "paidAt": null, "remainingAmountWithTax": 12000, "remainingAmountWithoutTax": 10000 } ] } ``` *** ### `get-billing-by-id` Récupère le détail complet d'un document par son identifiant. Inclut les lignes, totaux, informations client, mentions légales, ventilation TVA, informations de paiement et pièces jointes. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ----------------------- | | `billingId` | string | Oui | Identifiant du document | *** ### `get-billing-statistics` Récupère les statistiques de facturation : compteurs et montants par état (brouillon, en retard, en attente, payé, finalisé, signé, refusé). **Paramètres** | Paramètre | Type | Requis | Description | | --------- | --------- | ------ | --------------------------------------------------------------------------------- | | `type` | string\[] | Non | Filtrer par type(s) : `invoice`, `estimate`, `advance`, `asset`, `purchase_order` | *** ### `get-customers` Récupère les clients facturables (contacts et organisations) avec pagination et recherche. Retourne l'identifiant client nécessaire pour `create-invoice`. **Paramètres** | Paramètre | Type | Requis | Description | | --------- | ------ | ------ | ----------------------------------------- | | `page` | number | Non | Numéro de page (défaut : 1) | | `limit` | number | Non | Résultats par page, max 100 (défaut : 50) | | `search` | string | Non | Recherche par nom ou email | **Réponse** ```json { "success": true, "total": 15, "customers": [ { "id": "string", "displayName": "Dupont SARL", "firstname": null, "lastname": null, "name": "Dupont SARL", "commercialName": "Dupont & Fils", "emails": ["contact@dupont.fr"], "siret": "12345678901234", "vatNumber": "FR12345678901", "billingAddress": { ... }, "isContact": false, "isOrganization": true, "contactId": null, "organizationId": "string" } ] } ``` *** ### `download-billing-document` Télécharge un document au format PDF. Retourne une URL de téléchargement temporaire valide 7 jours. **Paramètres** | Paramètre | Type | Requis | Description | | ----------------- | ------- | ------ | -------------------------------------------------------- | | `billingId` | string | Oui | Identifiant du document | | `withAttachments` | boolean | Non | Inclure les pièces jointes dans le PDF (défaut : `true`) | **Réponse** ```json { "success": true, "downloadUrl": "https://...", "filename": "FA-2025-042.pdf", "expiresIn": "7 days", "billingId": "string" } ``` *** ## Création ### `create-invoice` Crée une facture en brouillon avec des lignes de facturation. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | ------ | ------ | -------------------------------------------------------------------- | | `customerId` | string | Oui | Identifiant client (depuis `get-customers`) | | `lines` | array | Oui | Lignes de facturation (voir [schéma des lignes](#schema-des-lignes)) | | `discount` | object | Non | Remise globale (`mode`: `PERCENTAGE` ou `AMOUNT`, `amount`: valeur) | *** ### `create-estimate` Crée un devis ou bon de commande en brouillon. **Paramètres** | Paramètre | Type | Requis | Description | | -------------- | ------ | ------ | ----------------------------------------------------------------------------- | | `customerId` | string | Oui | Identifiant client | | `lines` | array | Oui | Lignes du devis (voir [schéma des lignes](#schema-des-lignes)) | | `estimateType` | string | Non | `estimate` (devis) ou `purchase_order` (bon de commande). Défaut : `estimate` | | `discount` | object | Non | Remise globale | *** ### `create-advance` Crée un acompte à partir d'un devis finalisé ou signé. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | ------ | ------ | --------------------------------------------------------------- | | `estimateId` | string | Oui | Identifiant du devis finalisé | | `mode` | string | Non | `percentage` ou `amount` (défaut : `percentage`) | | `value` | number | Non | Pourcentage (30 = 30%) ou montant en **centimes** selon le mode | {% hint style="info" %} L'acompte hérite automatiquement du client et des informations du devis parent. Le devis doit être dans l'état `finalized` ou `signed`. {% endhint %} *** ### `create-asset` Crée un avoir (note de crédit) en brouillon. **Paramètres** | Paramètre | Type | Requis | Description | | ------------------- | ------ | ------ | ------------------------------------------- | | `billingCustomerId` | string | Non | Identifiant client (depuis `get-customers`) | | `opportunityId` | string | Non | Identifiant de l'opportunité | {% hint style="info" %} Au moins un des deux paramètres (`billingCustomerId` ou `opportunityId`) doit être fourni. {% endhint %} *** ## Actions ### `finalize-billing` Finalise un document en brouillon (facture, devis, acompte, bon de commande). Attribue un numéro définitif. **Le document ne peut plus être modifié après finalisation.** Fonctionne en deux étapes : 1. **Aperçu** (`confirm` absent ou `false`) — retourne un résumé du document avant finalisation 2. **Confirmation** (`confirm: true`) — finalise définitivement le document **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------- | ------ | ------------------------------------------------------------ | | `billingId` | string | Oui | Identifiant du document brouillon | | `confirm` | boolean | Non | `true` pour finaliser. Sans confirmation, retourne un aperçu | *** ### `update-billing-lines` Met à jour les lignes d'un document en brouillon. **Remplace toutes les lignes existantes.** **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | --------------------------------------------------------------- | | `billingId` | string | Oui | Identifiant du document brouillon | | `lines` | array | Oui | Nouvelles lignes (voir [schéma des lignes](#schema-des-lignes)) | | `discount` | object | Non | Remise globale | *** ### `send-invoice-by-email` Envoie un document par email avec le PDF en pièce jointe. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | --------- | ------ | --------------------------------------------------- | | `billingId` | string | Oui | Identifiant du document | | `emails` | string\[] | Oui | Adresses email (1 à 10 destinataires) | | `subject` | string | Oui | Objet de l'email | | `content` | string | Oui | Corps de l'email (HTML supporté) | | `inCopy` | boolean | Non | Envoyer une copie à l'expéditeur (défaut : `false`) | *** ### `duplicate-billing` Duplique un document existant en nouveau brouillon. Peut optionnellement convertir vers un autre type. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | ------ | ------ | ------------------------------------------------------------------------------------------- | | `documentId` | string | Oui | Identifiant du document à dupliquer | | `targetType` | string | Non | Type cible : `invoice`, `estimate`, `purchase_order`. Si absent, duplique dans le même type | *** ### `cancel-invoice` Annule une facture finalisée et **crée automatiquement un avoir**. Action irréversible. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ----------------------------------- | | `invoiceId` | string | Oui | Identifiant de la facture finalisée | **Réponse** ```json { "success": true, "message": "Invoice cancelled successfully. A credit note (avoir) has been created.", "cancelledInvoice": { "id": "string", "number": "FA-2025-042", "state": "cancelled", "canceledAt": "2025-03-15T00:00:00.000Z" }, "asset": { "id": "string", "number": "AV-2025-003", "state": "finalized", "total": { ... } } } ``` *** ### `sign-estimate` Marque un devis finalisé comme signé/accepté par le client. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | ------ | ------ | ----------------------------- | | `estimateId` | string | Oui | Identifiant du devis finalisé | *** ### `refuse-estimate` Marque un devis finalisé comme refusé par le client. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | ------ | ------ | ----------------------------- | | `estimateId` | string | Oui | Identifiant du devis finalisé | *** ### `archive-billing` Archive un document. Les documents archivés sont masqués des listes actives mais conservés. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | ------ | ------ | ----------------------- | | `documentId` | string | Oui | Identifiant du document | *** ### `unarchive-billing` Restaure un document archivé dans les listes actives. **Paramètres** | Paramètre | Type | Requis | Description | | ------------ | ------ | ------ | ------------------------------- | | `documentId` | string | Oui | Identifiant du document archivé | *** ## Schéma des lignes Les outils `create-invoice`, `create-estimate` et `update-billing-lines` partagent le même schéma de lignes : | Paramètre | Type | Requis | Description | | -------------- | ------ | ------ | --------------------------------------------------------------------------------------------------------- | | `designation` | string | Oui | Nom du produit ou service | | `unitPrice` | number | Oui | Prix unitaire en **centimes** | | `quantity` | number | Non | Quantité (défaut : 1) | | `quantityUnit` | string | Non | Unité : `UNIT`, `HOUR`, `DAY`, `MONTH`, etc. (défaut : `UNIT`) | | `type` | string | Non | Type : `SERVICE_DELIVERY`, `GOODS_SALE`, etc. (défaut : `SERVICE_DELIVERY`) | | `vatCode` | string | Non | Code TVA : `fr_20`, `fr_10`, `fr_5_5`, `fr_2_1`, `fr_0`, `fr_8_5`, `fr_not_applicable` (défaut : `fr_20`) | | `description` | string | Non | Description détaillée | | `reference` | string | Non | Référence produit | | `productId` | string | Non | Identifiant produit du catalogue | *** ## Scopes requis | Outil | Scope | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | | `get-billings`, `get-billing-by-id`, `get-billing-statistics`, `get-customers`, `download-billing-document` | `billing:read` | | `create-invoice`, `create-estimate`, `create-advance`, `create-asset`, `finalize-billing`, `update-billing-lines`, `send-invoice-by-email`, `duplicate-billing`, `cancel-invoice`, `sign-estimate`, `refuse-estimate`, `archive-billing`, `unarchive-billing` | `billing:write` | # Catalogue Les outils du catalogue permettent de gérer vos produits et services. Ces produits peuvent ensuite être utilisés dans les lignes de facturation. {% hint style="warning" %} Tous les montants sont exprimés en **centimes** (100€ = 10000). Consultez les [conventions](/mcp/conventions) pour plus de détails. {% endhint %} ## Lecture ### `get-products` Récupère les produits du catalogue avec pagination (100 produits par page). **Paramètres** | Paramètre | Type | Requis | Description | | --------- | ------ | ------ | -------------------------------------- | | `page` | number | Non | Numéro de page (défaut : 1) | | `search` | string | Non | Recherche par désignation ou référence | **Réponse** ```json { "success": true, "total": 25, "page": 1, "limit": 100, "totalPages": 1, "hasNextPage": false, "hasPrevPage": false, "products": [ { "id": "string", "designation": "Développement web", "reference": "DEV-001", "description": "Prestation de développement web", "type": "SERVICE_DELIVERY", "unit": "HOUR", "unitPrice": 7500, "priceWithoutTaxes": 7500, "priceWithTaxes": 9000, "purchasePrice": 0, "productMargin": 0, "vatCode": "FR_2000", "vatAmount": 1500, "taxesIncluded": false, "stock": 0, "isStockable": false, "isDeliveryOfGood": false, "personalServiceActivity": false } ] } ``` *** ### `get-product-by-id` Récupère le détail complet d'un produit par son identifiant. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ---------------------- | | `productId` | string | Oui | Identifiant du produit | *** ## Création et modification ### `create-product` Crée un nouveau produit dans le catalogue. **Paramètres** | Paramètre | Type | Requis | Description | | ------------------ | ----------- | ------ | --------------------------------------------------------- | | `designation` | string | Oui | Nom du produit ou service | | `type` | ProductType | Oui | Type (ex : `SERVICE_DELIVERY`, `GOODS_SALE`) | | `unit` | ProductUnit | Oui | Unité (ex : `HOUR`, `DAY`, `UNIT`, `KG`) | | `vatCode` | VatCode | Oui | Code TVA (ex : `FR_2000`, `FR_1000`, `FR_00HT`) | | `unitPrice` | number | Non | Prix unitaire en **centimes** | | `purchasePrice` | number | Non | Prix d'achat en **centimes** (pour calcul de marge) | | `productMargin` | number | Non | Marge en pourcentage (30 = 30%) | | `lockUnitPrice` | boolean | Non | Prix fixe, non calculé depuis marge (défaut : `false`) | | `taxesIncluded` | boolean | Non | Prix TTC (défaut : `false` = HT) | | `isDeliveryOfGood` | boolean | Non | Livraison de bien pour la comptabilité (défaut : `false`) | | `description` | string | Non | Description détaillée | | `reference` | string | Non | Référence / SKU | | `stock` | number | Non | Stock initial (défaut : 0) | *** ### `update-product` Met à jour un produit existant. Les paramètres `designation`, `type`, `unit` et `vatCode` sont requis (le produit est remplacé intégralement). **Paramètres** Identiques à `create-product`, avec en plus : | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ---------------------- | | `productId` | string | Oui | Identifiant du produit | *** ### `delete-product` Supprime définitivement un produit du catalogue. **Action irréversible.** **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ---------------------- | | `productId` | string | Oui | Identifiant du produit | *** ## Scopes requis | Outil | Scope | | ---------------------------------------------------- | --------------- | | `get-products`, `get-product-by-id` | `catalog:read` | | `create-product`, `update-product`, `delete-product` | `catalog:write` | # Clients Les outils clients permettent de gérer vos contacts (particuliers) et organisations (entreprises). Ces clients sont ensuite utilisables dans la facturation. Abby distingue deux types de clients : * **Contacts** — clients particuliers (personnes physiques) * **Organisations** — clients professionnels (entreprises, associations, etc.) Les organisations peuvent avoir plusieurs contacts associés. ## Lecture ### `get-contacts` Récupère les contacts avec pagination et recherche. **Paramètres** | Paramètre | Type | Requis | Description | | ---------- | ------- | ------ | ----------------------------------------- | | `page` | number | Non | Numéro de page (défaut : 1) | | `limit` | number | Non | Résultats par page, max 100 (défaut : 50) | | `search` | string | Non | Recherche par prénom ou nom | | `archived` | boolean | Non | Filtrer par statut d'archivage | **Réponse** ```json { "success": true, "total": 15, "page": 1, "contacts": [ { "id": "string", "firstname": "Jean", "lastname": "Dupont", "emails": ["jean.dupont@email.com"], "phone": "+33612345678", "jobTitle": "Directeur technique", "organizationId": "string", "organizationName": "Dupont SARL", "notes": "", "addresses": [...], "archivedAt": null, "hasBillings": true, "createdAt": "2025-01-15T00:00:00.000Z" } ] } ``` *** ### `get-contact-by-id` Récupère un contact par son identifiant. Retourne les détails incluant nom, email, téléphone, poste, organisation et adresses. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ---------------------- | | `contactId` | string | Oui | Identifiant du contact | *** ### `get-organizations` Récupère les organisations avec pagination et recherche. **Paramètres** | Paramètre | Type | Requis | Description | | ---------- | ------- | ------ | ----------------------------------------- | | `page` | number | Non | Numéro de page (défaut : 1) | | `limit` | number | Non | Résultats par page, max 100 (défaut : 50) | | `search` | string | Non | Recherche par nom | | `archived` | boolean | Non | Filtrer par statut d'archivage | **Réponse** ```json { "success": true, "total": 8, "organizations": [ { "id": "string", "name": "Dupont SARL", "commercialName": "Dupont & Fils", "emails": ["contact@dupont.fr"], "siret": "12345678901234", "vatNumber": "FR12345678901", "countContacts": 3, "notes": "", "addresses": [...], "archivedAt": null, "hasBillings": true, "createdAt": "2025-01-15T00:00:00.000Z" } ] } ``` *** ### `get-organization-by-id` Récupère une organisation par son identifiant. Retourne les détails incluant nom, SIRET, TVA, nombre de contacts et adresses. **Paramètres** | Paramètre | Type | Requis | Description | | ---------------- | ------ | ------ | ----------------------------- | | `organizationId` | string | Oui | Identifiant de l'organisation | *** ### `get-organization-contacts` Récupère tous les contacts associés à une organisation. **Paramètres** | Paramètre | Type | Requis | Description | | ---------------- | ------ | ------ | ----------------------------- | | `organizationId` | string | Oui | Identifiant de l'organisation | **Réponse** ```json { "success": true, "total": 3, "organizationId": "string", "contacts": [ { "id": "string", "firstname": "Marie", "lastname": "Martin", "emails": ["m.martin@dupont.fr"], "jobTitle": "Comptable", "defaultContact": true } ] } ``` *** ## Création ### `create-contact` Crée un nouveau contact (client particulier). Nécessite au minimum un prénom et un nom. **Paramètres** | Paramètre | Type | Requis | Description | | --------------------------- | --------- | ------ | ---------------------------------------- | | `firstname` | string | Oui | Prénom | | `lastname` | string | Oui | Nom de famille | | `emails` | string\[] | Non | Adresses email | | `phone` | string | Non | Numéro de téléphone | | `jobTitle` | string | Non | Poste / fonction | | `notes` | string | Non | Notes libres | | `billingAddress` | object | Non | Adresse de facturation | | `billingAddress.address` | string | Oui | Rue | | `billingAddress.complement` | string | Non | Complément (bâtiment, étage, etc.) | | `billingAddress.city` | string | Oui | Ville | | `billingAddress.zipCode` | string | Oui | Code postal | | `billingAddress.country` | string | Oui | Code pays ISO 3166-1 alpha-2 (ex : `FR`) | | `deliveryAddress` | object | Non | Adresse de livraison (même structure) | *** ### `create-organization` Crée une nouvelle organisation (client professionnel). Nécessite au minimum un nom. **Paramètres** | Paramètre | Type | Requis | Description | | ----------------- | --------- | ------ | ------------------------------------------------------------ | | `name` | string | Oui | Raison sociale | | `commercialName` | string | Non | Nom commercial | | `emails` | string\[] | Non | Adresses email | | `siret` | string | Non | Numéro SIRET | | `vatNumber` | string | Non | Numéro de TVA intracommunautaire | | `notes` | string | Non | Notes libres | | `billingAddress` | object | Non | Adresse de facturation (même structure que `create-contact`) | | `deliveryAddress` | object | Non | Adresse de livraison (même structure) | *** ## Modification ### `update-contact` Met à jour un contact existant. Charge les données existantes avant la mise à jour pour préserver les informations non exposées (coordonnées bancaires, préférences). **Paramètres** | Paramètre | Type | Requis | Description | | ----------------- | --------- | ------ | ---------------------- | | `contactId` | string | Oui | Identifiant du contact | | `firstname` | string | Non | Prénom | | `lastname` | string | Non | Nom de famille | | `emails` | string\[] | Non | Adresses email | | `phone` | string | Non | Numéro de téléphone | | `jobTitle` | string | Non | Poste / fonction | | `billingAddress` | object | Non | Adresse de facturation | | `deliveryAddress` | object | Non | Adresse de livraison | {% hint style="info" %} Les notes sont gérées séparément via `update-contact-notes` pour éviter tout écrasement accidentel. {% endhint %} *** ### `update-organization` Met à jour une organisation existante. Préserve les coordonnées bancaires et préférences existantes. **Paramètres** | Paramètre | Type | Requis | Description | | ----------------- | --------- | ------ | ----------------------------- | | `organizationId` | string | Oui | Identifiant de l'organisation | | `name` | string | Non | Raison sociale | | `commercialName` | string | Non | Nom commercial | | `emails` | string\[] | Non | Adresses email | | `siret` | string | Non | Numéro SIRET | | `vatNumber` | string | Non | Numéro de TVA | | `billingAddress` | object | Non | Adresse de facturation | | `deliveryAddress` | object | Non | Adresse de livraison | *** ### `update-contact-notes` Met à jour les notes d'un contact via un use case dédié. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ---------------------- | | `contactId` | string | Oui | Identifiant du contact | | `notes` | string | Oui | Nouvelles notes | *** ### `update-organization-notes` Met à jour les notes d'une organisation via un use case dédié. **Paramètres** | Paramètre | Type | Requis | Description | | ---------------- | ------ | ------ | ----------------------------- | | `organizationId` | string | Oui | Identifiant de l'organisation | | `notes` | string | Oui | Nouvelles notes | *** ## Suppression et archivage ### `delete-contact` Supprime définitivement un contact. **Échoue si le contact a des documents de facturation** — utilisez `archive-contact` dans ce cas. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ---------------------- | | `contactId` | string | Oui | Identifiant du contact | *** ### `delete-organization` Supprime définitivement une organisation. **Échoue si l'organisation a des contacts ou des documents de facturation** — utilisez `archive-organization` dans ce cas. **Paramètres** | Paramètre | Type | Requis | Description | | ---------------- | ------ | ------ | ----------------------------- | | `organizationId` | string | Oui | Identifiant de l'organisation | *** ### `archive-contact` Archive un contact (suppression douce). Le contact n'apparaît plus dans les listes actives mais ses données sont conservées. **Préférez l'archivage à la suppression** quand le contact a des documents de facturation. **Paramètres** | Paramètre | Type | Requis | Description | | ----------- | ------ | ------ | ---------------------- | | `contactId` | string | Oui | Identifiant du contact | *** ### `archive-organization` Archive une organisation. L'organisation n'apparaît plus dans les listes actives mais ses données sont conservées. **Paramètres** | Paramètre | Type | Requis | Description | | ---------------- | ------ | ------ | ----------------------------- | | `organizationId` | string | Oui | Identifiant de l'organisation | *** ## Scopes requis | Outil | Scope | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | | `get-contacts`, `get-contact-by-id`, `get-organizations`, `get-organization-by-id`, `get-organization-contacts` | `client:read` | | `create-contact`, `create-organization`, `update-contact`, `update-organization`, `update-contact-notes`, `update-organization-notes`, `delete-contact`, `delete-organization`, `archive-contact`, `archive-organization` | `client:write` | # Déclarations URSSAF Les outils de déclaration permettent d'estimer et de déclarer votre chiffre d'affaires à l'URSSAF, et de payer les cotisations sociales directement depuis un assistant IA. {% hint style="warning" %} Ces outils effectuent de **vraies actions** auprès de l'URSSAF. L'utilisateur doit avoir un mandat URSSAF actif autorisant Abby à déclarer et payer en son nom. {% endhint %} ## `get-turnover-estimations` Récupère les estimations de chiffre d'affaires et de cotisations pour la période de déclaration en cours, basées sur les factures enregistrées dans Abby. **Paramètres** | Paramètre | Type | Requis | Description | | --------- | ------ | ------ | -------------------------------------------------- | | `period` | string | Non | Période de déclaration (ex : `2025-Q1`, `2025-01`) | **Réponse** ```json { "success": true, "estimations": { "period": "2025-Q1", "turnover": 450000, "contributions": 99000, "details": { "servicesBIC": 0, "servicesBNC": 450000, "sales": 0 } } } ``` {% hint style="info" %} Les montants sont en **centimes**. Le champ `contributions` est une estimation des cotisations basée sur les taux en vigueur. {% endhint %} *** ## `complete-urssaf-declaration` Complète la déclaration URSSAF pour la période en cours. Fonctionne en deux étapes : 1. **Aperçu** (`execute: false`) — affiche un résumé de la déclaration sans la soumettre 2. **Exécution** (`execute: true`) — soumet réellement la déclaration à l'URSSAF **Paramètres** | Paramètre | Type | Requis | Description | | ---------- | ------- | ------ | ------------------------------------------------------------------------- | | `turnover` | number | Oui | Chiffre d'affaires à déclarer en **centimes** | | `execute` | boolean | Oui | `false` pour un aperçu, `true` pour soumettre | | `pay` | boolean | Non | `true` pour payer les cotisations après la déclaration (défaut : `false`) | ### Étape 1 : Aperçu ```json // Appel { "turnover": 450000, "execute": false } // Réponse { "success": true, "preview": true, "declaration": { "period": "2025-Q1", "turnover": 450000, "contributions": 99000, "breakdown": { "maladie": 4500, "retraite": 40500, "invalidite": 5850, "csg": 48150 } } } ``` ### Étape 2 : Exécution ```json // Appel { "turnover": 450000, "execute": true, "pay": true } // Réponse { "success": true, "preview": false, "declaration": { "period": "2025-Q1", "turnover": 450000, "contributions": 99000, "status": "submitted", "paymentStatus": "paid" } } ``` {% hint style="danger" %} Avec `execute: true`, la déclaration est **réellement soumise** à l'URSSAF. Cette action est irréversible. {% endhint %} *** ## Scopes requis | Outil | Scope | | ----------------------------- | ------------------- | | `get-turnover-estimations` | `declaration:read` | | `complete-urssaf-declaration` | `declaration:write` | # Conventions Cette page décrit les conventions communes à tous les outils MCP d'Abby. ## Montants en centimes Tous les montants monétaires sont exprimés en **centimes d'euros** (euros × 100). | Montant réel | Valeur dans l'API | | ------------ | ----------------- | | 100,00 € | `10000` | | 75,50 € | `7550` | | 0,99 € | `99` | | 1 500,00 € | `150000` | {% hint style="warning" %} Ne confondez pas euros et centimes. Un prix unitaire de `7500` correspond à **75,00 €**, pas 7 500 €. {% endhint %} **Formules de conversion :** * Entrée : euros × 100 = centimes * Affichage : centimes ÷ 100 = euros ## Codes TVA Les lignes de facturation utilisent des codes TVA simplifiés : | Code | Taux | Description | | ------------------- | ---- | ---------------------------------- | | `fr_20` | 20% | Taux normal | | `fr_10` | 10% | Taux intermédiaire | | `fr_5_5` | 5,5% | Taux réduit | | `fr_2_1` | 2,1% | Taux super-réduit | | `fr_8_5` | 8,5% | Taux DOM | | `fr_0` | 0% | Exonéré (franchise en base de TVA) | | `fr_not_applicable` | 0% | TVA non applicable | ## Scopes (permissions) Chaque outil MCP nécessite un scope spécifique. Les scopes sont accordés lors du flux OAuth. | Scope | Description | | ------------------- | ------------------------------------- | | `billing:read` | Lecture des documents de facturation | | `billing:write` | Création et modification de documents | | `catalog:read` | Lecture du catalogue de produits | | `catalog:write` | Création et modification de produits | | `client:read` | Lecture des contacts et organisations | | `client:write` | Création et modification de clients | | `declaration:read` | Lecture des estimations URSSAF | | `declaration:write` | Soumission de déclarations URSSAF | ## Format de réponse Toutes les réponses suivent un format uniforme : ### Succès ```json { "success": true, "message": "Description de l'action effectuée.", ... } ``` ### Erreur ```json { "success": false, "message": "Description de l'erreur." } ``` ## Gestion des erreurs Les erreurs courantes que vous pouvez rencontrer : | Code | Description | | ------------------------------- | ---------------------------------------------------- | | `UNAUTHORIZED` | Token invalide ou expiré — relancez le flux OAuth | | `FORBIDDEN` | Scope insuffisant pour cette action | | `NOT_FOUND` | Ressource introuvable (vérifiez l'identifiant) | | `VALIDATION_ERROR` | Paramètres invalides (vérifiez les types et valeurs) | | `BILLING_ALREADY_FINALIZED` | Le document est déjà finalisé | | `DECLARATION_ALREADY_SUBMITTED` | La déclaration a déjà été soumise pour cette période | ## Pagination Les outils retournant des listes utilisent la pagination : ```json { "total": 42, "page": 1, "limit": 10, "totalPages": 5, "hasNextPage": true, "hasPrevPage": false, "items": [...] } ``` Utilisez le paramètre `page` pour naviguer entre les pages. # Flux de travail Cette page décrit les flux de travail typiques pour les tâches les plus courantes avec le serveur MCP d'Abby. ## Créer et envoyer une facture ``` get-customers → create-invoice → finalize-billing → send-invoice-by-email ``` 1. **Identifier le client** — `get-customers` pour trouver le client à facturer 2. **Créer la facture** — `create-invoice` avec l'identifiant client et les lignes. La facture est créée en brouillon 3. **Finaliser** — `finalize-billing` pour attribuer un numéro définitif (aperçu puis confirmation) 4. **Envoyer par email** — `send-invoice-by-email` pour envoyer la facture au client ### Exemple > "Crée une facture de 500€ pour Dupont SARL pour du développement web et envoie-la par email" L'assistant IA va : 1. Chercher "Dupont SARL" dans les clients 2. Créer une facture avec une ligne "Développement web" à 50000 centimes 3. Finaliser la facture (aperçu → confirmation → numéro FA-2025-042) 4. Envoyer la facture par email au contact du client *** ## Devis complet avec signature et acompte ``` create-estimate → finalize-billing → sign-estimate → create-advance → finalize-billing ``` 1. **Créer le devis** — `create-estimate` avec les lignes détaillant la prestation 2. **Finaliser le devis** — `finalize-billing` pour obtenir un numéro de devis 3. **Signature** — `sign-estimate` quand le client accepte 4. **Créer l'acompte** — `create-advance` en référençant le devis (pourcentage ou montant fixe) 5. **Finaliser l'acompte** — `finalize-billing` pour obtenir un numéro d'acompte ### Exemple > "Fais un devis de 2000€ pour la refonte du site de Martin SAS avec un acompte de 30%" L'assistant IA va : 1. Créer un devis avec une ligne "Refonte site web" à 200000 centimes 2. Finaliser le devis (DE-2025-015) 3. Après acceptation, marquer le devis comme signé 4. Créer un acompte de 30% (soit 600€) 5. Finaliser l'acompte (AC-2025-008) *** ## Annuler une facture ``` cancel-invoice ``` 1. **Annuler** — `cancel-invoice` avec l'identifiant de la facture finalisée L'annulation **crée automatiquement un avoir** (note de crédit) associé à la facture. *** ## Déclarer et payer l'URSSAF ``` get-turnover-estimations → complete-urssaf-declaration (aperçu) → complete-urssaf-declaration (exécution) ``` 1. **Estimer le CA** — `get-turnover-estimations` pour obtenir le chiffre d'affaires estimé sur la période 2. **Aperçu** — `complete-urssaf-declaration` avec `execute: false` pour voir les cotisations avant de soumettre 3. **Soumettre et payer** — Après confirmation de l'utilisateur, `complete-urssaf-declaration` avec `execute: true` et `pay: true` ### Exemple > "Déclare mon CA du trimestre à l'URSSAF et paie les cotisations" L'assistant IA va : 1. Récupérer l'estimation du CA pour le trimestre (ex : 4 500€) 2. Afficher un aperçu : "CA de 4 500€, cotisations estimées à 990€. Voulez-vous soumettre ?" 3. Après confirmation, soumettre la déclaration et payer les cotisations {% hint style="danger" %} La déclaration URSSAF est une **action réelle et irréversible**. L'assistant demande toujours confirmation avant de soumettre. {% endhint %}