@codat/lending 0.1.0

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

@@ -0,0 +1,142 @@
+"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.AccountingAccountTransaction = exports.AccountingAccountTransactionStatus = void 0;
+var utils_1 = require("../../../internal/utils");
+var accounttransactionline_1 = require("./accounttransactionline");
+var bankaccountref_1 = require("./bankaccountref");
+var metadata_1 = require("./metadata");
+var class_transformer_1 = require("class-transformer");
+/**
+ * The status of the account transaction.
+ */
+var AccountingAccountTransactionStatus;
+(function (AccountingAccountTransactionStatus) {
+    AccountingAccountTransactionStatus["Unknown"] = "Unknown";
+    AccountingAccountTransactionStatus["Unreconciled"] = "Unreconciled";
+    AccountingAccountTransactionStatus["Reconciled"] = "Reconciled";
+    AccountingAccountTransactionStatus["Void"] = "Void";
+})(AccountingAccountTransactionStatus = exports.AccountingAccountTransactionStatus || (exports.AccountingAccountTransactionStatus = {}));
+/**
+ * > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting platform. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/banking-api#/operations/list-all-banking-transactions).
+ *
+ * @remarks
+ *
+ * > View the coverage for account transactions in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions" target="_blank">Data coverage explorer</a>.
+ *
+ * ## Overview
+ *
+ * In Codat’s data model, account transactions represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
+ *
+ * Account transactions are created as a result of different business activities, for example:
+ *
+ * * Payments: for example, receiving money for payment against an invoice.
+ * * Bill payments: for example, spending money for a payment against a bill.
+ * * Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment.
+ * * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale.
+ * * Transfers: for example, transferring money between two bank accounts.
+ *
+ * Account transactions is the parent data type of [payments](https://docs.codat.io/accounting-api#/schemas/Payment), [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/accounting-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer).
+ */
+var AccountingAccountTransaction = /** @class */ (function (_super) {
+    __extends(AccountingAccountTransaction, _super);
+    function AccountingAccountTransaction() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "bankAccountRef" }),
+        (0, class_transformer_1.Type)(function () { return bankaccountref_1.BankAccountRef; }),
+        __metadata("design:type", bankaccountref_1.BankAccountRef)
+    ], AccountingAccountTransaction.prototype, "bankAccountRef", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "currency" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "currency", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "currencyRate" }),
+        __metadata("design:type", Number)
+    ], AccountingAccountTransaction.prototype, "currencyRate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "date" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "date", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "id" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "id", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: accounttransactionline_1.AccountTransactionLine }),
+        (0, class_transformer_1.Expose)({ name: "lines" }),
+        (0, class_transformer_1.Type)(function () { return accounttransactionline_1.AccountTransactionLine; }),
+        __metadata("design:type", Array)
+    ], AccountingAccountTransaction.prototype, "lines", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "metadata" }),
+        (0, class_transformer_1.Type)(function () { return metadata_1.Metadata; }),
+        __metadata("design:type", metadata_1.Metadata)
+    ], AccountingAccountTransaction.prototype, "metadata", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "modifiedDate" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "modifiedDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "note" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "note", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "sourceModifiedDate" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "sourceModifiedDate", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "status" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "status", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "totalAmount" }),
+        __metadata("design:type", Number)
+    ], AccountingAccountTransaction.prototype, "totalAmount", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "transactionId" }),
+        __metadata("design:type", String)
+    ], AccountingAccountTransaction.prototype, "transactionId", void 0);
+    return AccountingAccountTransaction;
+}(utils_1.SpeakeasyBase));
+exports.AccountingAccountTransaction = AccountingAccountTransaction;

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

@@ -0,0 +1,13 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { AccountingAccountTransaction } from "./accountingaccounttransaction";
+import { Links } from "./links";
+/**
+ * Success
+ */
+export declare class AccountingAccountTransactions extends SpeakeasyBase {
+    links: Links;
+    pageNumber: number;
+    pageSize: number;
+    results?: AccountingAccountTransaction[];
+    totalResults: number;
+}

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

