Versions Compared

Version Old Version 4 New Version Current
Changes made by

Tay Leung

Tay Leung

Saved on

Key

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

Need to create an API that sends an XML/UBL invoice to a number of recipients through SMS/Email.

The API will return (upon a call) a communication report.

The API needs to have a heathcheck endpoint.Functional Requirements - things it must or must not do.

Non-Functional Requirements - performance standards/quality, eg. security, scalability, usability, speed.

USER STORIES

As a business, I want to be able to send my invoiceinvoices, so that my client invoices can receive my invoicereach outside of my local system.

  • Sending via SMS/EmailSend UBL (in XML) for all clients to process the standard invoiceinvoice to address (possibly email)

  • Files sent in correct format (UBL XML)

As a business, I want to know if my invoice was sent successfully , so that I can make sure the invoice was sent or take further action.

  • Communication report with errors or successerror or success

  • Report includes the type of error/s (eg. email address invalid, connection not etablished etc.)

  • Report also includes address, client, time/date

  • Readable communication report for humans to understand

As a business, I want to send intact invoices successfully so that my invoices are sent and not lost.

  • Corruption check

  • Files sent in correct format (UBL XML)

As a business, I want to be able to deliver invoices in different ways, so that I have flexibility and choice in reaching my clients.

  • Sending via SMS

  • Sending via Email

As a business, I want to be able to send to multiple recipients at once, so I don’t have to send it to them individually.

USE CASE

  1. After requesting an invoice and it being created, I click send invoice

  2. I pick the delivery method (Email/SMS/SFTP) and input the details

  3. I click ‘send invoice’ and the system send the invoice to the addressee

  4. If the invoice is sent successfully, I receive a Communication Report with success and details

  5. If the invoice is sent unsuccessfully, I receive a Communication Report with related errors and details, and am taken back to the sending page.

Requirements

  • Ability to send XML via email, MMS and SFTP (MAYBE)

    • Ability to receive details of the user to send invoice

      • Ability to send to multiple users at once

    • Ability to recieve XML data

  • Ability to report back on success/failure of function

    • Ability to provide informative error description

  • The API needs to have a health check endpoint.