Created 28 Feb 2017, by Steven Loh

Objective

Provide a set of API for integration with FO.

API list and endpoints

GET invoice/customer/{civ_id}/notes

Returns list of CN/DN associated with the specific customer invoice.

GET invoice/customer/{civ_id}/notes/{id}

1. Returns CN/DN details of a customer invoice identified by {id}.
2. Return CN/DN view model with dummy data if {id} is -1, and empty view model with default values if {id} is 0.
3. Returns 404 if the CN/DN does not belong to customer invoice with id {civ_id}.
4. Returns the printable format of the CN/DN when request specifies request header "Accept". Support MIME type of application/pdf and use GET params to determine A4 or dot-matrix.
   This print feature is not within the scope of this task, refer to task #162.

POST invoice/customer/{civ_id}/notes

Creates a new CN/DN for customer invoice identified by {civ_id}.

PUT invoice/customer/{civ_id}/notes/{id}

1. Updates a CN/DN details of a customer invoice identified by {id}.
2. Returns 404 if the CN/DN does not belong to customer invoice with id {civ_id}.

GET invoice/customer/{civ_id}/notes/{id}/status

1. Returns the status audit trail of the CN/DN identified by {id}.
2. Returns 404 if the CN/DN does not belong to customer invoice with id {civ_id}.

POST invoice/customer/{civ_id}/notes/{id}/status

1. Creates a new status for the CN/DN identified by {id}.
2. This API shall update the status of the CN/DN, and create a new record in status table for audit trail purposes.
3. This REST endpoint shall be used to confirm or cancel a CN/DN.

Others

1. API for CN/DN does not implement the DELETE method.
2. Estimation: 24 hours, including FO integration.