@@ -0,0 +1,72 @@
+"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.AccountingAccountTransactions = void 0;
+var utils_1 = require("../../../internal/utils");
+var accountingaccounttransaction_1 = require("./accountingaccounttransaction");
+var links_1 = require("./links");
+var class_transformer_1 = require("class-transformer");
+/**
+ * Success
+ */
+var AccountingAccountTransactions = /** @class */ (function (_super) {
+    __extends(AccountingAccountTransactions, _super);
+    function AccountingAccountTransactions() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "_links" }),
+        (0, class_transformer_1.Type)(function () { return links_1.Links; }),
+        __metadata("design:type", links_1.Links)
+    ], AccountingAccountTransactions.prototype, "links", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "pageNumber" }),
+        __metadata("design:type", Number)
+    ], AccountingAccountTransactions.prototype, "pageNumber", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "pageSize" }),
+        __metadata("design:type", Number)
+    ], AccountingAccountTransactions.prototype, "pageSize", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: accountingaccounttransaction_1.AccountingAccountTransaction }),
+        (0, class_transformer_1.Expose)({ name: "results" }),
+        (0, class_transformer_1.Type)(function () { return accountingaccounttransaction_1.AccountingAccountTransaction; }),
+        __metadata("design:type", Array)
+    ], AccountingAccountTransactions.prototype, "results", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "totalResults" }),
+        __metadata("design:type", Number)
+    ], AccountingAccountTransactions.prototype, "totalResults", void 0);
+    return AccountingAccountTransactions;
+}(utils_1.SpeakeasyBase));
+exports.AccountingAccountTransactions = AccountingAccountTransactions;

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

@@ -0,0 +1,32 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { AccountingAddressType } from "./accountingaddresstype";
+export declare class AccountingAddress extends SpeakeasyBase {
+    /**
+     * City of the customer address.
+     */
+    city?: string;
+    /**
+     * Country of the customer address.
+     */
+    country?: string;
+    /**
+     * Line 1 of the customer address.
+     */
+    line1?: string;
+    /**
+     * Line 2 of the customer address.
+     */
+    line2?: string;
+    /**
+     * Postal code or zip code.
+     */
+    postalCode?: string;
+    /**
+     * Region of the customer address.
+     */
+    region?: string;
+    /**
+     * The type of the address
+     */
+    type: AccountingAddressType;
+}

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

@@ -0,0 +1,76 @@
+"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.AccountingAddress = void 0;
+var utils_1 = require("../../../internal/utils");
+var accountingaddresstype_1 = require("./accountingaddresstype");
+var class_transformer_1 = require("class-transformer");
+var AccountingAddress = /** @class */ (function (_super) {
+    __extends(AccountingAddress, _super);
+    function AccountingAddress() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "city" }),
+        __metadata("design:type", String)
+    ], AccountingAddress.prototype, "city", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "country" }),
+        __metadata("design:type", String)
+    ], AccountingAddress.prototype, "country", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "line1" }),
+        __metadata("design:type", String)
+    ], AccountingAddress.prototype, "line1", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "line2" }),
+        __metadata("design:type", String)
+    ], AccountingAddress.prototype, "line2", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "postalCode" }),
+        __metadata("design:type", String)
+    ], AccountingAddress.prototype, "postalCode", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "region" }),
+        __metadata("design:type", String)
+    ], AccountingAddress.prototype, "region", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "type" }),
+        __metadata("design:type", String)
+    ], AccountingAddress.prototype, "type", void 0);
+    return AccountingAddress;
+}(utils_1.SpeakeasyBase));
+exports.AccountingAddress = AccountingAddress;

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

@@ -0,0 +1,8 @@
+/**
+ * The type of the address
+ */
+export declare enum AccountingAddressType {
+    Unknown = "Unknown",
+    Billing = "Billing",
+    Delivery = "Delivery"
+}

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

