Merge pull request #115 from unbill/BDCS-4700

add listByPartner api call

Author: sgau77

source/includes/api/bill/_list-by-partner.md.erb

@@ -0,0 +1,80 @@
+## List all bills by partnerId
+
+> Example Request
+
+```shell
+  curl <%= config.host %>/bill/listByPartner/616f208da973a0828ecd015c
+    -H "<%= config.auth %>"
+    -G
+```
+
+> Example Response
+
+```json
+{
+  "data": [
+    {
+      "bill": {
+        "_id": "579b695decfa11012711875d",
+        "auth": {
+              "_id": "616f208da973a0828ecd0166",
+              "created": "2021-10-19T19:46:21.685Z",
+              "status": {
+                "type": "verified"
+              },
+              "company": {
+                "_id": "579b695decea110719b1874d",
+                "name": "<%= config.billerName %>",
+                "logo": {
+                "url": "<%= config.billerLogo %>",
+                "background": false
+                },
+                "schedule": "on-due-date"
+                },
+              "items": ["bill"]
+            },
+        "balance": "100.00",
+        "customPaymentAmount": "50.00",
+        "dueDate": "<%= config.futureDate %>",
+        "payDate": "<%= config.futureDate %>",
+        "status": {
+          "type": "upcoming"
+        },
+        "settings": {
+          "recurring": "enabled",
+          "schedule": "on-due-date"
+        },
+        "company": {
+          "_id": "579b695decea110719b1874d",
+          "name": "<%= config.billerName %>",
+          "logo": {
+            "url": "<%= config.billerLogo %>",
+            "background": false
+          },
+          "schedule": "on-due-date"
+        }
+      },
+      "payments": [],
+      "partnerUserId": "616f208da973a0828ecd0164",
+      "partnerId": "616f208da973a0828ecd015c"
+    },
+  ]
+}
+```
+
+Retrieves a list of partner's active bills.
+
+### HTTP Request
+
+`GET <%= config.host %>/bill/listByPartner/{partnerId}`
+
+### Arguments
+
+Parameter | Description
+----- | -----------
+`partnerId` | ID of the partner to retrieve bills for.
+
+
+### Returns
+
+A dictionary with a `data` property that contains an array of bill details.

source/index.html.md.erb

@@ -27,6 +27,7 @@ includes:
   - api/bill/schedule
   - api/bill/details
   - api/bill/list
+  - api/bill/list-by-partner
   - api/company/index
   - api/company/object
   - api/company/logos