{
  "opencollection": "1.0.0",
  "info": {
    "name": "Clients AR Account reports Client Invoices API",
    "version": "v1"
  },
  "items": [
    {
      "info": {
        "name": "Client Invoices",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get client invoices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.agicap.com/public/business-documents/v1/entities/:entityid/connections/:connectionid/client-invoices",
            "params": [
              {
                "name": "entityid",
                "value": "",
                "type": "path",
                "description": "Agicap entity unique identifier"
              },
              {
                "name": "connectionid",
                "value": "",
                "type": "path",
                "description": "The connection unique identifier"
              },
              {
                "name": "pagesize",
                "value": "",
                "type": "query",
                "description": "Number of items per page (max 10 000)"
              },
              {
                "name": "pageindex",
                "value": "",
                "type": "query",
                "description": "Page index"
              },
              {
                "name": "externalids",
                "value": "",
                "type": "query",
                "description": "Unique identifier of the document in the data source"
              },
              {
                "name": "updatedsince",
                "value": "",
                "type": "query",
                "description": "Will return only documents updated **after** this date"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter on status. Possible values : draft, due, paid, cancelled, deleted"
              }
            ]
          },
          "docs": "Get client invoices"
        },
        {
          "info": {
            "name": "Create client invoices",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.agicap.com/public/business-documents/v1/entities/:entityid/connections/:connectionid/client-invoices",
            "params": [
              {
                "name": "entityid",
                "value": "",
                "type": "path",
                "description": "Agicap entity unique identifier"
              },
              {
                "name": "connectionid",
                "value": "",
                "type": "path",
                "description": "The connection unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create client invoices"
        },
        {
          "info": {
            "name": "Update client invoices",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.agicap.com/public/business-documents/v1/entities/:entityid/connections/:connectionid/client-invoices",
            "params": [
              {
                "name": "entityid",
                "value": "",
                "type": "path",
                "description": "Agicap entity unique identifier"
              },
              {
                "name": "connectionid",
                "value": "",
                "type": "path",
                "description": "The connection unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "To mark an invoice as paid, update it with the following value : `\"status\": \"paid\"` and `\"dueAmount\": 0`<br><br>To delete an invoice, update it with the following value : `\"status\" = \"deleted\"`"
        },
        {
          "info": {
            "name": "Get client invoices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.agicap.com/public/business-documents/v2/entities/:entityid/connections/:connectionid/client-invoices",
            "params": [
              {
                "name": "entityid",
                "value": "",
                "type": "path",
                "description": "Agicap entity unique identifier"
              },
              {
                "name": "connectionid",
                "value": "",
                "type": "path",
                "description": "The connection unique identifier"
              },
              {
                "name": "pagesize",
                "value": "",
                "type": "query",
                "description": "Number of items per page (max 10 000)"
              },
              {
                "name": "pageindex",
                "value": "",
                "type": "query",
                "description": "Page index"
              },
              {
                "name": "externalids",
                "value": "",
                "type": "query",
                "description": "Unique identifier of the document in the data source"
              },
              {
                "name": "updatedsince",
                "value": "",
                "type": "query",
                "description": "Will return only documents updated **after** this date"
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter on status. Possible values : draft, due, paid, cancelled, deleted"
              }
            ]
          },
          "docs": "Get client invoices"
        },
        {
          "info": {
            "name": "Create client invoices",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.agicap.com/public/business-documents/v2/entities/:entityid/connections/:connectionid/client-invoices",
            "params": [
              {
                "name": "entityid",
                "value": "",
                "type": "path",
                "description": "Agicap entity unique identifier"
              },
              {
                "name": "connectionid",
                "value": "",
                "type": "path",
                "description": "The connection unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create client invoices"
        },
        {
          "info": {
            "name": "Update client invoices",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.agicap.com/public/business-documents/v2/entities/:entityid/connections/:connectionid/client-invoices",
            "params": [
              {
                "name": "entityid",
                "value": "",
                "type": "path",
                "description": "Agicap entity unique identifier"
              },
              {
                "name": "connectionid",
                "value": "",
                "type": "path",
                "description": "The connection unique identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "To mark an invoice as paid, update it with the following value : `\"status\": \"paid\"` and `\"dueAmount\": 0`<br><br>To delete an invoice, update it with the following value : `\"status\" = \"deleted\"`"
        }
      ]
    }
  ],
  "bundled": true
}