Content Comparison

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.

Header:deliveryAddress

deliveryAddresses (List<String>)

Body:

invoice (UBL 2.1 XML)

communicationReport (JSON)

{

connectedToMail: (boolean)

sentMail: (boolean)

timeTaken: (boolean)

}

400 errors:

GET

getHealthCheck

Waits for a ping from

invoiceID

connection

• Invalid/Missing email address

POST

sendInvoice/SMS

Sends UBL invoice via SMS to specified address. Returns a communication report informing user of success/errors.

Header:

deliveryAddress

Body:

invoice (UBL XML)

communicationReport (JSON)

Invalid number

• No XML invoice

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

{

alive: (boolean)

serverUpTime: (Integer)

numTransactions: (Integer)

currentVersion: (String)

}

None