{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bank Feeds Account mapping Push data API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Push data",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get push options",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/options/:dataType",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              },
              {
                "name": "dataType",
                "value": "",
                "type": "path",
                "description": "The key of a Codat data type."
              }
            ]
          },
          "docs": "This is the generic documentation for creation and updating of data. See the equivalent endpoint for a given data type for more specific information. \n\nBefore pushing data into accounting software, it is often necessary to collect some details from the user as to how they would like the data to be inserted. This includes names and amounts on transactional entities, but also factors such as categorisation of entities, which is often handled differently between different accounting software. A goo"
        },
        {
          "info": {
            "name": "List push operations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/push",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "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)."
              }
            ]
          },
          "docs": "The **List push operations** endpoint returns a list of [push operations](/using-the-api/push) performed on the company.\n\nWrite operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software."
        },
        {
          "info": {
            "name": "Get push operation",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/push/:pushOperationKey",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "pushOperationKey",
                "value": "",
                "type": "path",
                "description": "Push operation key."
              }
            ]
          },
          "docs": "The **Get push operation** endpoint returns a specific [push operation](/using-the-api/push) identified by the `pushOperationKey` that was performed on the company.\n\nWrite operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software."
        }
      ]
    }
  ],
  "bundled": true
}