Versions Compared

Version Old Version 2 New Version Current
Changes made by

Tay Leung

Joshua Smee

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method

Name

Description

Parameters

Return values

Exceptions

POST

sendInvoice/Email

Sends UBL invoice

(UBL XML)

deliveryType

deliveryAddress

POST

sendInvoiceEmail

via email to specified addresses. 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:

deliveryAddresses (List<String>)

Body:

invoice (UBL 2.1 XML)

communicationReport (JSON)

{

"xmlFound": (boolean)

"xmlRightSize": (boolean)

deliveryAddress

POST

sendInvoiceSMS

invoice (UBL XML)

deliveryAddress

GET

getInvoiceStatus

Waits for a

invoiceID

connection???????

invoiceStatus - a list of error values, or none if successful

,

"emailValid": (boolean)

"connectedToMail": (boolean),

"sentMail": (boolean),

"timeTaken": (integer)

}

400 errors:

  • Invalid/Missing email address

  • No XML invoice

413 errors:

  • XML invoice >10MB

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)

numSuccess: (Integer)

currentVersion: (String)

}

None

...