{"openapi":"3.1.0","info":{"title":"AXITAM Public API","description":"Reference data (ISO, CLDR), Belgian enterprises, annual accounts and addresses, Peppol participants - built on community-maintained and official sources. See the data-sources API for each source's version and license. Beta.","version":"0.26.0"},"servers":[{"url":"/","description":"This server"}],"tags":[{"name":"Chart of accounts (PCMN / MAR)","description":"The Belgian minimum chart of accounts (plan comptable minimum normalisé / minimumindeling van het algemeen rekeningenstelsel) of enterprises, and the one of associations and foundations, in French, Dutch, English and German, as the Commission des Normes Comptables / Commissie voor Boekhoudkundige Normen publishes their coordinated text (source: CNC/CBN - cnc-cbn.be; the CNC/CBN marks its coordinated text as unofficial, the Royal Decrees in the Moniteur belge are authoritative). Read from the CNC/CBN's pages and reloaded daily. Each language is served as published: the pages carry a few layout defects (a label missing in one language, a number printed twice, an account left out of one language), which this API does not correct."}],"paths":{"/api/v1/bel/chart-of-accounts":{"get":{"tags":["Chart of accounts (PCMN / MAR)"],"summary":"A Belgian minimum chart of accounts","description":"Every account of the chart in the published order, with its level, the account it belongs to, its notes and, for class 0, the text on its content; optionally only the accounts directly under one account, or of one level.","operationId":"findChart","parameters":[{"name":"type","in":"query","description":"enterprise (enterprises other than associations and foundations) or association (associations and foundations)","required":false,"schema":{"type":"string","default":"enterprise","pattern":"^(enterprise|association)$"},"example":"enterprise"},{"name":"lang","in":"query","description":"fr, nl, en or de","required":false,"schema":{"type":"string","default":"fr","pattern":"^(fr|nl|en|de)$"},"example":"fr"},{"name":"parent","in":"query","description":"Only the accounts directly under this account","required":false,"schema":{"type":"string","pattern":"^(\\d{1,6}(-\\d{1,6})?|\\.\\.\\.\\d)$"},"example":11},{"name":"level","in":"query","description":"Only the accounts of this level (1 = the classes)","required":false,"schema":{"type":"integer","format":"int32","maximum":6,"minimum":1},"example":1}],"responses":{"200":{"description":"The chart","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ChartOfAccountsResponse"}}}},"400":{"description":"Malformed parameter (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"The charts have not been loaded yet (code CHART_OF_ACCOUNTS_NOT_LOADED)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/chart-of-accounts/{code}":{"get":{"tags":["Chart of accounts (PCMN / MAR)"],"summary":"One account of a chart of accounts","operationId":"findAccount","parameters":[{"name":"code","in":"path","description":"The account number, a range as 164-165","required":true,"schema":{"type":"string","pattern":"^(\\d{1,6}(-\\d{1,6})?|\\.\\.\\.\\d)$"},"example":110},{"name":"type","in":"query","description":"enterprise (enterprises other than associations and foundations) or association (associations and foundations)","required":false,"schema":{"type":"string","default":"enterprise","pattern":"^(enterprise|association)$"},"example":"enterprise"},{"name":"lang","in":"query","description":"fr, nl, en or de","required":false,"schema":{"type":"string","default":"fr","pattern":"^(fr|nl|en|de)$"},"example":"fr"}],"responses":{"200":{"description":"The account","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}},"400":{"description":"Malformed parameter (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such account in the chart in that language (code ACCOUNT_NOT_FOUND)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"The charts have not been loaded yet (code CHART_OF_ACCOUNTS_NOT_LOADED)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}},"/api/v1/bel/chart-of-accounts/notes":{"get":{"tags":["Chart of accounts (PCMN / MAR)"],"summary":"The notes of a chart of accounts","description":"The chart's footnotes as published, those no label refers to included.","operationId":"findNotes","parameters":[{"name":"type","in":"query","description":"enterprise (enterprises other than associations and foundations) or association (associations and foundations)","required":false,"schema":{"type":"string","default":"enterprise","pattern":"^(enterprise|association)$"},"example":"enterprise"},{"name":"lang","in":"query","description":"fr, nl, en or de","required":false,"schema":{"type":"string","default":"fr","pattern":"^(fr|nl|en|de)$"},"example":"fr"}],"responses":{"200":{"description":"The notes","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AccountNoteResponse"}}}}},"400":{"description":"Malformed parameter (code INVALID_REQUEST)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"503":{"description":"The charts have not been loaded yet (code CHART_OF_ACCOUNTS_NOT_LOADED)","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"The X-API-Key header carries an unknown, revoked or malformed key (code INVALID_API_KEY). Leave the header out to call anonymously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests from this client: the code is RATE_LIMITED, Retry-After says in how many seconds a request will pass again.","headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"string"}},"X-RateLimit-Limit":{"description":"Sustained requests per second allowed on this path","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Requests left in the current burst","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"security":[{},{"apiKey":[]}]}}},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"code":{"type":"string"},"correlationId":{"type":"string"}}},"AccountNoteResponse":{"type":"object","properties":{"number":{"type":"string","description":"The note's number as printed","example":"31"},"text":{"type":"string","description":"Its text as published, paragraphs separated by a line feed; null when this language's page has no such note","example":"La partie non encore appelée de l'apport promis inscrit sur ce compte doit être portée au crédit d'un sous-compte distinct de ce compte."}}},"AccountResponse":{"type":"object","properties":{"code":{"type":"string","description":"The account number; a range when the chart prints one (\"164 à 165\" is served as 164-165), or a sub-account pattern (...0) under the account listed before it","example":"110"},"name":{"type":"string","description":"The label as published, without its note markers; null when the line has none (the CNC/CBN prints [...] or nothing for a repealed account)","example":"Apport disponible hors capital"},"level":{"type":"integer","format":"int32","description":"The number of digits: 1 for a class, the start's for a range, one more than its parent's for a sub-account pattern","example":3},"parentCode":{"type":"string","description":"The closest account of the chart containing this one, null for a class","example":"11"},"notes":{"type":"array","description":"The footnotes the label refers to, with their text","items":{"$ref":"#/components/schemas/AccountNoteResponse"}},"annualAccountsHeadings":{"type":"array","description":"The corresponding headings of the complete model of annual accounts, as printed next to the account: two for an account that can be an asset or a liability (VII.A and IX.C.1); empty in the chart of enterprises, which prints none","example":["VII.A.5"],"items":{"type":"string"}},"description":{"type":"string","description":"The chart's \"determination of the content of certain accounts\" text (class 0), paragraphs separated by a line feed; null when there is none"}}},"ChartOfAccountsResponse":{"type":"object","properties":{"type":{"type":"string","description":"enterprise or association","example":"enterprise"},"language":{"type":"string","description":"fr, nl, en or de","example":"fr"},"coordinatedOn":{"type":"string","format":"date","description":"The date the CNC/CBN coordinated the text on","example":"2019-05-07"},"source":{"type":"string","format":"uri","description":"The CNC/CBN page the chart was read from","example":"https://www.cnc-cbn.be/fr/node/2250"},"accounts":{"type":"array","description":"The accounts, in the published order","items":{"$ref":"#/components/schemas/AccountResponse"}}}}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"Optional. A key of a registered developer (portal: /account/) raises the request rate of the client from the anonymous per-IP limit to the plan's. Without it the request is anonymous; an unknown or revoked key is refused (401 INVALID_API_KEY).","name":"X-API-Key","in":"header"}}}}