{
  "opencollection": "1.0.0",
  "info": {
    "name": "Sibill Integration Account Counterpart API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Counterpart",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the list of counterparts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/counterparts",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The company the counterparts belongs to"
              },
              {
                "name": "page_size",
                "value": "",
                "type": "query",
                "description": "The page size"
              },
              {
                "name": "cursor",
                "value": "",
                "type": "query",
                "description": "The pagination cursor. A cursor is used to paginate through a large set of data.\nIt is a unique identifier that represents a specific position in the dataset.\n"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "List of filters on the resource. Currently the fields that allow to be filtered are: `vat_number`, `tax_number`, `company_name`"
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Fields for which we can order the results. Sortable fields: `company_name`"
              }
            ]
          },
          "docs": "The return value is paginated. By default the response contains 25 elements per page but can be instructed to return more elements per page.\nA cursor is needed to traverse the results.\n"
        },
        {
          "info": {
            "name": "Create a new counterpart",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/counterparts",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The company the counterpart belongs to"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new counterpart"
        },
        {
          "info": {
            "name": "Get a specific counterpart",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/counterparts/:id",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The company the counterpart belongs to"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The counterpart identifier"
              }
            ]
          },
          "docs": "Get a specific counterpart"
        },
        {
          "info": {
            "name": "Update an existing counterpart",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "http://integration.app.svc.cluster.local:4000/api/v1/companies/:company_id/counterparts/:id",
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "path",
                "description": "The company the counterpart belongs to"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The counterpart identifier"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an existing counterpart"
        },
        {
          "info": {
            "name": "Search counterpart informations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://integration.app.svc.cluster.local:4000/api/v1/counterparts/search",
            "params": [
              {
                "name": "vat_number",
                "value": "",
                "type": "query",
                "description": "The VAT number of the counterpart to search"
              }
            ]
          },
          "docs": "Search for counterpart information from a third-party system.\n"
        }
      ]
    }
  ],
  "bundled": true
}