As a contractor, I should be able to get all payments for a milestone, so that I can review the cash spending

[arafaysaleem]

Summary

As a contractor, I should be able to get all payments for a milestone, so that I can review the cash spending.

Acceptance Criteria

Scenario 1: Search for all possible payments in a milestone

GIVEN an contractor is requesting all possible payments in the desktop app
WHEN the app hits the /milestones/:id/payments endpoint with a valid GET request, containing the path parameter:

• :id, the unique id of the milestone for which the payments are needed.

THEN the app should receive a status 200
AND in the response, the following information should be returned:

• headers
• list of payments

Sample Request/Sample Response
For e.g. If we request payments for milestone id 2:

headers: {
    error: 0,
    message: "..."
}
body: [
    {
        pay_id: 0,
        pay_type_id: "1",
        milestone_id: "2"
        amount: "20000",
        method: "cash",
        pay_datetime: "26-07-21 13:01:05"
    },
    {
        pay_id: 1,
        pay_type_id: "1",
        milestone_id: "2"
        amount: "10000",
        method: "cheque",
        pay_datetime: "26-07-21 13:01:05"
    },
    ....
]

Scenario 2: Search for all payments in a milestone by payment type

GIVEN an contractor is requesting all payments for a payment type in the desktop app
WHEN the app hits the /milestones/:id/payments endpoint with a valid GET request, containing:-"

• the path parameter:
  • :id, the unique id of the milestone for which the payments are needed.
• the query parameters:
  • pay_type_id="some_id", where some_id is the pay_type_id of that payment type**

THEN the app should receive a status 200
AND in the response, the following information should be returned:

• headers
• list of payments having that payment type

Sample Request/Sample Response
For query parameter pay_type_id=3:

headers: {
    error: 0,
    message: "..."
}
body: [
    {
        pay_id: 0,
        pay_type_id: "3",
        milestone_id: "2"
        amount: "20000",
        method: "cash",
        pay_datetime: "26-07-21 13:01:05"
    },
    {
        pay_id: 1,
        pay_type_id: "3",
        milestone_id: "2"
        amount: "10000",
        method: "cheque",
        pay_datetime: "26-07-21 13:01:05"
    },
    ....
]

Resources

• Development URL: {Here goes a URL to the feature on development API}
• Production URL: {Here goes a URL to the feature on production API}

Dev Notes

Display pay_type name instead of id in response json

Testing Notes

{notes for QA, with examples if applicable}