{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bank Feeds Account mapping Accounts payable API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Accounts payable",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List bill credit notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/billCreditNotes",
            "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 bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection.\n\n[Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
        },
        {
          "info": {
            "name": "Get bill credit note",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/billCreditNotes/:billCreditNoteId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "billCreditNoteId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a bill credit note."
              }
            ]
          },
          "docs": "The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.\n\n[Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
        },
        {
          "info": {
            "name": "List bill payments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/billPayments",
            "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 bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection.\n\n[Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
        },
        {
          "info": {
            "name": "Get bill payment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/billPayments/:billPaymentId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "billPaymentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a bill payment."
              }
            ]
          },
          "docs": "The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.\n\n[Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
        },
        {
          "info": {
            "name": "List bills",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/bills",
            "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 bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection.\n\n[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n\n### Tips and traps\n\nTo access the `paymentAllo"
        },
        {
          "info": {
            "name": "Get bill",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/bills/:billId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "billId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a bill."
              }
            ]
          },
          "docs": "The *Get bill* endpoint returns a single bill for a given billId.\n\n[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `billPayments` data type is queued"
        },
        {
          "info": {
            "name": "List bill attachments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              },
              {
                "name": "billId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a bill."
              }
            ]
          },
          "docs": "The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`.\n\n[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.\n"
        },
        {
          "info": {
            "name": "Get bill attachment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              },
              {
                "name": "billId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a bill."
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for an attachment."
              }
            ]
          },
          "docs": "The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.\n\n[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services."
        },
        {
          "info": {
            "name": "Download bill attachment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/data/bills/:billId/attachments/:attachmentId/download",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              },
              {
                "name": "billId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a bill."
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for an attachment."
              }
            ]
          },
          "docs": "The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`.\n\n[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services."
        },
        {
          "info": {
            "name": "List suppliers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/suppliers",
            "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 suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection.\n\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n    "
        },
        {
          "info": {
            "name": "Get supplier",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/data/suppliers/:supplierId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "supplierId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a supplier."
              }
            ]
          },
          "docs": "The *Get supplier* endpoint returns a single supplier for a given supplierId.\n\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n"
        },
        {
          "info": {
            "name": "List supplier attachments",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              },
              {
                "name": "supplierId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a supplier."
              }
            ]
          },
          "docs": "The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.\n\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n"
        },
        {
          "info": {
            "name": "Get supplier attachment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              },
              {
                "name": "supplierId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a supplier."
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for an attachment."
              }
            ]
          },
          "docs": "The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.\n\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n"
        },
        {
          "info": {
            "name": "Download supplier attachment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/data/suppliers/:supplierId/attachments/:attachmentId/download",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              },
              {
                "name": "supplierId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a supplier."
              },
              {
                "name": "attachmentId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for an attachment."
              }
            ]
          },
          "docs": "The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.\n\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n"
        },
        {
          "info": {
            "name": "Aged creditors report available",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/reports/agedCreditor/available",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ]
          },
          "docs": "Indicates whether the aged creditor report is available for the company."
        },
        {
          "info": {
            "name": "Aged creditors report",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/reports/agedCreditor",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "reportDate",
                "value": "",
                "type": "query",
                "description": "Date the report is generated up to."
              },
              {
                "name": "numberOfPeriods",
                "value": "",
                "type": "query",
                "description": "Number of periods to include in the report."
              },
              {
                "name": "periodLengthDays",
                "value": "",
                "type": "query",
                "description": "The length of period in days."
              }
            ]
          },
          "docs": "Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time."
        }
      ]
    }
  ],
  "bundled": true
}