@@ -0,0 +1,15 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountingAddressType = void 0;
+/**
+ * The type of the address
+ */
+var AccountingAddressType;
+(function (AccountingAddressType) {
+    AccountingAddressType["Unknown"] = "Unknown";
+    AccountingAddressType["Billing"] = "Billing";
+    AccountingAddressType["Delivery"] = "Delivery";
+})(AccountingAddressType = exports.AccountingAddressType || (exports.AccountingAddressType = {}));

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

@@ -0,0 +1,92 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { AgedCreditor } from "./agedcreditor";
+/**
+ * The Aged Creditors report shows the total balance owed by a business to its suppliers 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 supplier, 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 Creditors report.
+ *
+ * ## Underlying data
+ *
+ * The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment).
+ *
+ * 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 Creditor report runs based on the **issue dates** of the underlying data types rather than the due date.
+ *
+ * ## Accessing the Aged Creditors report in Portal
+ *
+ * Apart from returning the report via the API as JSON and query, you can also return the Aged Creditors 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 Creditors**.
+ * 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 creditors**.
+ * 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 bills or bill credit notes.
+ */
+export declare class AccountingAgedCreditorReport extends SpeakeasyBase {
+    /**
+     * Array of aged creditor.
+     */
+    data?: AgedCreditor[];
+    /**
+     * 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.
+     */
+    generated?: 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.
+     */
+    reportDate?: string;
+}

package/dist/sdk/models/shared/accountingagedcreditorreport.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.AccountingAgedCreditorReport = void 0;
+var utils_1 = require("../../../internal/utils");
+var agedcreditor_1 = require("./agedcreditor");
+var class_transformer_1 = require("class-transformer");
+/**
+ * The Aged Creditors report shows the total balance owed by a business to its suppliers 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 supplier, 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 Creditors report.
+ *
+ * ## Underlying data
+ *
+ * The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier), [Bills](https://docs.codat.io/accounting-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment).
+ *
+ * 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 Creditor report runs based on the **issue dates** of the underlying data types rather than the due date.
+ *
+ * ## Accessing the Aged Creditors report in Portal
+ *
+ * Apart from returning the report via the API as JSON and query, you can also return the Aged Creditors 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 Creditors**.
+ * 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 creditors**.
+ * 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 bills or bill credit notes.
+ */
+var AccountingAgedCreditorReport = /** @class */ (function (_super) {
+    __extends(AccountingAgedCreditorReport, _super);
+    function AccountingAgedCreditorReport() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)({ elemType: agedcreditor_1.AgedCreditor }),
+        (0, class_transformer_1.Expose)({ name: "data" }),
+        (0, class_transformer_1.Type)(function () { return agedcreditor_1.AgedCreditor; }),
+        __metadata("design:type", Array)
+    ], AccountingAgedCreditorReport.prototype, "data", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "generated" }),
+        __metadata("design:type", String)
+    ], AccountingAgedCreditorReport.prototype, "generated", void 0);
+    __decorate([
+        (0, utils_1.SpeakeasyMetadata)(),
+        (0, class_transformer_1.Expose)({ name: "reportDate" }),
+        __metadata("design:type", String)
+    ], AccountingAgedCreditorReport.prototype, "reportDate", void 0);
+    return AccountingAgedCreditorReport;
+}(utils_1.SpeakeasyBase));
+exports.AccountingAgedCreditorReport = AccountingAgedCreditorReport;

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

@@ -0,0 +1,92 @@
+import { SpeakeasyBase } from "../../../internal/utils";
+import { AgedDebtor } from "./ageddebtor";
+/**
+ * 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.
+ */
+export declare class AccountingAgedDebtorReport extends SpeakeasyBase {
+    /**
+     * Array of aged debtors.
+     */
+    data?: AgedDebtor[];
+    /**
+     * 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.
+     */
+    generated?: 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.
+     */
+    reportDate?: string;
+}