{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bank Feeds Account mapping Companies API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Companies",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List companies",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. [Read more](https://docs.codat.io/using-the-api/paging)."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."
              },
              {
                "name": "query",
                "value": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
                "type": "query",
                "description": "Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."
              },
              {
                "name": "tags",
                "value": "region=uk && team=invoice-finance",
                "type": "query",
                "description": "Filter companies by tags using the \"equals\" (=), \"not equals\" (!=), and \"contains\" (~) operators with [Codat’s query language](https://docs.codat.io/using-the-api/querying)."
              }
            ]
          },
          "docs": "The *List companies* endpoint returns a list of [companies](https://docs.codat.io/bank-feeds-api#/schemas/Company) associated to your instances.\n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and "
        },
        {
          "info": {
            "name": "Create company",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.codat.io/companies",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the *Create company* endpoint to create a new [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank acc"
        },
        {
          "info": {
            "name": "Get company",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ]
          },
          "docs": "The *Get company* endpoint returns a single company for a given `companyId`.\n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.\n"
        },
        {
          "info": {
            "name": "Replace company",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.codat.io/companies/:companyId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the *Replace company* endpoint to replace the existing name, description, and tags of the company. Calling the endpoint will replace existing values even if new values haven't been defined in the payload.\n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, such as one connection to Xero for accou"
        },
        {
          "info": {
            "name": "Update company",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.codat.io/companies/:companyId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the *Update company* endpoint to update the name, description, or tags of the company.\n\nThe *Update company* endpoint doesn't have any required fields. If any of the fields provided are `null` or not provided, they won't be included in the update.  \n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data."
        },
        {
          "info": {
            "name": "Delete a company",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.codat.io/companies/:companyId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ]
          },
          "docs": "The *Delete company* endpoint permanently deletes a [company](https://docs.codat.io/bank-feeds-api#/schemas/Company), its [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/bank-feeds-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/bank-feeds-api#/schemas/Connection) to different data sources, su"
        },
        {
          "info": {
            "name": "Get company access token",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/accessToken",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ]
          },
          "docs": "Use the _Get company access token_ endpoint to return an access token for the specified company ID. The token is valid for one day. \n\nThe token is required by Codat's embeddable UIs (such as [Connections SDK](https://docs.codat.io/auth-flow/optimize/connection-management) and [Link SDK](https://docs.codat.io/auth-flow/authorize-embedded-link)) to verify the identity of the user and improve the reliability of data provided by them."
        },
        {
          "info": {
            "name": "Add product",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.codat.io/companies/:companyId/products/:productIdentifier",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "productIdentifier",
                "value": "",
                "type": "path",
                "description": "Human-readable product identifier for a product."
              }
            ]
          },
          "docs": "Use the *Add product* endpoint to enable a product for the company specified by `companyId`.\n\n> Note: This feature is currently in alpha and available only to participants in the development program."
        },
        {
          "info": {
            "name": "Remove product",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.codat.io/companies/:companyId/products/:productIdentifier",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "productIdentifier",
                "value": "",
                "type": "path",
                "description": "Human-readable product identifier for a product."
              }
            ]
          },
          "docs": "Use the *Remove product* endpoint to disable a product for the company specified by `companyId`.\n\n> Note: This feature is currently in alpha and available only to participants in the development program."
        },
        {
          "info": {
            "name": "Refresh product data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.codat.io/companies/:companyId/products/:productIdentifier/refresh",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "productIdentifier",
                "value": "",
                "type": "path",
                "description": "Human-readable product identifier for a product."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use the **Refresh product data** endpoint to manually refresh data for a custom product for a specific company.\n\n### Tips and traps\n\n- This endpoint only supports refreshing data for **custom products** and can't be used for Codat's standard solutions. Refer to [individual solutions' documentation](https://docs.codat.io/) instead.\n- If a data sync is already in progress for a custom product, the refresh request will return a `Bad request (400)` response.\n- If a company has multiple custom produc"
        },
        {
          "info": {
            "name": "Get company sync settings",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/syncSettings",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ]
          },
          "docs": "Retrieve the [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for a specific company. This includes how often data types should be queued to be updated, and how much history should be fetched."
        },
        {
          "info": {
            "name": "Set company sync settings",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.codat.io/companies/:companyId/syncSettings",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set the sync settings for a specific company."
        }
      ]
    }
  ],
  "bundled": true
}