@codat/lending 0.1.0

package/dist/sdk/models/shared/accountingageddebtorreport.js

@@ -0,0 +1,93 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountingAgedDebtorReport = void 0;
+var utils_1 = require("../../../internal/utils");
+var ageddebtor_1 = require("./ageddebtor");
+var class_transformer_1 = require("class-transformer");
+/**
+ * The Aged Debtors report shows the total outstanding balance due from customers to the business over time.
+ *
+ * @remarks
+ *
+ * You can generate it for a company based on recently synced data from your customers' accounting platforms. The report is available in the **Reports** tab in the Codat portal.
+ *
+ * Total assets or liabilities are grouped into 30-day periods for each customer, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.
+ *
+ * > It is not guaranteed that write-offs are included in the Aged Debtors report.
+ *
+ * ## Underlying data
+ *
+ * The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/accounting-api#/schemas/Customer), [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/accounting-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/accounting-api#/schemas/Payment).
+ *
+ * To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.
+ *
+ * > The Aged Debtors report runs based on the **issue dates** of the underlying data types rather than the due date.
+ *
+ * ## Accessing the Aged Debtors report in Portal
+ *
+ * Apart from returning the report via the API as JSON and query, you can also return the Aged Debtors report in the Codat portal.
+ *
+ * 1. In the navigation bar, click **Companies**.
+ * 2. Click the name of the company you want to generate the report for. The company's data page is displayed.
+ * 3. Click the **Accounting** tab then click **Reports**.
+ * 4. Select **Aged Debtors**.
+ * 5. _(Optional)_ Edit the default reporting parameters.
+ *    a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date.
+ *    b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).
+ *    b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).
+ * 6. To run the report, click **Load aged debtors**.
+ * 7. The report is generated and displayed at the bottom of the page.
+ *
+ * The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes.
+ */
+var AccountingAgedDebtorReport = /** @class */ (function (_super) {
+    __extends(AccountingAgedDebtorReport, _super);
+    function AccountingAgedDebtorReport() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: ageddebtor_1.AgedDebtor }),
+        (0, class_transformer_1.Expose)({ name: "data" }),
+        (0, class_transformer_1.Type)(function () { return ageddebtor_1.AgedDebtor; }),
+        __metadata("design:type", Array)
+    ], AccountingAgedDebtorReport.prototype, "data", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "generated" }),
+        __metadata("design:type", String)
+    ], AccountingAgedDebtorReport.prototype, "generated", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "reportDate" }),
+        __metadata("design:type", String)
+    ], AccountingAgedDebtorReport.prototype, "reportDate", void 0);
+    return AccountingAgedDebtorReport;
+}(utils_1.SpeakeasyBase));
+exports.AccountingAgedDebtorReport = AccountingAgedDebtorReport;

package/dist/sdk/models/shared/accountingattachment.d.ts

@@ -0,0 +1,75 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+/**
+ * The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.
+ *
+ * @remarks
+ *
+ * > **Retrieving attachments**
+ * >
+ * > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.
+ *
+ * Unlike other data types, Codat doesn't support sync settings for attachments.
+ *
+ * Note that different integrations have different requirements to file size and extension of attachments.
+ *
+ * | Integration       | File size | File extension                                                                                                                                               |
+ * |-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+ * | Xero              | 4 MB      | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF,   ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX,   ZIP |
+ * | QuickBooks Online | 100 MB    | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF,   TXT, XLS, XLSX, XML                                                               |
+ * | NetSuite          | 100 MB    | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF,   DOC, DOCX, ZIP                                                                      |
+ *
+ * View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
+ *
+ */
+export declare class AccountingAttachment extends SpeakeasyBase {
+    /**
+     * File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**.
+     *
+     * @remarks
+     *
+     * Supported file types vary per platform.
+     */
+    contentType?: string;
+    /**
+     * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    dateCreated?: string;
+    /**
+     * File size in bytes. For example, if this reads **46153**, then the file size is 46kb.
+     */
+    fileSize?: number;
+    /**
+     * Identifier for the attachment, unique for the company in the accounting platform.
+     */
+    id?: string;
+    /**
+     * If `true`, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting platform allows this.
+     */
+    includeWhenSent?: boolean;
+    modifiedDate?: string;
+    /**
+     * Name of the attachment file.
+     */
+    name?: string;
+    sourceModifiedDate?: string;
+}

package/dist/sdk/models/shared/accountingattachment.js

