CompanyInfo Endpoint
Récupérez les informations de l’entreprise connectée à travers différents systèmes ERP avec une API REST unifiée.
L’entité CompanyInfo permet d’extraire les coordonnées, les paramètres comptables et les informations générales
de la société configurée dans votre système ERP.
/Entity/CompanyInfoAperçu
L’entité CompanyInfo représente les informations de l’entreprise (société) connectée dans votre système ERP.
Cette entité est en lecture seule et permet d’extraire les coordonnées de l’entreprise, les paramètres comptables
(périodes, budgets) et d’autres informations générales de configuration.
L’API utilise un endpoint REST standard avec la méthode HTTP appropriée :
GET /Entity/CompanyInfo– Récupérer les informations de l’entreprise connectée
L’entité CompanyInfo est en lecture seule (GET uniquement). Elle retourne les informations de la société
configurée dans l’ERP, incluant les coordonnées, les paramètres GL et les informations de contact.
Matrice de Support
Opérations supportées pour l’entité CompanyInfo par système ERP :
| Système ERP | GET | POST | PUT |
|---|---|---|---|
| Acomba | ✓ Oui | ✗ Non | ✗ Non |
| QuickBooks Online | ✗ Non | ✗ Non | ✗ Non |
| Avantage | ✓ Oui | ✗ Non | ✗ Non |
| Sage 50 | ✓ Oui | ✗ Non | ✗ Non |
| Servex | ✗ Non | ✗ Non | ✗ Non |
| Servicentre | ✗ Non | ✗ Non | ✗ Non |
GET CompanyInfo
Récupère les informations de l’entreprise connectée dans le système ERP.
/Entity/CompanyInfoParamètres de requêtes
| Paramètre | Type | Requis | Description |
|---|---|---|---|
| $select | string | Optionnel | Sélectionne les champs à retourner |
Pour plus de détails sur la composition des requêtes, consultez : Composer une requête à l’API d’ERP Connector
GET /Entity/CompanyInfo Host: https://v4.api.onlineerp.solution.quebec/api Content-Type: application/json
{
"NomEntreprise": "Ma Compagnie Inc.",
"Addresse": "123 rue Principale",
"Ville": "Montréal",
"Province": "QC",
"Pays": "Canada",
"CodePostal": "H2X 1Y4",
"NoTelephone": "514-555-1234",
"NoTelephone2": "514-555-5678",
"PersonneContact": "Jean Tremblay",
"EmailPrincipal": "info@macompagnie.com",
"SiteWebMain": "www.macompagnie.com",
"GL_PeriodeComptableCourante": 6,
"GL_NbPeriodeComptable": 12,
"GL_NomColonneBudgetGL1": "Budget 2024",
"GL_NomColonneBudgetGL2": "Budget 2025",
"GL_NomColonneBudgetGL3": "Prévisions",
"ARDefaultPaymentMode": "1",
"Fiche_DerniereModification": null
}
{
"NomEntreprise": "Code:01,Nom:Construction ABC",
"Addresse": "456 Boulevard Industriel, Suite 200",
"Ville": "Laval",
"Province": "QC",
"Pays": "CAN",
"CodePostal": "H7S 1Z3",
"NoTelephone": null,
"NoTelephone2": null,
"PersonneContact": null,
"EmailPrincipal": null,
"SiteWebMain": null,
"GL_PeriodeComptableCourante": 8,
"GL_NbPeriodeComptable": 12,
"GL_NomColonneBudgetGL1": "Budget1",
"GL_NomColonneBudgetGL2": "Budget2",
"GL_NomColonneBudgetGL3": "Budget3",
"ARDefaultPaymentMode": null,
"Fiche_DerniereModification": "1900-01-01T00:00:00"
}
{
"NomEntreprise": "Entreprise Demo Sage",
"Addresse": "789 Rue Commerce, Bureau 100",
"Ville": "Québec",
"Province": "QC",
"Pays": "Canada",
"CodePostal": "G1K 2M8",
"NoTelephone": "418-555-9876",
"NoTelephone2": "418-555-9877",
"PersonneContact": null,
"EmailPrincipal": "contact@entreprisedemo.ca",
"SiteWebMain": "www.entreprisedemo.ca",
"GL_PeriodeComptableCourante": -1,
"GL_NbPeriodeComptable": 0,
"GL_NomColonneBudgetGL1": null,
"GL_NomColonneBudgetGL2": null,
"GL_NomColonneBudgetGL3": null,
"ARDefaultPaymentMode": null,
"Fiche_DerniereModification": null
}
Propriétés détaillées de CompanyInfo
Coordonnées de l’entreprise
| Propriété | Type | Description |
|---|---|---|
| NomEntreprise | string | Nom de l’entreprise tel que configuré dans l’ERP |
| Addresse | string | Adresse complète de l’entreprise (lignes 1 et 2 combinées si applicable) |
| Ville | string | Ville de l’entreprise |
| Province | string | Province ou état de l’entreprise (code à 2 caractères) |
| Pays | string | Pays de l’entreprise |
| CodePostal | string | Code postal de l’entreprise |
Informations de contact
| Propriété | Type | Description |
|---|---|---|
| NoTelephone | string | Numéro de téléphone principal de l’entreprise |
| NoTelephone2 | string | Numéro de téléphone secondaire (télécopieur dans certains ERP) |
| PersonneContact | string | Nom de la personne contact principale (Acomba uniquement) |
| EmailPrincipal | string | Adresse courriel principale de l’entreprise |
| SiteWebMain | string | Site web de l’entreprise |
Paramètres du Grand Livre (GL)
| Propriété | Type | Description |
|---|---|---|
| GL_PeriodeComptableCourante | int | Numéro de la période comptable courante (1 à 13). Retourne -1 si non disponible. |
| GL_NbPeriodeComptable | int | Nombre total de périodes comptables dans l’année fiscale (généralement 12 ou 13) |
| GL_NomColonneBudgetGL1 | string | Nom de la première colonne de budget (Acomba/Avantage) |
| GL_NomColonneBudgetGL2 | string | Nom de la deuxième colonne de budget (Acomba/Avantage) |
| GL_NomColonneBudgetGL3 | string | Nom de la troisième colonne de budget (Acomba/Avantage) |
Autres propriétés
| Propriété | Type | Description |
|---|---|---|
| ARDefaultPaymentMode | string | Mode de paiement par défaut pour les comptes à recevoir (Acomba uniquement) |
| Fiche_DerniereModification | DateTime? | Date de la dernière modification des informations de l’entreprise |
Certaines propriétés sont spécifiques à certains ERP :
- Acomba : Toutes les propriétés sont disponibles, incluant PersonneContact et ARDefaultPaymentMode
- Avantage : Le NomEntreprise inclut le code de compagnie (ex: “Code:01,Nom:…”)
- Sage 50 : Les propriétés GL (budgets) ne sont pas disponibles