Download OpenAPI specification:
Disclaimer
You are viewing an unfinished version of this technical documentation.
This API specification is not yet final.
Welcome to the AbaBridge Partner-API documentation.
In order to use the API one first needs a DeepCloud business organisation account, which can be created when accessing the Partner-API application for the first time. Select 'Create account' when prompted with the 'deepcloud Sign in'.
Once you are successfully authenticated within the Partner-API application, you may then
create an AbaBridge account. Finally and in order to use this API, you can generate an API token.
The token needs to be included in the
'Authorization' HTTP header,
prefixed with 'Token ' (e.g. Authorization: Token <your-generated-api-token>).
Returns a list of business cases relevant to the AbaBridge account.
Filtering by pending status is particularly useful
for scheduled processing of available business cases.
Business cases are periodically deleted.
The specific date of deletion is denoted in their deletionDate property.
| abaNetId required | integer <int64> The ID of the account associated with the business case |
| status | string The status by which the business cases are filtered |
Creates a business case issued by the account with the given AbaNet-ID using the target network.
The response will contain the id of the successfully created business case.
| abaNetId required | integer <int64> The ID of the account issueing the business case |
| network required | string Enum: "AbaNet" "eBill" The target network of the business case |
| abaDoc required | string <binary> <application/xml> The business case including meta information in AbaDoc/XML format |
string <binary> <application/pdf> The business case in PDF format |
Returns the business case associated with the given IDs if it exists.
Business cases are periodically deleted.
The specific date of deletion is denoted in their deletionDate property.
| abaNetId required | integer <int64> The ID of the account associated with the business case |
| businessCaseId required | string The ID of the business case |
After downloading and processing a business case,
it can then be marked as processed by setting the status to acknowledged.
That way, it will no longer appear when filtering business cases by status pending.
One may undo this operation by setting the status to pending.
| abaNetId required | integer <int64> The ID of the account associated with the business case |
| businessCaseId required | string The ID of the business case |
| status required | string The new status of the business case |
{- "status": "string"
}Returns a .zip file containing the files relevant for the business case, which may vary based on the type of business case and/or the formats that have been used.
| businessCaseId required | string The ID of the business case |
The creation of a business case in PDF/A-3b format works with a simple POST request where the PDF is the binst where the PDF is the binary payload of the request.
Note that only one PDF can be submitted at a time.
| billerPid required | integer <int64> Example: 41090001234567890 Partner-Id of the biller |
| pdf required | string <binary> The business case in PDF/A-3b format |
| abadoc | string <binary> The business case including meta information in XML/AbaDoc format. |
Returns a list of one or more bill recipients.
The response will only list a bill recipient if he allows bills to be posted by the biller or allows bills to be posted in general. It will always return the billRecipientId and optionally any other provided parameter. The call will return an empty list if no matching bill recipient is found or the biller is not allowed to send bills to the bill recipient.
| billerPid required | integer <int64> |
| emailAddress | string |
| billRecipientId | integer <int64> [ 41000000000000000 .. 42000000000000000 ] Id of the bill recipient |
| enterpriseIdentificationNumber | stringCHE\d{9} Swiss enterprise identification number (UID) without dashes, dots or extension. Note that this has to contain the swiss enterprise identification number (UID) from the commercial register (Handelsregister) which may be different from the VAT UID (Mehrwertsteuer UID). |
{- "emailAddress": "john.doe@acme.org",
- "billRecipientId": 41010560425610180,
- "enterpriseIdentificationNumber": "CHE123456789"
}Events for status changes of instalment bills only which belong to any billerPid registered with the requesting SWP.
| billerPid required | integer <int64> Example: 41090001234567890 Partner-Id of the biller |
| lastEventId | string Example: lastEventId=EVID00000000000000001234567890ABCDEF Id of the last event processed by the caller |
| limit | integer <int32> ( 0 .. 10000 ] Default: 1000 |
Events for status changes of bills, advices, credit notes and reminders which belong to any billerPid registered with the requesting SWP.
| billerPid required | integer <int64> Example: 41090001234567890 Partner-Id of the biller |
| lastEventId | string Example: lastEventId=EVID00000000000000001234567890ABCDEF Id of the last event processed by the caller |
| limit | integer <int32> ( 0 .. 10000 ] Default: 1000 |
Events for status changes on bill recipient subscriptions to any billerPid registered with the requesting SWP, regardless if subscriptions have been done without registration form (event from infrastructure) or with registration form (no event from infrastructure).
| billerPid required | integer <int64> Example: 41090001234567890 Partner-Id of the biller |
| lastEventId | string Example: lastEventId=EVID00000000000000001234567890ABCDEF Id of the last event processed by the caller |
| limit | integer <int32> ( 0 .. 10000 ] Default: 1000 |
This event is triggered after any billerPid registered with the requesting SWP has submitted a business case with an outdated, so called historically available email address. It notifies about the changed email address of a bill recipient, which has been adjusted in eBill. An email address is considered to be historically available if it was present up to 15 months prior to the submission time.
The billers are able to submit business cases with historically available email addresses of a bill recipient. However, latest 15 months after the email address changed, the billers are required to submit the business cases with the currently valid email address of the bill recipient.
| billerPid required | integer <int64> Example: 41090001234567890 Partner-Id of the biller |
| lastEventId | string Example: lastEventId=EVID00000000000000001234567890ABCDEF Id of the last event processed by the caller |
| limit | integer <int32> ( 0 .. 10000 ] Default: 1000 |
Returns the biller's business case with the given business case ID.
The returned JSON object contains one of the business case subtypes: Bill, InstalmentBill, Reminder, CreditNote or Advice.
| billerPid required | integer <int64> |
| businessCaseId required | string <uuid> |