Set Up the Platform Connection
Connecting Business Central to the e-invoice platform takes three steps: allow the extension to make outbound calls, enter the API key id and secret, and test the connection. Once the test reports how many companies your key can reach, the connection is working and you can go on to map your companies.
Do this once per Business Central database. The credentials are shared by every company in the database.
Prerequisites
- An account with the e-invoice platform provider, with an API key id and an API secret.
- The E-Invoice Platform Admin permission set. The day-to-day user set has read-only access to setup on purpose.
Allow outbound calls first
Nothing else works until this is on, and a fresh install always has it off.
- Choose the
Search icon, enter Extension Management, and then choose the related link. - Select E-Invoice Platform.
- Choose the Configure action.
- On the Extension Settings page, switch on Allow HttpClient Requests.
Note
Configure is not the same action as Set up. Set up opens this app's own setup page; the outbound-calls switch is only on Extension Settings, behind Configure.
Reinstalling the extension switches this off again, so check it after any reinstall. Until it is on, calls fail with no status code and no message from the platform at all.
Enter the credentials
- Choose the Search icon, enter E-Invoice Platform Setup, and then choose the related link. The page is also registered in Manual Setup, under the keywords Peppol, E-Invoice, Electronic Invoice, Recommand and E-Document.
- On the Connection FastTab, fill in the fields as described in the following table.
- Choose the Test Connection action.
| Field | What to enter |
|---|---|
| Base URL | The platform API base URL. It is filled in with the provider's standard endpoint, so leave it unless you have been told otherwise. A trailing slash is added automatically. |
| API Key Id | The Basic API key id — the part before the colon. The key belongs to your team and can reach every company in it. |
| API Secret | The secret that goes with the key. Type it once; it is stored encrypted and never shown again. |
The secret is kept outside the database tables and is never returned by any page or API, so once it is saved you cannot read it back — you can only replace it or clear it. The Secret Configured field tells you whether one is stored.
If you change the Base URL to an address that does not start with https://, the page warns you that credentials would be sent unencrypted. Choose Reset Base URL to Default to put the standard endpoint back.
Verify the setup
Choose Test Connection. On success you get:
Connection OK. This API key can reach n company/companies.
That number is how many companies exist on the platform under this key, not how many Business Central companies are mapped. Connection Status turns to OK, and Last Tested and Last Test Result record what happened.
If the key is valid but reaches nothing, you get This API key cannot reach any companies on the e-invoice platform. — the key works, but no company has been created on the platform side yet. Contact the platform provider.
Replace or remove the secret
To replace the secret, type the new one over the masked placeholder and the page saves it. Leaving the placeholder untouched keeps the current secret.
To remove it, choose the Clear Secret action. You are asked to confirm, because the secret is shared:
Remove the stored API secret? Every company in this database will stop sending until a new secret is entered.
What happens next
With the connection working, map each Business Central company to the entity it sends as. Nothing can be sent until that mapping exists and has passed its identity check. Go to Map Your Companies to the Platform.