@codat/lending 3.2.0 → 3.3.0

package/dist/sdk/models/operations/getaccountingaccount.d.ts

@@ -3,9 +3,12 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingAccountRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an account
+     * Unique identifier for an account.
      */
     accountId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
 }
 export declare class GetAccountingAccountResponse extends SpeakeasyBase {
@@ -13,11 +16,20 @@ export declare class GetAccountingAccountResponse extends SpeakeasyBase {
      * Success
      */
     accountingAccount?: shared.AccountingAccount;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingaccounttransaction.d.ts

@@ -2,8 +2,17 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingAccountTransactionRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for an account transaction.
+     */
     accountTransactionId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
 }
 export declare class GetAccountingAccountTransactionResponse extends SpeakeasyBase {
@@ -11,11 +20,20 @@ export declare class GetAccountingAccountTransactionResponse extends SpeakeasyBa
      * Success
      */
     accountingAccountTransaction?: shared.AccountingAccountTransaction;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingagedcreditorsreport.d.ts

@@ -3,6 +3,9 @@ import { RFCDate } from "../../types";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingAgedCreditorsReportRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * Number of periods to include in the report.
@@ -22,11 +25,20 @@ export declare class GetAccountingAgedCreditorsReportResponse extends SpeakeasyB
      * OK
      */
     accountingAgedCreditorReport?: shared.AccountingAgedCreditorReport;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingageddebtorsreport.d.ts

@@ -3,6 +3,9 @@ import { RFCDate } from "../../types";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingAgedDebtorsReportRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * Number of periods to include in the report.
@@ -22,11 +25,20 @@ export declare class GetAccountingAgedDebtorsReportResponse extends SpeakeasyBas
      * OK
      */
     accountingAgedDebtorReport?: shared.AccountingAgedDebtorReport;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingbalancesheet.d.ts

@@ -2,6 +2,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingBalanceSheetRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * Number of months defining the period of interest.
@@ -11,6 +14,9 @@ export declare class GetAccountingBalanceSheetRequest extends SpeakeasyBase {
      * Number of periods with `periodLength` to compare.
      */
     periodsToCompare: number;
+    /**
+     * The month the report starts from.
+     */
     startMonth?: string;
 }
 export declare class GetAccountingBalanceSheetResponse extends SpeakeasyBase {
@@ -18,11 +24,20 @@ export declare class GetAccountingBalanceSheetResponse extends SpeakeasyBase {
      * Success
      */
     accountingBalanceSheet?: shared.AccountingBalanceSheet;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingbankaccount.d.ts

@@ -3,10 +3,16 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingBankAccountRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an account
+     * Unique identifier for an account.
      */
     accountId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
 }
 export declare class GetAccountingBankAccountResponse extends SpeakeasyBase {
@@ -14,11 +20,20 @@ export declare class GetAccountingBankAccountResponse extends SpeakeasyBase {
      * Success
      */
     accountingBankAccount?: shared.AccountingBankAccount;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingbill.d.ts

@@ -3,9 +3,12 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingBillRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for a bill
+     * Unique identifier for a bill.
      */
     billId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
 }
 export declare class GetAccountingBillResponse extends SpeakeasyBase {
@@ -13,11 +16,20 @@ export declare class GetAccountingBillResponse extends SpeakeasyBase {
      * Success
      */
     accountingBill?: shared.AccountingBill;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingbillattachment.d.ts

@@ -3,14 +3,20 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingBillAttachmentRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an attachment
+     * Unique identifier for an attachment.
      */
     attachmentId: string;
     /**
-     * Unique identifier for a bill
+     * Unique identifier for a bill.
      */
     billId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
 }
 export declare class GetAccountingBillAttachmentResponse extends SpeakeasyBase {
@@ -18,11 +24,20 @@ export declare class GetAccountingBillAttachmentResponse extends SpeakeasyBase {
      * Success
      */
     accountingAttachment?: shared.AccountingAttachment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingbillcreditnote.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingBillCreditNoteRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a bill credit note.
+     */
     billCreditNoteId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
 }
 export declare class GetAccountingBillCreditNoteResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetAccountingBillCreditNoteResponse extends SpeakeasyBase {
      * Success
      */
     accountingBillCreditNote?: shared.AccountingBillCreditNote;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingbillpayment.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingBillPaymentRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a bill payment.
+     */
     billPaymentId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
 }
 export declare class GetAccountingBillPaymentResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetAccountingBillPaymentResponse extends SpeakeasyBase {
      * Success
      */
     accountingBillPayment?: shared.AccountingBillPayment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingcashflowstatement.d.ts

@@ -2,6 +2,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingCashFlowStatementRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
     /**
      * Number of months defining the period of interest.
@@ -11,6 +14,9 @@ export declare class GetAccountingCashFlowStatementRequest extends SpeakeasyBase
      * Number of periods with `periodLength` to compare.
      */
     periodsToCompare: number;
+    /**
+     * The month the report starts from.
+     */
     startMonth?: string;
 }
 export declare class GetAccountingCashFlowStatementResponse extends SpeakeasyBase {
@@ -18,11 +24,20 @@ export declare class GetAccountingCashFlowStatementResponse extends SpeakeasyBas
      * Success
      */
     accountingCashFlowStatement?: shared.AccountingCashFlowStatement;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingcreditnote.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingCreditNoteRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a credit note.
+     */
     creditNoteId: string;
 }
 export declare class GetAccountingCreditNoteResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetAccountingCreditNoteResponse extends SpeakeasyBase {
      * Success
      */
     accountingCreditNote?: shared.AccountingCreditNote;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingcustomer.d.ts

@@ -2,7 +2,13 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingCustomerRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a customer.
+     */
     customerId: string;
 }
 export declare class GetAccountingCustomerResponse extends SpeakeasyBase {
@@ -10,11 +16,20 @@ export declare class GetAccountingCustomerResponse extends SpeakeasyBase {
      * Success
      */
     accountingCustomer?: shared.AccountingCustomer;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingcustomerattachment.d.ts

@@ -3,11 +3,20 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingCustomerAttachmentRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an attachment
+     * Unique identifier for an attachment.
      */
     attachmentId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
+    /**
+     * Unique identifier for a customer.
+     */
     customerId: string;
 }
 export declare class GetAccountingCustomerAttachmentResponse extends SpeakeasyBase {
@@ -15,11 +24,20 @@ export declare class GetAccountingCustomerAttachmentResponse extends SpeakeasyBa
      * Success
      */
     accountingAttachment?: shared.AccountingAttachment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingdirectcost.d.ts

@@ -2,10 +2,16 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingDirectCostRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
-     * Unique identifier for a direct cost
+     * Unique identifier for a direct cost.
      */
     directCostId: string;
 }
@@ -14,11 +20,20 @@ export declare class GetAccountingDirectCostResponse extends SpeakeasyBase {
      * Success
      */
     accountingDirectCost?: shared.AccountingDirectCost;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingdirectcostattachment.d.ts

@@ -3,13 +3,19 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingDirectCostAttachmentRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an attachment
+     * Unique identifier for an attachment.
      */
     attachmentId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
-     * Unique identifier for a direct cost
+     * Unique identifier for a direct cost.
      */
     directCostId: string;
 }
@@ -18,11 +24,20 @@ export declare class GetAccountingDirectCostAttachmentResponse extends Speakeasy
      * Success
      */
     accountingAttachment?: shared.AccountingAttachment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingdirectincome.d.ts

@@ -2,8 +2,17 @@ import { SpeakeasyBase } from "../../../internal/utils";
 import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingDirectIncomeRequest extends SpeakeasyBase {
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
+    /**
+     * Unique identifier for a direct income.
+     */
     directIncomeId: string;
 }
 export declare class GetAccountingDirectIncomeResponse extends SpeakeasyBase {
@@ -11,11 +20,20 @@ export declare class GetAccountingDirectIncomeResponse extends SpeakeasyBase {
      * Success
      */
     accountingDirectIncome?: shared.AccountingDirectIncome;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }

package/dist/sdk/models/operations/getaccountingdirectincomeattachment.d.ts

@@ -3,15 +3,24 @@ import * as shared from "../shared";
 import { AxiosResponse } from "axios";
 export declare class GetAccountingDirectIncomeAttachmentRequest extends SpeakeasyBase {
     /**
-     * Unique identifier for an attachment
+     * Unique identifier for an attachment.
      */
     attachmentId: string;
+    /**
+     * Unique identifier for a company.
+     */
     companyId: string;
+    /**
+     * Unique identifier for a connection.
+     */
     connectionId: string;
     /**
-     * Unique identifier for a direct income
+     * Unique identifier for a direct income.
      */
     directIncomeId: string;
+    /**
+     * Time limit for the push operation to complete before it is timed out.
+     */
     timeoutInMinutes?: number;
 }
 export declare class GetAccountingDirectIncomeAttachmentResponse extends SpeakeasyBase {
@@ -19,11 +28,20 @@ export declare class GetAccountingDirectIncomeAttachmentResponse extends Speakea
      * Success
      */
     accountingAttachment?: shared.AccountingAttachment;
+    /**
+     * HTTP response content type for this operation
+     */
     contentType: string;
     /**
      * Your API request was not properly authorized.
      */
     errorMessage?: shared.ErrorMessage;
+    /**
+     * HTTP response status code for this operation
+     */
     statusCode: number;
+    /**
+     * Raw HTTP response; suitable for custom response parsing
+     */
     rawResponse?: AxiosResponse;
 }