@@ -0,0 +1,102 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountingAttachment = void 0;
+var utils_1 = require("../../../internal/utils");
+var class_transformer_1 = require("class-transformer");
+/**
+ * The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.
+ *
+ * @remarks
+ *
+ * > **Retrieving attachments**
+ * >
+ * > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.
+ *
+ * Unlike other data types, Codat doesn't support sync settings for attachments.
+ *
+ * Note that different integrations have different requirements to file size and extension of attachments.
+ *
+ * | Integration       | File size | File extension                                                                                                                                               |
+ * |-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
+ * | Xero              | 4 MB      | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF,   ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX,   ZIP |
+ * | QuickBooks Online | 100 MB    | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF,   TXT, XLS, XLSX, XML                                                               |
+ * | NetSuite          | 100 MB    | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF,   DOC, DOCX, ZIP                                                                      |
+ *
+ * View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
+ *
+ */
+var AccountingAttachment = /** @class */ (function (_super) {
+    __extends(AccountingAttachment, _super);
+    function AccountingAttachment() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "contentType" }),
+        __metadata("design:type", String)
+    ], AccountingAttachment.prototype, "contentType", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "dateCreated" }),
+        __metadata("design:type", String)
+    ], AccountingAttachment.prototype, "dateCreated", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "fileSize" }),
+        __metadata("design:type", Number)
+    ], AccountingAttachment.prototype, "fileSize", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], AccountingAttachment.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "includeWhenSent" }),
+        __metadata("design:type", Boolean)
+    ], AccountingAttachment.prototype, "includeWhenSent", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "modifiedDate" }),
+        __metadata("design:type", String)
+    ], AccountingAttachment.prototype, "modifiedDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "name" }),
+        __metadata("design:type", String)
+    ], AccountingAttachment.prototype, "name", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "sourceModifiedDate" }),
+        __metadata("design:type", String)
+    ], AccountingAttachment.prototype, "sourceModifiedDate", void 0);
+    return AccountingAttachment;
+}(utils_1.SpeakeasyBase));
+exports.AccountingAttachment = AccountingAttachment;

package/dist/sdk/models/shared/accountingbalancesheet.d.ts

@@ -0,0 +1,90 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { BalanceSheet } from "./balancesheet";
+/**
+ * > View the coverage for balance sheet in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=balanceSheet" target="_blank">Data coverage explorer</a>.
+ *
+ * @remarks
+ *
+ * ## Overview
+ *
+ * The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes.
+ *
+ * > **Balance sheet or profit and loss report?**
+ * >
+ * > A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time.
+ *
+ * **Structure of this report**
+ * This report will reflect the structure and line descriptions that the business has set in their own accounting platform.
+ *
+ * **History**
+ * By default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/update-sync-settings).
+ *
+ * **Want to pull this in a standardised structure?**
+ * Our [Enhanced Financials](https://docs.codat.io/assess/enhanced-financials/overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers.
+ */
+export declare class AccountingBalanceSheet extends SpeakeasyBase {
+    /**
+     * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
+     *
+     * @remarks
+     *
+     * ## Unknown currencies
+     *
+     * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+     *
+     * There are only a very small number of edge cases where this currency code is returned by the Codat system.
+     */
+    currency: string;
+    /**
+     * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    earliestAvailableMonth?: string;
+    /**
+     * In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:
+     *
+     * @remarks
+     *
+     * ```
+     * 2020-10-08T22:40:50Z
+     * 2021-01-01T00:00:00
+     * ```
+     *
+     *
+     *
+     * When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:
+     *
+     * - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`
+     * - Unqualified local time: `2021-11-15T01:00:00`
+     * - UTC time offsets: `2021-11-15T01:00:00-05:00`
+     *
+     * > Time zones
+     * >
+     * > Not all dates from Codat will contain information about time zones.
+     * > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
+     */
+    mostRecentAvailableMonth?: string;
+    /**
+     * An array of balance sheet reports.
+     */
+    reports: BalanceSheet[];
+}

package/dist/sdk/models/shared/accountingbalancesheet.js

