...
Method | Name | Description | Parameters | Return values | Exceptions | |||
---|---|---|---|---|---|---|---|---|
POST | sendInvoice/Email | Sends UBL invoice via email to specified addressaddresses. Returns a communication report informing user of success/errors: if unsuccessful, the report has errors (eg. email address invalid, connection not etablished etc.). It also includes address, client, time/date. It will be readable for humans to understand. Should also save a record of the transaction | Header:
Body:
| GET | getHealthCheck | Waits for a ping from | invoiceID connection | communicationReport - JSON Invalid email address |
POST | sendInvoice/SMS | Sends UBL invoice via SMS to specified address. Returns a communication report informing user of success/errors. | invoice (UBL XML) deliveryAddress | communicationReport - JSON | Invalid number | |||
status - a list of error values, or none if successful(JSON)
| 400 errors:
413 errors:
| |||||||
GET | getHealthCheck | Health check endpoint that indicates the aliveness of this service. Gives information about success, server up time, number of transactions and current version. | None |
| None |
...