BSS API integration: sending documents and receiving statuses
BSS API sends Hanna invoices and credit notes to BSS and receives document statuses and payments. Invoice lines are not imported from BSS.
When setting up the integration, we’ll agree which data to transfer and in which direction.
Data and transfer directions
| Data | Hanna → BSS API | BSS API → Hanna | Conditions and meaning |
|---|---|---|---|
| Clients | Yes | Yes | Separate integration account and organisation scope. |
| Sales invoices | Document | Status | A returned status does not replace all invoice lines or contents. |
| Credit notes | Document | Status | Document export and status return are separate flows. |
| Payments | — | Yes | The related document must be recognised. |
| Objects | Yes | — | Enabled organisation and object data scope apply. |
Before launch
- Connect the required BSS API integration account and agree organisation scope. If several organisations are used, check their links separately.
- Enable the required types: document export, status import and payment import. Enabling one direction does not enable every other flow.
- Test a customer, invoice, credit note and payment; check the status in both systems.
Limitations and document changes
- Invoice and credit note statuses return from BSS to Hanna. Their contents in Hanna remain unchanged.
- Agree how often statuses and payments are updated when setting up the integration.
If data is not transferred
- If an invoice was sent but its status did not change, separately check status import activation and results.
- Check invoice details in BSS when you need them. The document’s status is returned to Hanna.