@@ -0,0 +1,84 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountingBalanceSheet = void 0;
+var utils_1 = require("../../../internal/utils");
+var balancesheet_1 = require("./balancesheet");
+var class_transformer_1 = require("class-transformer");
+/**
+ * > View the coverage for balance sheet in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=balanceSheet" target="_blank">Data coverage explorer</a>.
+ *
+ * @remarks
+ *
+ * ## Overview
+ *
+ * The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes.
+ *
+ * > **Balance sheet or profit and loss report?**
+ * >
+ * > A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time.
+ *
+ * **Structure of this report**
+ * This report will reflect the structure and line descriptions that the business has set in their own accounting platform.
+ *
+ * **History**
+ * By default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/update-sync-settings).
+ *
+ * **Want to pull this in a standardised structure?**
+ * Our [Enhanced Financials](https://docs.codat.io/assess/enhanced-financials/overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers.
+ */
+var AccountingBalanceSheet = /** @class */ (function (_super) {
+    __extends(AccountingBalanceSheet, _super);
+    function AccountingBalanceSheet() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "currency" }),
+        __metadata("design:type", String)
+    ], AccountingBalanceSheet.prototype, "currency", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "earliestAvailableMonth" }),
+        __metadata("design:type", String)
+    ], AccountingBalanceSheet.prototype, "earliestAvailableMonth", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "mostRecentAvailableMonth" }),
+        __metadata("design:type", String)
+    ], AccountingBalanceSheet.prototype, "mostRecentAvailableMonth", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: balancesheet_1.BalanceSheet }),
+        (0, class_transformer_1.Expose)({ name: "reports" }),
+        (0, class_transformer_1.Type)(function () { return balancesheet_1.BalanceSheet; }),
+        __metadata("design:type", Array)
+    ], AccountingBalanceSheet.prototype, "reports", void 0);
+    return AccountingBalanceSheet;
+}(utils_1.SpeakeasyBase));
+exports.AccountingBalanceSheet = AccountingBalanceSheet;

package/dist/sdk/models/shared/accountingbankaccount.d.ts

@@ -0,0 +1,105 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { AccountingBankAccountType } from "./accountingbankaccounttype";
+import { Metadata } from "./metadata";
+/**
+ * > **Accessing Bank Accounts through Banking API**
+ *
+ * @remarks
+ * >
+ * > This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators.
+ * >
+ * > To view bank account data through the Banking API, please refer to the new datatype [here](https://docs.codat.io/banking-api#/schemas/Account)
+ *
+ * > View the coverage for bank accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bankAccounts" target="_blank">Data coverage explorer</a>.
+ *
+ * ## Overview
+ *
+ * A list of bank accounts associated with a company and a specific data connection.
+ *
+ * Bank accounts data includes:
+ * * The name and ID of the account in the accounting platform.
+ * * The currency and balance of the account.
+ * * The sort code and account number.
+ */
+export declare class AccountingBankAccount extends SpeakeasyBase {
+    /**
+     * Name of the bank account in the accounting platform.
+     */
+    accountName?: string;
+    /**
+     * Account number for the bank account.
+     *
+     * @remarks
+     *
+     * Xero integrations
+     * Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated.
+     *
+     * FreeAgent integrations
+     * For Credit accounts, only the last four digits are required. For other types, the field is optional.
+     */
+    accountNumber?: string;
+    /**
+     * The type of transactions and balances on the account.
+     *
+     * @remarks
+     * For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities.
+     * For Debit accounts, positive balances are assets, and positive transactions **increase** assets.
+     */
+    accountType?: AccountingBankAccountType;
+    /**
+     * Total available balance of the bank account as reported by the underlying data source. This may take into account overdrafts or pending transactions for example.
+     */
+    availableBalance?: number;
+    /**
+     * Balance of the bank account.
+     */
+    balance?: number;
+    /**
+     * The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.
+     *
+     * @remarks
+     *
+     * ## Unknown currencies
+     *
+     * In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction.
+     *
+     * There are only a very small number of edge cases where this currency code is returned by the Codat system.
+     */
+    currency?: string;
+    /**
+     * International bank account number of the account. Often used when making or receiving international payments.
+     */
+    iBan?: string;
+    /**
+     * Identifier for the account, unique for the company in the accounting platform.
+     */
+    id?: string;
+    /**
+     * The institution of the bank account.
+     */
+    institution?: string;
+    metadata?: Metadata;
+    modifiedDate?: string;
+    /**
+     * Code used to identify each nominal account for a business.
+     */
+    nominalCode?: string;
+    /**
+     * Pre-arranged overdraft limit of the account.
+     *
+     * @remarks
+     *
+     * The value is always positive. For example, an overdraftLimit of `1000` means that the balance of the account can go down to `-1000`.
+     */
+    overdraftLimit?: number;
+    /**
+     * Sort code for the bank account.
+     *
+     * @remarks
+     *
+     * Xero integrations
+     * The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated.
+     */
+    sortCode?: string;
+    sourceModifiedDate?: string;
+}