diff --git a/docs/classes/index.Client.html b/docs/classes/index.Client.html index 90d03ea03..ba7c13adb 100644 --- a/docs/classes/index.Client.html +++ b/docs/classes/index.Client.html @@ -24,7 +24,7 @@

Hierarchy

+
  • Defined in packages/api/src/APIClient.ts:127
    • @@ -104,7 +104,7 @@
    logger: LoggerReturns Client
    +
  • Defined in packages/api/src/APIClient.ts:171

    • Properties

    @@ -113,31 +113,31 @@

    Optional

    Pre-authorized access token for accessing FreshBooks API

    +
  • Defined in packages/api/src/APIClient.ts:140

    • Optional accessTokenExpiresAt

    accessTokenExpiresAt?: Date

    Expiration date of access token

    +
  • Defined in packages/api/src/APIClient.ts:150

    • Readonly apiUrl

    apiUrl: string

    Base URL for FreshBooks API

    +
  • Defined in packages/api/src/APIClient.ts:131

    • Private Readonly authorizationUrl

    authorizationUrl: string
    +
  • Defined in packages/api/src/APIClient.ts:155

    • Private Readonly axios

    axios: AxiosInstance
    +
  • Defined in packages/api/src/APIClient.ts:152

    • Readonly billPayments

    billPayments: {
        create: ((billPayment: BillPayments, accountId: string) => Promise<Result<BillPayments>>);
        delete: ((accountId: string, billPaymentId: number) => Promise<Result<BillPayments>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            billPayments: BillPayments[];
        }>>);
        single: ((accountId: string, billPaymentId: number) => Promise<Result<{
            billPayment: BillPayments;
        }>>);
        update: ((billPayment: BillPayments, accountId: string, billPaymentId: number) => Promise<Result<BillPayments>>);
    } = ...
    @@ -222,7 +222,7 @@
    accountId: string
    billPaymentId: number

    Returns Promise<Result<BillPayments>>

    +
  • Defined in packages/api/src/APIClient.ts:391

    • Readonly billVendors

    billVendors: {
        create: ((vendor: BillVendors, accountId: string) => Promise<Result<BillVendors>>);
        delete: ((accountId: string, vendorId: number) => Promise<Result<BillVendors>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            pages: Pagination;
            vendors: BillVendors[];
        }>>);
        single: ((accountId: string, vendorId: number) => Promise<Result<BillVendors>>);
        update: ((vendor: BillVendors, accountId: string, vendorId: number) => Promise<Result<BillVendors>>);
    } = ...
    @@ -307,7 +307,7 @@
    accountId: string
    vendorId: number

    Returns Promise<Result<BillVendors>>

    +
  • Defined in packages/api/src/APIClient.ts:443

    • Readonly bills

    bills: {
        archive: ((accountId: string, billId: number) => Promise<Result<Bills>>);
        create: ((bill: Bills, accountId: string) => Promise<Result<Bills>>);
        delete: ((accountId: string, billId: number) => Promise<Result<Bills>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            bills: Bills[];
        }>>);
        single: ((accountId: string, billId: number) => Promise<Result<{
            bill: Bills;
        }>>);
    } = ...
    @@ -390,7 +390,7 @@
    accountId: string
    billId: number

    Returns Promise<Result<{
        bill: Bills;
    }>>

    +
  • Defined in packages/api/src/APIClient.ts:339

    • Readonly callbacks

    callbacks: {
        create: ((callback: Callback, accountId: string) => Promise<Result<Callback>>);
        delete: ((accountId: string, callbackId: string) => Promise<Result<Callback>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            callbacks: Callback[];
            pages: Pagination;
        }>>);
        resendVerification: ((accountId: string, callbackId: string) => Promise<Result<Callback>>);
        single: ((accountId: string, callbackId: string) => Promise<Result<Callback>>);
        update: ((callback: Callback, accountId: string, callbackId: string) => Promise<Result<Callback>>);
        verify: ((accountId: string, callbackId: string, verifier: string) => Promise<Result<Callback>>);
    } = ...
    @@ -507,17 +507,17 @@
    callbackId: string
    verifier: string

    Returns Promise<Result<Callback>>

    +
  • Defined in packages/api/src/APIClient.ts:504

    • Readonly clientId

    clientId: string
    +
  • Defined in packages/api/src/APIClient.ts:133

    • Optional Readonly clientSecret

    clientSecret?: string
    +
  • Defined in packages/api/src/APIClient.ts:134

    • Readonly clients

    clients: {
        create: ((client: Client, accountId: string) => Promise<Result<Client>>);
        delete: ((accountId: string, clientId: string) => Promise<Result<Client>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            clients: Client[];
            pages: Pagination;
        }>>);
        single: ((accountId: string, clientId: string) => Promise<Result<Client>>);
        update: ((client: Client, accountId: string, clientId: string) => Promise<Result<Client>>);
    } = ...
    @@ -602,7 +602,7 @@
    accountId: string
    clientId: string

    Returns Promise<Result<Client>>

    +
  • Defined in packages/api/src/APIClient.ts:576

    • Readonly creditNotes

    creditNotes: {
        create: ((creditNote: CreditNote, accountId: string) => Promise<Result<CreditNote>>);
        delete: ((accountId: string, creditId: string) => Promise<Result<CreditNote>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            creditNotes: CreditNote[];
            pages: Pagination;
        }>>);
        single: ((accountId: string, creditId: string) => Promise<Result<CreditNote>>);
        update: ((creditNote: CreditNote, accountId: string, creditId: string) => Promise<Result<CreditNote>>);
    } = ...
    @@ -687,7 +687,7 @@
    accountId: string
    creditId: string

    Returns Promise<Result<CreditNote>>

    +
  • Defined in packages/api/src/APIClient.ts:637

    • Readonly expenseCategories

    expenseCategories: {
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            categories: ExpenseCategory[];
            pages: Pagination;
        }>>);
        single: ((accountId: string, expenseCategoryId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<ExpenseCategory>>);
    } = ...
    @@ -727,7 +727,7 @@
    expenseCategoryId: string
    Optional queryBuilders: QueryBuilderType[]

    Returns Promise<Result<ExpenseCategory>>

    +
  • Defined in packages/api/src/APIClient.ts:761

    • Readonly expenses

    expenses: {
        create: ((expense: Expense, accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<Expense>>);
        delete: ((accountId: string, expenseId: string) => Promise<Result<Expense>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            expenses: Expense[];
            pages: Pagination;
        }>>);
        single: ((accountId: string, expenseId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<Expense>>);
        update: ((expense: Expense, accountId: string, expenseId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<Expense>>);
    } = ...
    @@ -818,7 +818,7 @@
    expenseId: string
    Optional queryBuilders: QueryBuilderType[]

    Returns Promise<Result<Expense>>

    +
  • Defined in packages/api/src/APIClient.ts:698

    • Readonly invoices

    invoices: {
        create: ((invoice: Invoice, accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<Invoice>>);
        delete: ((accountId: string, invoiceId: string) => Promise<Result<Invoice>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            invoices: Invoice[];
            pages: Pagination;
        }>>);
        shareLink: ((accountId: string, invoiceId: string) => Promise<Result<Invoice>>);
        single: ((accountId: string, invoiceId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<Invoice>>);
        update: ((accountId: string, invoiceId: string, data: any, queryBuilders?: QueryBuilderType[]) => Promise<Result<Invoice>>);
    } = ...
    @@ -924,7 +924,7 @@
    data: any
    Optional queryBuilders: QueryBuilderType[]

    Returns Promise<Result<Invoice>>

    +
  • Defined in packages/api/src/APIClient.ts:791

    • Readonly items

    items: {
        create: ((accountId: string, data: any) => Promise<Result<Item>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            items: Item[];
            pages: Pagination;
        }>>);
        single: ((accountId: string, itemId: string) => Promise<Result<Item>>);
        update: ((accountId: string, itemId: string, data: any) => Promise<Result<Item>>);
    } = ...
    @@ -994,7 +994,7 @@
    itemId: string
    data: any

    Returns Promise<Result<Item>>

    +
  • Defined in packages/api/src/APIClient.ts:864

    • Readonly journalEntries

    journalEntries: {
        create: ((journalEntry: JournalEntry, accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<JournalEntry>>);
    } = ...
    @@ -1019,7 +1019,7 @@
    accountId: string
    Optional queryBuilders: QueryBuilderType[]

    Returns Promise<Result<JournalEntry>>

    +
  • Defined in packages/api/src/APIClient.ts:912

    • Readonly journalEntryAccounts

    journalEntryAccounts: {
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            journalEntryAccounts: JournalEntryAccount[];
            pages: Pagination;
        }>>);
    } = ...
    @@ -1042,7 +1042,7 @@
    accountId: string
    Optional queryBuilders: QueryBuilderType[]

    Returns Promise<Result<{
        journalEntryAccounts: JournalEntryAccount[];
        pages: Pagination;
    }>>

    +
  • Defined in packages/api/src/APIClient.ts:930

    • Readonly journalEntryDetails

    journalEntryDetails: {
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            journalEntryAccounts: JournalEntryDetail[];
            pages: Pagination;
        }>>);
    } = ...
    @@ -1065,12 +1065,12 @@
    accountId: string
    Optional queryBuilders: QueryBuilderType[]

    Returns Promise<Result<{
        journalEntryAccounts: JournalEntryDetail[];
        pages: Pagination;
    }>>

    +
  • Defined in packages/api/src/APIClient.ts:946

    • Private Readonly logger

    logger: Logger
    +
  • Defined in packages/api/src/APIClient.ts:153

    • Readonly otherIncomes

    otherIncomes: {
        create: ((otherIncome: OtherIncome, accountId: string) => Promise<Result<OtherIncome>>);
        delete: ((accountId: string, otherIncomeId: string) => Promise<Result<OtherIncome>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            otherIncomes: OtherIncome[];
            pages: Pagination;
        }>>);
        single: ((accountId: string, otherIncomeId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<OtherIncome>>);
        update: ((accountId: string, otherIncomeId: string, data: any) => Promise<Result<OtherIncome>>);
    } = ...
    @@ -1157,7 +1157,7 @@
    otherIncomeId: string
    data: any

    Returns Promise<Result<OtherIncome>>

    +
  • Defined in packages/api/src/APIClient.ts:962

    • Readonly paymentOptions

    paymentOptions: {
        create: ((accountId: string, invoiceId: string, data: any) => Promise<Result<PaymentOptions>>);
        default: ((accountId: string) => Promise<Result<PaymentOptions>>);
        single: ((accountId: string, invoiceId: string) => Promise<Result<PaymentOptions>>);
    } = ...
    @@ -1210,7 +1210,7 @@
    accountId: string
    invoiceId: string

    Returns Promise<Result<PaymentOptions>>

    +
  • Defined in packages/api/src/APIClient.ts:1085

    • Readonly payments

    payments: {
        create: ((accountId: string, data: any) => Promise<Result<Payment>>);
        delete: ((accountId: string, paymentId: string) => Promise<Result<Payment>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            pages: Pagination;
            payments: Payment[];
        }>>);
        single: ((accountId: string, paymentId: string) => Promise<Result<Payment>>);
        update: ((accountId: string, paymentId: string, data: any) => Promise<Result<Payment>>);
    } = ...
    @@ -1295,7 +1295,7 @@
    paymentId: string
    data: any

    Returns Promise<Result<Payment>>

    +
  • Defined in packages/api/src/APIClient.ts:1023

    • Readonly projects

    projects: {
        create: ((project: Project, businessId: number) => Promise<Result<Project>>);
        delete: ((businessId: number, projectId: number) => Promise<Result<Project>>);
        list: ((businessId: number, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            pages: Pagination;
            projects: Project[];
        }>>);
        single: ((businessId: number, projectId: number) => Promise<Result<Project>>);
        update: ((project: Project, businessId: number, projectId: number) => Promise<Result<Project>>);
    } = ...
    @@ -1380,19 +1380,19 @@
    businessId: number
    projectId: number

    Returns Promise<Result<Project>>

    +
  • Defined in packages/api/src/APIClient.ts:1119

    • Optional Readonly redirectUri

    redirectUri?: string
    +
  • Defined in packages/api/src/APIClient.ts:135

    • Optional refreshToken

    refreshToken?: string

    Pre-authorized token for renewing access token

    +
  • Defined in packages/api/src/APIClient.ts:145

    • Readonly reports

    reports: {
        paymentsCollected: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            callbacks: Callback[];
            pages: Pagination;
        }>>);
        profitLoss: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            callbacks: Callback[];
            pages: Pagination;
        }>>);
        taxSummary: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            callbacks: Callback[];
            pages: Pagination;
        }>>);
    } = ...
    @@ -1445,7 +1445,7 @@
    accountId: string
    Optional queryBuilders: QueryBuilderType[]

    Returns Promise<Result<{
        callbacks: Callback[];
        pages: Pagination;
    }>>

    +
  • Defined in packages/api/src/APIClient.ts:1169

    • Readonly services

    services: {
        create: ((service: Service, businessId: number) => Promise<Result<Service>>);
        list: ((businessId: number) => Promise<Result<{
            pages: Pagination;
            timeEntries: Service[];
        }>>);
        rate: {
            create: ((service: ServiceRate, businessId: number, serviceId: number) => Promise<Result<ServiceRate>>);
            single: ((businessId: number, serviceId: number) => Promise<Result<ServiceRate>>);
            update: ((service: ServiceRate, businessId: number, serviceId: number) => Promise<Result<ServiceRate>>);
        };
        single: ((businessId: number, serviceId: number) => Promise<Result<Service>>);
    } = ...
    @@ -1548,7 +1548,7 @@
    businessId: number
    serviceId: number

    Returns Promise<Result<Service>>

    +
  • Defined in packages/api/src/APIClient.ts:1220

    • Readonly tasks

    tasks: {
        create: ((task: Tasks, accountId: string) => Promise<Result<Tasks>>);
        delete: ((accountId: string, taskId: number) => Promise<Result<Tasks>>);
        list: ((accountId: string, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            pages: Pagination;
            tasks: Tasks[];
        }>>);
        single: ((accountId: string, taskId: number) => Promise<Result<Tasks>>);
        update: ((task: Tasks, accountId: string, taskId: number) => Promise<Result<Tasks>>);
    } = ...
    @@ -1633,7 +1633,7 @@
    accountId: string
    taskId: number

    Returns Promise<Result<Tasks>>

    +
  • Defined in packages/api/src/APIClient.ts:1289

    • Readonly timeEntries

    timeEntries: {
        create: ((timeEntry: TimeEntry, businessId: number) => Promise<Result<TimeEntry>>);
        delete: ((businessId: number, timeEntryId: number) => Promise<Result<TimeEntry>>);
        list: ((businessId: number, queryBuilders?: QueryBuilderType[]) => Promise<Result<{
            pages: Pagination;
            timeEntries: TimeEntry[];
        }>>);
        single: ((businessId: number, timeEntryId: number) => Promise<Result<TimeEntry>>);
        update: ((timeEntry: TimeEntry, businessId: number, timeEntryId: number) => Promise<Result<TimeEntry>>);
    } = ...
    @@ -1718,7 +1718,7 @@
    businessId: number
    timeEntryId: number

    Returns Promise<Result<TimeEntry>>

    +
  • Defined in packages/api/src/APIClient.ts:1350

    • Readonly users

    users: {
        me: (() => Promise<Result<User>>);
    } = ...
    @@ -1734,7 +1734,7 @@
    me:

    Returns Promise<Result<User>>

    +
  • Defined in packages/api/src/APIClient.ts:1406

    • Methods

    @@ -1753,7 +1753,7 @@
    codeType: "code"code: string

    Returns Promise<undefined | {
        accessToken: string;
        accessTokenExpiresAt: Date;
        refreshToken: string;
    }>

    +
  • Defined in packages/api/src/APIClient.ts:238

    • Private call

    Returns Promise<Result<T>>

    +
  • Defined in packages/api/src/APIClient.ts:298

    • getAccessToken

    Returns Promise<undefined | {
        accessToken: string;
        accessTokenExpiresAt: Date;
        refreshToken: string;
    }>

    +
  • Defined in packages/api/src/APIClient.ts:286

    • getAuthRequestUrl

    Returns string

    +
  • Defined in packages/api/src/APIClient.ts:217

    • refreshAccessToken

    Returns Promise<undefined | {
        accessToken: string;
        accessTokenExpiresAt: Date;
        refreshToken: string;
    }>

    +
  • Defined in packages/api/src/APIClient.ts:290

    • Static isNetworkRateLimitOrIdempotentRequestError

    Returns boolean

    +
  • Defined in packages/api/src/APIClient.ts:157
    • diff --git a/docs/classes/models.Error.html b/docs/classes/models.Error.html index 35e9224ea..2841ade72 100644 --- a/docs/classes/models.Error.html +++ b/docs/classes/models.Error.html @@ -23,7 +23,7 @@

    Hierarchy

    • Error
    +
  • Defined in packages/api/src/models/Error.ts:13
    • @@ -68,26 +68,26 @@
    Optional errors: Returns Error
    +
  • Defined in packages/api/src/models/Error.ts:22

    • Properties

    Optional errors

    errors?: APIError[]
    +
  • Defined in packages/api/src/models/Error.ts:20

    • message

    message: string
    +
  • Defined in packages/api/src/models/Error.ts:16

    • name

    name: string
    +
  • Defined in packages/api/src/models/Error.ts:14

    • Optional stack

    stack?: string
    +
  • Defined in packages/api/src/models/Error.ts:18

    • Static Optional prepareStackTrace

    prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)
    diff --git a/docs/classes/models_builders.IncludesQueryBuilder.html b/docs/classes/models_builders.IncludesQueryBuilder.html index 70e91db6e..19bb09f35 100644 --- a/docs/classes/models_builders.IncludesQueryBuilder.html +++ b/docs/classes/models_builders.IncludesQueryBuilder.html @@ -25,7 +25,7 @@

    Hierarchy

    • IncludesQueryBuilder
    +
  • Defined in packages/api/src/models/builders/IncludesQueryBuilder.ts:10
    • @@ -53,14 +53,14 @@

    constructor

    Returns IncludesQueryBuilder

    +
  • Defined in packages/api/src/models/builders/IncludesQueryBuilder.ts:13

    • Properties

    queryParams

    queryParams: QueryParamType
    +
  • Defined in packages/api/src/models/builders/IncludesQueryBuilder.ts:11

    • Methods

    @@ -75,7 +75,7 @@

    Parameters

    Optional resourceType: string

    Returns string

    +
  • Defined in packages/api/src/models/builders/IncludesQueryBuilder.ts:27

    • includes

    Returns IncludesQueryBuilder

    +
  • Defined in packages/api/src/models/builders/IncludesQueryBuilder.ts:19
    • diff --git a/docs/classes/models_builders.PaginationQueryBuilder.html b/docs/classes/models_builders.PaginationQueryBuilder.html index 40ba1a667..b94725ae0 100644 --- a/docs/classes/models_builders.PaginationQueryBuilder.html +++ b/docs/classes/models_builders.PaginationQueryBuilder.html @@ -25,7 +25,7 @@

    Hierarchy

    • PaginationQueryBuilder
    +
  • Defined in packages/api/src/models/builders/PaginationQueryBuilder.ts:10
    • @@ -54,14 +54,14 @@

    constructor

    Returns PaginationQueryBuilder

    +
  • Defined in packages/api/src/models/builders/PaginationQueryBuilder.ts:13

    • Properties

    queryParams

    queryParams: QueryParamType
    +
  • Defined in packages/api/src/models/builders/PaginationQueryBuilder.ts:11

    • Methods

    @@ -76,7 +76,7 @@

    Parameters

    Optional resourceType: string

    Returns string

    +
  • Defined in packages/api/src/models/builders/PaginationQueryBuilder.ts:33

    • page

    Returns PaginationQueryBuilder

    +
  • Defined in packages/api/src/models/builders/PaginationQueryBuilder.ts:17

    • perPage

    Returns PaginationQueryBuilder

    +
  • Defined in packages/api/src/models/builders/PaginationQueryBuilder.ts:25
    • diff --git a/docs/classes/models_builders.SearchQueryBuilder.html b/docs/classes/models_builders.SearchQueryBuilder.html index 79b3fdd22..f853169bb 100644 --- a/docs/classes/models_builders.SearchQueryBuilder.html +++ b/docs/classes/models_builders.SearchQueryBuilder.html @@ -25,7 +25,7 @@

    Hierarchy

    • SearchQueryBuilder
    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:25
    • @@ -58,14 +58,14 @@

    constructor

    Returns SearchQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:28

    • Properties

    queryParams

    queryParams: QueryParam[]
    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:26

    • Methods

    @@ -82,7 +82,7 @@
    key: string
    __namedParameters: RangeType

    Returns SearchQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:54

    • boolean

    Returns SearchQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:66

    • build

    Returns string

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:71

    • equals

    Returns SearchQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:44

    • in

    Returns SearchQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:39

    • like

    Returns SearchQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:49

    • Static Private handleDate

    Returns string

    +
  • Defined in packages/api/src/models/builders/SearchQueryBuilder.ts:32
    • diff --git a/docs/classes/models_builders.SortQueryBuilder.html b/docs/classes/models_builders.SortQueryBuilder.html index d3bd0fc23..64002c390 100644 --- a/docs/classes/models_builders.SortQueryBuilder.html +++ b/docs/classes/models_builders.SortQueryBuilder.html @@ -25,7 +25,7 @@

    Hierarchy

    • SortQueryBuilder
    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:15
    • @@ -56,14 +56,14 @@

    constructor

    Returns SortQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:18

    • Properties

    queryParam

    queryParam: SortQueryParam
    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:16

    • Methods

    @@ -78,7 +78,7 @@

    Parameters

    key: string

    Returns SortQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:22

    • ascending

    Returns SortQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:27

    • build

    Returns string

    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:40

    • desc

    Returns SortQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:31

    • descending

    Returns SortQueryBuilder

    +
  • Defined in packages/api/src/models/builders/SortQueryBuilder.ts:36
    • diff --git a/docs/enums/models.VisState.html b/docs/enums/models.VisState.html index 3e4263578..7c3fc4d8d 100644 --- a/docs/enums/models.VisState.html +++ b/docs/enums/models.VisState.html @@ -17,7 +17,7 @@
  • VisState

    • Enumeration VisState

    +
  • Defined in packages/api/src/models/VisState.ts:1
    • @@ -34,12 +34,12 @@

    Enumeration Members

    active

    active: 0
    +
  • Defined in packages/api/src/models/VisState.ts:2

    • deleted

    deleted: 1
    +
  • Defined in packages/api/src/models/VisState.ts:3
    • diff --git a/docs/functions/models_builders.joinQueries.html b/docs/functions/models_builders.joinQueries.html index 6b708a8dc..c1350e60c 100644 --- a/docs/functions/models_builders.joinQueries.html +++ b/docs/functions/models_builders.joinQueries.html @@ -29,7 +29,7 @@
    Optional queryBuilders: Optional resourceType: string

    Returns string

    +
  • Defined in packages/api/src/models/builders/index.ts:13
    • diff --git a/docs/interfaces/index.Options.html b/docs/interfaces/index.Options.html index a6daf1487..4bddb061d 100644 --- a/docs/interfaces/index.Options.html +++ b/docs/interfaces/index.Options.html @@ -21,7 +21,7 @@

    Hierarchy

    • Options
    +
  • Defined in packages/api/src/APIClient.ts:108
    • @@ -43,37 +43,37 @@

    Properties

    Optional accessToken

    accessToken?: string
    +
  • Defined in packages/api/src/APIClient.ts:111

    • Optional apiUrl

    apiUrl?: string
    +
  • Defined in packages/api/src/APIClient.ts:113

    • Optional clientSecret

    clientSecret?: string
    +
  • Defined in packages/api/src/APIClient.ts:109

    • Optional redirectUri

    redirectUri?: string
    +
  • Defined in packages/api/src/APIClient.ts:110

    • Optional refreshToken

    refreshToken?: string
    +
  • Defined in packages/api/src/APIClient.ts:112

    • Optional retryOptions

    retryOptions?: IAxiosRetryConfig
    +
  • Defined in packages/api/src/APIClient.ts:114

    • Optional userAgent

    userAgent?: string
    +
  • Defined in packages/api/src/APIClient.ts:115
    • diff --git a/docs/interfaces/index.User.html b/docs/interfaces/index.User.html index 5451e52a3..4495024ee 100644 --- a/docs/interfaces/index.User.html +++ b/docs/interfaces/index.User.html @@ -21,7 +21,7 @@

    Hierarchy

    • User
    +
  • Defined in packages/api/src/models/User.ts:12
    • @@ -49,67 +49,67 @@

    Properties

    Optional addresses

    addresses?: Nullable<default[]>
    +
  • Defined in packages/api/src/models/User.ts:18

    • Optional businessMemberships

    businessMemberships?: Nullable<default[]>
    +
  • Defined in packages/api/src/models/User.ts:21

    • email

    email: string
    +
  • Defined in packages/api/src/models/User.ts:16

    • firstName

    firstName: string
    +
  • Defined in packages/api/src/models/User.ts:14

    • Optional groups

    groups?: Nullable<default[]>
    +
  • Defined in packages/api/src/models/User.ts:24

    • id

    id: number
    +
  • Defined in packages/api/src/models/User.ts:13

    • lastName

    lastName: string
    +
  • Defined in packages/api/src/models/User.ts:15

    • Optional links

    links?: Nullable<Map<string, string>>
    +
  • Defined in packages/api/src/models/User.ts:25

    • permissions

    permissions: Map<string, Map<string, default>>
    +
  • Defined in packages/api/src/models/User.ts:19

    • Optional phoneNumbers

    phoneNumbers?: Nullable<default[]>
    +
  • Defined in packages/api/src/models/User.ts:17

    • Optional profession

    profession?: Nullable<default>
    +
  • Defined in packages/api/src/models/User.ts:23

    • Optional roles

    roles?: Nullable<default[]>
    +
  • Defined in packages/api/src/models/User.ts:22

    • subscriptionStatuses

    subscriptionStatuses: Map<string, string>
    +
  • Defined in packages/api/src/models/User.ts:20
    • diff --git a/docs/interfaces/models.BillPayments.html b/docs/interfaces/models.BillPayments.html index 78ef7587e..6a814e257 100644 --- a/docs/interfaces/models.BillPayments.html +++ b/docs/interfaces/models.BillPayments.html @@ -21,7 +21,7 @@

    Hierarchy

    • BillPayments
    +
  • Defined in packages/api/src/models/BillPayments.ts:27
    • @@ -43,37 +43,37 @@

    Properties

    amount

    amount: default
    +
  • Defined in packages/api/src/models/BillPayments.ts:29

    • billId

    billId: number
    +
  • Defined in packages/api/src/models/BillPayments.ts:30

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/BillPayments.ts:28

    • Optional note

    note?: string
    +
  • Defined in packages/api/src/models/BillPayments.ts:33

    • Optional paidDate

    paidDate?: Date
    +
  • Defined in packages/api/src/models/BillPayments.ts:31

    • Optional paymentType

    paymentType?: PaymentType
    +
  • Defined in packages/api/src/models/BillPayments.ts:32

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/BillPayments.ts:34
    • diff --git a/docs/interfaces/models.BillVendors.html b/docs/interfaces/models.BillVendors.html index 08974ce62..a5033f2ea 100644 --- a/docs/interfaces/models.BillVendors.html +++ b/docs/interfaces/models.BillVendors.html @@ -21,7 +21,7 @@

    Hierarchy

    • BillVendors
    +
  • Defined in packages/api/src/models/BillVendors.ts:12
    • @@ -60,122 +60,122 @@

    Properties

    Optional accountNumber

    accountNumber?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:13

    • Optional city

    city?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:14

    • Optional country

    country?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:15

    • Optional createdAt

    createdAt?: Date
    +
  • Defined in packages/api/src/models/BillVendors.ts:35

    • Optional currencyCode

    currencyCode?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:16

    • Optional is1099

    is1099?: boolean
    +
  • Defined in packages/api/src/models/BillVendors.ts:17

    • Optional language

    language?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:18

    • Optional note

    note?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:19

    • Optional outstandingBalance

    outstandingBalance?: MoneyResponse[]
    +
  • Defined in packages/api/src/models/BillVendors.ts:20

    • Optional overdueBalance

    overdueBalance?: MoneyResponse[]
    +
  • Defined in packages/api/src/models/BillVendors.ts:21

    • Optional phone

    phone?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:22

    • Optional postalCode

    postalCode?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:23

    • Optional primaryContactEmail

    primaryContactEmail?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:24

    • Optional primaryContactFirstName

    primaryContactFirstName?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:25

    • Optional primaryContactLastName

    primaryContactLastName?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:26

    • Optional province

    province?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:27

    • Optional street

    street?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:28

    • Optional street2

    street2?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:29

    • Optional taxDefaults

    taxDefaults?: default[]
    +
  • Defined in packages/api/src/models/BillVendors.ts:30

    • Optional updatedAt

    updatedAt?: Date
    +
  • Defined in packages/api/src/models/BillVendors.ts:36

    • Optional vendorId

    vendorId?: number
    +
  • Defined in packages/api/src/models/BillVendors.ts:31

    • Optional vendorName

    vendorName?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:34

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/BillVendors.ts:32

    • Optional website

    website?: string
    +
  • Defined in packages/api/src/models/BillVendors.ts:33
    • diff --git a/docs/interfaces/models.Bills.html b/docs/interfaces/models.Bills.html index 705d35bd9..2fc5bb881 100644 --- a/docs/interfaces/models.Bills.html +++ b/docs/interfaces/models.Bills.html @@ -21,7 +21,7 @@

    Hierarchy

    • Bills
    +
  • Defined in packages/api/src/models/Bills.ts:18
    • @@ -59,117 +59,117 @@

    Properties

    Optional amount

    amount?: default
    +
  • Defined in packages/api/src/models/Bills.ts:20

    • Optional attachment

    attachment?: object
    +
  • Defined in packages/api/src/models/Bills.ts:21

    • Optional billNumber

    billNumber?: string
    +
  • Defined in packages/api/src/models/Bills.ts:22

    • Optional billPayments

    billPayments?: BillPayments[]
    +
  • Defined in packages/api/src/models/Bills.ts:23

    • Optional createdAt

    createdAt?: Date
    +
  • Defined in packages/api/src/models/Bills.ts:24

    • Optional currencyCode

    currencyCode?: string
    +
  • Defined in packages/api/src/models/Bills.ts:25

    • Optional dueDate

    dueDate?: Date
    +
  • Defined in packages/api/src/models/Bills.ts:26

    • Optional dueOffsetDays

    dueOffsetDays?: number
    +
  • Defined in packages/api/src/models/Bills.ts:27

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/Bills.ts:19

    • Optional issueDate

    issueDate?: Date
    +
  • Defined in packages/api/src/models/Bills.ts:28

    • Optional language

    language?: string
    +
  • Defined in packages/api/src/models/Bills.ts:29

    • Optional lines

    lines?: default[]
    +
  • Defined in packages/api/src/models/Bills.ts:30

    • Optional outstanding

    outstanding?: default
    +
  • Defined in packages/api/src/models/Bills.ts:31

    • Optional overallCategory

    overallCategory?: string
    +
  • Defined in packages/api/src/models/Bills.ts:32

    • Optional overallDescription

    overallDescription?: string
    +
  • Defined in packages/api/src/models/Bills.ts:33

    • Optional paid

    paid?: default
    +
  • Defined in packages/api/src/models/Bills.ts:34

    • Optional status

    status?: BillStatus
    +
  • Defined in packages/api/src/models/Bills.ts:35

    • Optional taxAmount

    taxAmount?: default
    +
  • Defined in packages/api/src/models/Bills.ts:36

    • Optional totalAmount

    totalAmount?: default
    +
  • Defined in packages/api/src/models/Bills.ts:37

    • Optional updatedAt

    updatedAt?: Date
    +
  • Defined in packages/api/src/models/Bills.ts:38

    • Optional vendor

    vendor?: BillVendors
    +
  • Defined in packages/api/src/models/Bills.ts:41

    • vendorId

    vendorId: number
    +
  • Defined in packages/api/src/models/Bills.ts:39

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/Bills.ts:40
    • diff --git a/docs/interfaces/models.Callback.html b/docs/interfaces/models.Callback.html index de71e0dc4..de9341207 100644 --- a/docs/interfaces/models.Callback.html +++ b/docs/interfaces/models.Callback.html @@ -21,7 +21,7 @@

    Hierarchy

    • Callback
    +
  • Defined in packages/api/src/models/Callback.ts:7
    • @@ -41,27 +41,27 @@

    Properties

    Optional callbackId

    callbackId?: number
    +
  • Defined in packages/api/src/models/Callback.ts:8

    • event

    event: string
    +
  • Defined in packages/api/src/models/Callback.ts:9

    • Optional updatedAt

    updatedAt?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Callback.ts:12

    • uri

    uri: string
    +
  • Defined in packages/api/src/models/Callback.ts:10

    • Optional verified

    verified?: boolean
    +
  • Defined in packages/api/src/models/Callback.ts:11
    • diff --git a/docs/interfaces/models.Client.html b/docs/interfaces/models.Client.html index d7a9409c5..53792caed 100644 --- a/docs/interfaces/models.Client.html +++ b/docs/interfaces/models.Client.html @@ -21,7 +21,7 @@

    Hierarchy

    • Client
    +
  • Defined in packages/api/src/models/Client.ts:9
    • @@ -85,247 +85,247 @@

    Properties

    Optional accountingSystemId

    accountingSystemId?: string
    +
  • Defined in packages/api/src/models/Client.ts:42

    • Optional allowLateFees

    allowLateFees?: boolean
    +
  • Defined in packages/api/src/models/Client.ts:39

    • Optional allowLateNotifications

    allowLateNotifications?: boolean
    +
  • Defined in packages/api/src/models/Client.ts:15

    • Optional busPhone

    busPhone?: string
    +
  • Defined in packages/api/src/models/Client.ts:38

    • Optional companyIndustry

    companyIndustry?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:32

    • Optional companySize

    companySize?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:41

    • Optional currencyCode

    currencyCode?: string
    +
  • Defined in packages/api/src/models/Client.ts:55

    • Optional directLinkToken

    directLinkToken?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:22

    • Optional email

    email?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:14

    • Optional fName

    fName?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:11

    • Optional fax

    fax?: string
    +
  • Defined in packages/api/src/models/Client.ts:17

    • Optional hasRetainer

    hasRetainer?: Nullable<boolean>
    +
  • Defined in packages/api/src/models/Client.ts:56

    • Optional homePhone

    homePhone?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:31

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/Client.ts:10

    • Optional lName

    lName?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:12

    • Optional language

    language?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:45

    • Optional lastActivity

    lastActivity?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:18

    • Optional lastLogin

    lastLogin?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Client.ts:30

    • Optional level

    level?: number
    +
  • Defined in packages/api/src/models/Client.ts:46

    • Optional mobPhone

    mobPhone?: string
    +
  • Defined in packages/api/src/models/Client.ts:29

    • Optional note

    note?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:28

    • Optional notified

    notified?: boolean
    +
  • Defined in packages/api/src/models/Client.ts:47

    • Optional numLogins

    numLogins?: number
    +
  • Defined in packages/api/src/models/Client.ts:19

    • Optional organization

    organization?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:13

    • Optional pCity

    pCity?: string
    +
  • Defined in packages/api/src/models/Client.ts:37

    • Optional pCode

    pCode?: string
    +
  • Defined in packages/api/src/models/Client.ts:43

    • Optional pCountry

    pCountry?: string
    +
  • Defined in packages/api/src/models/Client.ts:54

    • Optional pProvince

    pProvince?: string
    +
  • Defined in packages/api/src/models/Client.ts:36

    • Optional pStreet

    pStreet?: string
    +
  • Defined in packages/api/src/models/Client.ts:40

    • Optional pStreet2

    pStreet2?: string
    +
  • Defined in packages/api/src/models/Client.ts:49

    • Optional prefEmail

    prefEmail?: boolean
    +
  • Defined in packages/api/src/models/Client.ts:21

    • Optional prefGmail

    prefGmail?: boolean
    +
  • Defined in packages/api/src/models/Client.ts:50

    • Optional retainerId

    retainerId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:57

    • Optional role

    role?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:58

    • Optional sCity

    sCity?: string
    +
  • Defined in packages/api/src/models/Client.ts:25

    • Optional sCode

    sCode?: string
    +
  • Defined in packages/api/src/models/Client.ts:16

    • Optional sCountry

    sCountry?: string
    +
  • Defined in packages/api/src/models/Client.ts:52

    • Optional sProvince

    sProvince?: string
    +
  • Defined in packages/api/src/models/Client.ts:23

    • Optional sStreet

    sStreet?: string
    +
  • Defined in packages/api/src/models/Client.ts:53

    • Optional sStreet2

    sStreet2?: string
    +
  • Defined in packages/api/src/models/Client.ts:26

    • Optional signupDate

    signupDate?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Client.ts:44

    • Optional statementToken

    statementToken?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:27

    • Optional subdomain

    subdomain?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:33

    • Optional updated

    updated?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Client.ts:35

    • Optional userId

    userId?: number
    +
  • Defined in packages/api/src/models/Client.ts:48

    • Optional username

    username?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:34

    • Optional vatName

    vatName?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:24

    • Optional vatNumber

    vatNumber?: Nullable<string>
    +
  • Defined in packages/api/src/models/Client.ts:20

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/Client.ts:51
    • diff --git a/docs/interfaces/models.CreditNote.html b/docs/interfaces/models.CreditNote.html index 25504e8bf..9f23bfa5b 100644 --- a/docs/interfaces/models.CreditNote.html +++ b/docs/interfaces/models.CreditNote.html @@ -21,7 +21,7 @@

    Hierarchy

    • CreditNote
    +
  • Defined in packages/api/src/models/CreditNote.ts:40
    • @@ -73,187 +73,187 @@

    Properties

    Optional accountingSystemId

    accountingSystemId?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:43

    • Optional amount

    amount?: default
    +
  • Defined in packages/api/src/models/CreditNote.ts:45

    • Optional city

    city?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:46

    • Optional clientId

    clientId?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:47

    • Optional code

    code?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:48

    • Optional country

    country?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:49

    • Optional createDate

    createDate?: Date
    +
  • Defined in packages/api/src/models/CreditNote.ts:51

    • Optional creditId

    creditId?: number
    +
  • Defined in packages/api/src/models/CreditNote.ts:42

    • Optional creditNumber

    creditNumber?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:50

    • Optional creditType

    creditType?: CreditType
    +
  • Defined in packages/api/src/models/CreditNote.ts:52

    • Optional currencyCode

    currencyCode?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:53

    • Optional currentOrganization

    currentOrganization?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:54

    • Optional description

    description?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:55

    • Optional displayStatus

    displayStatus?: DisplayStatus
    +
  • Defined in packages/api/src/models/CreditNote.ts:56

    • Optional disputeStatus

    disputeStatus?: Nullable<DisputeStatus>
    +
  • Defined in packages/api/src/models/CreditNote.ts:57

    • Optional extArchive

    extArchive?: number
    +
  • Defined in packages/api/src/models/CreditNote.ts:58

    • Optional fName

    fName?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:59

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/CreditNote.ts:41

    • Optional lName

    lName?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:63

    • Optional language

    language?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:60

    • Optional lastOrderStatus

    lastOrderStatus?: Nullable<LastOrderStatus>
    +
  • Defined in packages/api/src/models/CreditNote.ts:61

    • Optional lines

    lines?: default[]
    +
  • Defined in packages/api/src/models/CreditNote.ts:62

    • Optional notes

    notes?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:64

    • Optional organization

    organization?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:65

    • Optional paid

    paid?: default
    +
  • Defined in packages/api/src/models/CreditNote.ts:66

    • Optional paymentStatus

    paymentStatus?: PaymentStatus
    +
  • Defined in packages/api/src/models/CreditNote.ts:67

    • Optional paymentType

    paymentType?: Nullable<string>
    +
  • Defined in packages/api/src/models/CreditNote.ts:68

    • Optional province

    province?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:69

    • Optional sentId

    sentId?: number
    +
  • Defined in packages/api/src/models/CreditNote.ts:44

    • Optional status

    status?: DisplayStatus
    +
  • Defined in packages/api/src/models/CreditNote.ts:70

    • Optional street

    street?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:71

    • Optional street2

    street2?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:72

    • Optional template

    template?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:73

    • Optional terms

    terms?: Nullable<string>
    +
  • Defined in packages/api/src/models/CreditNote.ts:74

    • Optional vatName

    vatName?: Nullable<string>
    +
  • Defined in packages/api/src/models/CreditNote.ts:75

    • Optional vatNumber

    vatNumber?: string
    +
  • Defined in packages/api/src/models/CreditNote.ts:76

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/CreditNote.ts:77
    • diff --git a/docs/interfaces/models.Expense.html b/docs/interfaces/models.Expense.html index 29aff619f..beeec5454 100644 --- a/docs/interfaces/models.Expense.html +++ b/docs/interfaces/models.Expense.html @@ -21,7 +21,7 @@

    Hierarchy

    • Expense
    +
  • Defined in packages/api/src/models/Expense.ts:17
    • @@ -69,167 +69,167 @@

    Properties

    Optional accountId

    accountId?: Nullable<number>
    +
  • Defined in packages/api/src/models/Expense.ts:49

    • Optional accountName

    accountName?: string
    +
  • Defined in packages/api/src/models/Expense.ts:28

    • Optional accountingSystemId

    accountingSystemId?: string
    +
  • Defined in packages/api/src/models/Expense.ts:43

    • amount

    amount: default
    +
  • Defined in packages/api/src/models/Expense.ts:46

    • Optional bankName

    bankName?: string
    +
  • Defined in packages/api/src/models/Expense.ts:36

    • Optional category

    category?: ExpenseCategory
    +
  • Defined in packages/api/src/models/Expense.ts:50

    • categoryId

    categoryId: number
    +
  • Defined in packages/api/src/models/Expense.ts:18

    • Optional clientId

    clientId?: number
    +
  • Defined in packages/api/src/models/Expense.ts:21

    • Optional compoundedTax

    compoundedTax?: boolean
    +
  • Defined in packages/api/src/models/Expense.ts:48

    • date

    date: Date
    +
  • Defined in packages/api/src/models/Expense.ts:41

    • Optional expenseId

    expenseId?: number
    +
  • Defined in packages/api/src/models/Expense.ts:47

    • Optional extInvoiceId

    extInvoiceId?: number
    +
  • Defined in packages/api/src/models/Expense.ts:45

    • Optional extSystemId

    extSystemId?: number
    +
  • Defined in packages/api/src/models/Expense.ts:39

    • Optional hasReceipt

    hasReceipt?: boolean
    +
  • Defined in packages/api/src/models/Expense.ts:42

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/Expense.ts:31

    • Optional invoiceId

    invoiceId?: Nullable<number>
    +
  • Defined in packages/api/src/models/Expense.ts:30

    • Optional isDuplicate

    isDuplicate?: boolean
    +
  • Defined in packages/api/src/models/Expense.ts:25

    • Optional markupPercent

    markupPercent?: number
    +
  • Defined in packages/api/src/models/Expense.ts:19

    • Optional notes

    notes?: string
    +
  • Defined in packages/api/src/models/Expense.ts:44

    • Optional profileId

    profileId?: Nullable<number>
    +
  • Defined in packages/api/src/models/Expense.ts:26

    • Optional projectId

    projectId?: number
    +
  • Defined in packages/api/src/models/Expense.ts:20

    • staffId

    staffId: number
    +
  • Defined in packages/api/src/models/Expense.ts:40

    • Optional status

    status?: ExpenseStatus
    +
  • Defined in packages/api/src/models/Expense.ts:35

    • Optional taxAmount1

    taxAmount1?: Nullable<default>
    +
  • Defined in packages/api/src/models/Expense.ts:33

    • Optional taxAmount2

    taxAmount2?: Nullable<default>
    +
  • Defined in packages/api/src/models/Expense.ts:32

    • Optional taxName1

    taxName1?: Nullable<string>
    +
  • Defined in packages/api/src/models/Expense.ts:24

    • Optional taxName2

    taxName2?: Nullable<string>
    +
  • Defined in packages/api/src/models/Expense.ts:23

    • Optional taxPercent1

    taxPercent1?: Nullable<string>
    +
  • Defined in packages/api/src/models/Expense.ts:22

    • Optional taxPercent2

    taxPercent2?: Nullable<string>
    +
  • Defined in packages/api/src/models/Expense.ts:27

    • Optional transactionId

    transactionId?: Nullable<number>
    +
  • Defined in packages/api/src/models/Expense.ts:29

    • Optional updated

    updated?: Date
    +
  • Defined in packages/api/src/models/Expense.ts:37

    • Optional vendor

    vendor?: Nullable<string>
    +
  • Defined in packages/api/src/models/Expense.ts:38

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/Expense.ts:34
    • diff --git a/docs/interfaces/models.ExpenseCategory.html b/docs/interfaces/models.ExpenseCategory.html index 83e5c6513..30af808fa 100644 --- a/docs/interfaces/models.ExpenseCategory.html +++ b/docs/interfaces/models.ExpenseCategory.html @@ -21,7 +21,7 @@

    Hierarchy

    • ExpenseCategory
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:7
    • @@ -46,52 +46,52 @@

    Properties

    category

    category: string
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:8

    • categoryId

    categoryId: number
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:9

    • createdAt

    createdAt: Date
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:10

    • id

    id: number
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:11

    • isCogs

    isCogs: boolean
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:12

    • isEditable

    isEditable: boolean
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:13

    • parentId

    parentId: number
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:14

    • transactionPosted

    transactionPosted: boolean
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:15

    • updatedAt

    updatedAt: Date
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:16

    • visState

    visState: VisState
    +
  • Defined in packages/api/src/models/ExpenseCategory.ts:17
    • diff --git a/docs/interfaces/models.Invoice.html b/docs/interfaces/models.Invoice.html index 4df93747f..6594d8bc2 100644 --- a/docs/interfaces/models.Invoice.html +++ b/docs/interfaces/models.Invoice.html @@ -21,7 +21,7 @@

    Hierarchy

    • Invoice
    +
  • Defined in packages/api/src/models/Invoices.ts:68
    • @@ -105,347 +105,347 @@

    Properties

    Optional accountId

    accountId?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:70

    • Optional accountingSystemId

    accountingSystemId?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:71

    • Optional actionEmail

    actionEmail?: Nullable<boolean>
    +
  • Defined in packages/api/src/models/Invoices.ts:72

    • Optional actionMarkAsSent

    actionMarkAsSent?: Nullable<boolean>
    +
  • Defined in packages/api/src/models/Invoices.ts:73

    • Optional address

    address?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:74

    • Optional amount

    amount?: default
    +
  • Defined in packages/api/src/models/Invoices.ts:75

    • Optional autoBill

    autoBill?: boolean
    +
  • Defined in packages/api/src/models/Invoices.ts:76

    • Optional autobillStatus

    autobillStatus?: Nullable<AutoBillStatus>
    +
  • Defined in packages/api/src/models/Invoices.ts:77

    • Optional city

    city?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:78

    • Optional code

    code?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:79

    • Optional country

    country?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:80

    • createDate

    createDate: Date
    +
  • Defined in packages/api/src/models/Invoices.ts:81

    • Optional createdAt

    createdAt?: Date
    +
  • Defined in packages/api/src/models/Invoices.ts:82

    • Optional currencyCode

    currencyCode?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:83

    • Optional currentOrganization

    currentOrganization?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:84

    • customerId

    customerId: number
    +
  • Defined in packages/api/src/models/Invoices.ts:85

    • Optional datePaid

    datePaid?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Invoices.ts:86

    • Optional depositAmount

    depositAmount?: Nullable<default>
    +
  • Defined in packages/api/src/models/Invoices.ts:87

    • Optional depositPercentage

    depositPercentage?: Nullable<string>
    +
  • Defined in packages/api/src/models/Invoices.ts:88

    • Optional depositStatus

    depositStatus?: DepositStatus
    +
  • Defined in packages/api/src/models/Invoices.ts:89

    • Optional description

    description?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:90

    • Optional discountDescription

    discountDescription?: Nullable<string>
    +
  • Defined in packages/api/src/models/Invoices.ts:91

    • Optional discountTotal

    discountTotal?: default
    +
  • Defined in packages/api/src/models/Invoices.ts:92

    • Optional discountValue

    discountValue?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:93

    • Optional displayStatus

    displayStatus?: DisplayStatus
    +
  • Defined in packages/api/src/models/Invoices.ts:94

    • Optional disputeStatus

    disputeStatus?: Nullable<string>
    +
  • Defined in packages/api/src/models/Invoices.ts:95

    • Optional dueDate

    dueDate?: Date
    +
  • Defined in packages/api/src/models/Invoices.ts:96

    • Optional dueOffsetDays

    dueOffsetDays?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:97

    • Optional email

    email?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:98

    • Optional emailIncludePdf

    emailIncludePdf?: boolean
    +
  • Defined in packages/api/src/models/Invoices.ts:99

    • Optional emailRecipients

    emailRecipients?: string[]
    +
  • Defined in packages/api/src/models/Invoices.ts:100

    • Optional estimateId

    estimateId?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:101

    • Optional extArchive

    extArchive?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:102

    • Optional fName

    fName?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:103

    • Optional fulfillmentDate

    fulfillmentDate?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Invoices.ts:104

    • Optional generationDate

    generationDate?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Invoices.ts:105

    • Optional gmail

    gmail?: boolean
    +
  • Defined in packages/api/src/models/Invoices.ts:106

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:69

    • Optional invoiceCustomizedEmail

    invoiceCustomizedEmail?: InvoiceCustomizedEmail
    +
  • Defined in packages/api/src/models/Invoices.ts:107

    • Optional invoiceId

    invoiceId?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:109

    • Optional invoiceNumber

    invoiceNumber?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:108

    • Optional lName

    lName?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:113

    • Optional language

    language?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:110

    • Optional lastOrderStatus

    lastOrderStatus?: Nullable<string>
    +
  • Defined in packages/api/src/models/Invoices.ts:111

    • Optional lines

    lines?: default[]
    +
  • Defined in packages/api/src/models/Invoices.ts:112

    • Optional notes

    notes?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:114

    • Optional organization

    organization?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:115

    • Optional outstanding

    outstanding?: default
    +
  • Defined in packages/api/src/models/Invoices.ts:116

    • Optional owner

    owner?: default
    +
  • Defined in packages/api/src/models/Invoices.ts:117

    • Optional ownerId

    ownerId?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:118

    • Optional paid

    paid?: default
    +
  • Defined in packages/api/src/models/Invoices.ts:119

    • Optional parent

    parent?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:120

    • Optional paymentDetails

    paymentDetails?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:121

    • Optional paymentStatus

    paymentStatus?: PaymentStatus
    +
  • Defined in packages/api/src/models/Invoices.ts:122

    • Optional poNumber

    poNumber?: Nullable<string>
    +
  • Defined in packages/api/src/models/Invoices.ts:123

    • Optional province

    province?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:124

    • Optional returnUri

    returnUri?: Nullable<string>
    +
  • Defined in packages/api/src/models/Invoices.ts:125

    • Optional sentId

    sentId?: number
    +
  • Defined in packages/api/src/models/Invoices.ts:126

    • Optional showAttachments

    showAttachments?: boolean
    +
  • Defined in packages/api/src/models/Invoices.ts:127

    • Optional status

    status?: InvoiceStatus
    +
  • Defined in packages/api/src/models/Invoices.ts:128

    • Optional street

    street?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:129

    • Optional street2

    street2?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:130

    • Optional template

    template?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:131

    • Optional terms

    terms?: Nullable<string>
    +
  • Defined in packages/api/src/models/Invoices.ts:132

    • Optional updated

    updated?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Invoices.ts:133

    • Optional v3Status

    v3Status?: InvoiceV3Status
    +
  • Defined in packages/api/src/models/Invoices.ts:134

    • Optional vatName

    vatName?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:135

    • Optional vatNumber

    vatNumber?: string
    +
  • Defined in packages/api/src/models/Invoices.ts:136

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/Invoices.ts:137
    • diff --git a/docs/interfaces/models.InvoiceCustomizedEmail.html b/docs/interfaces/models.InvoiceCustomizedEmail.html index c801830fe..0baafe4e5 100644 --- a/docs/interfaces/models.InvoiceCustomizedEmail.html +++ b/docs/interfaces/models.InvoiceCustomizedEmail.html @@ -21,7 +21,7 @@

    Hierarchy

    • InvoiceCustomizedEmail
    +
  • Defined in packages/api/src/models/InvoiceCustomizedEmail.ts:1
    • @@ -38,12 +38,12 @@

    Properties

    Optional body

    body?: string
    +
  • Defined in packages/api/src/models/InvoiceCustomizedEmail.ts:2

    • Optional subject

    subject?: string
    +
  • Defined in packages/api/src/models/InvoiceCustomizedEmail.ts:3
    • diff --git a/docs/interfaces/models.Item.html b/docs/interfaces/models.Item.html index 5751f5fa9..929069839 100644 --- a/docs/interfaces/models.Item.html +++ b/docs/interfaces/models.Item.html @@ -21,7 +21,7 @@

    Hierarchy

    • Item
    +
  • Defined in packages/api/src/models/Item.ts:12
    • @@ -48,62 +48,62 @@

    Properties

    accountingSystemId

    accountingSystemId: string
    +
  • Defined in packages/api/src/models/Item.ts:14

    • Optional description

    description?: Nullable<string>
    +
  • Defined in packages/api/src/models/Item.ts:17

    • id

    id: number
    +
  • Defined in packages/api/src/models/Item.ts:13

    • Optional inventory

    inventory?: Nullable<string>
    +
  • Defined in packages/api/src/models/Item.ts:20

    • name

    name: string
    +
  • Defined in packages/api/src/models/Item.ts:16

    • qty

    qty: string
    +
  • Defined in packages/api/src/models/Item.ts:18

    • Optional sku

    sku?: Nullable<string>
    +
  • Defined in packages/api/src/models/Item.ts:19

    • tax1

    tax1: number
    +
  • Defined in packages/api/src/models/Item.ts:22

    • tax2

    tax2: number
    +
  • Defined in packages/api/src/models/Item.ts:23

    • unitCost

    unitCost: default
    +
  • Defined in packages/api/src/models/Item.ts:21

    • updated

    updated: Date
    +
  • Defined in packages/api/src/models/Item.ts:15

    • visState

    visState: VisState
    +
  • Defined in packages/api/src/models/Item.ts:24
    • diff --git a/docs/interfaces/models.JournalEntry.html b/docs/interfaces/models.JournalEntry.html index 662433e26..d8949dacf 100644 --- a/docs/interfaces/models.JournalEntry.html +++ b/docs/interfaces/models.JournalEntry.html @@ -21,7 +21,7 @@

    Hierarchy

    • JournalEntry
    +
  • Defined in packages/api/src/models/JournalEntry.ts:6
    • @@ -43,37 +43,37 @@

    Properties

    currencyCode

    currencyCode: string
    +
  • Defined in packages/api/src/models/JournalEntry.ts:7

    • description

    description: string
    +
  • Defined in packages/api/src/models/JournalEntry.ts:8

    • details

    details: default[]
    +
  • Defined in packages/api/src/models/JournalEntry.ts:9

    • Optional entryId

    entryId?: number
    +
  • Defined in packages/api/src/models/JournalEntry.ts:10

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/JournalEntry.ts:11

    • name

    name: string
    +
  • Defined in packages/api/src/models/JournalEntry.ts:12

    • userEnteredDate

    userEnteredDate: Date
    +
  • Defined in packages/api/src/models/JournalEntry.ts:13
    • diff --git a/docs/interfaces/models.JournalEntryAccount.html b/docs/interfaces/models.JournalEntryAccount.html index e044c15da..c71ee05f9 100644 --- a/docs/interfaces/models.JournalEntryAccount.html +++ b/docs/interfaces/models.JournalEntryAccount.html @@ -21,7 +21,7 @@

    Hierarchy

    • JournalEntryAccount
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:7
    • @@ -46,52 +46,52 @@

    Properties

    accountId

    accountId: number
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:11

    • accountName

    accountName: string
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:8

    • accountNumber

    accountNumber: string
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:9

    • accountType

    accountType: string
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:10

    • Optional accountingSystemId

    accountingSystemId?: string
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:12

    • Optional balance

    balance?: number
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:13

    • Optional createdAt

    createdAt?: Date
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:14

    • Optional currencyCode

    currencyCode?: string
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:15

    • id

    id: number
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:16

    • Optional subAccounts

    subAccounts?: default[]
    +
  • Defined in packages/api/src/models/JournalEntryAccount.ts:17
    • diff --git a/docs/interfaces/models.JournalEntryDetail.html b/docs/interfaces/models.JournalEntryDetail.html index cae692658..95a77148d 100644 --- a/docs/interfaces/models.JournalEntryDetail.html +++ b/docs/interfaces/models.JournalEntryDetail.html @@ -21,7 +21,7 @@

    Hierarchy

    • JournalEntryDetail
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:11
    • @@ -49,67 +49,67 @@

    Properties

    account

    account: JournalEntryAccount
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:12

    • accountingSystemId

    accountingSystemId: string
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:13

    • balance

    balance: default
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:14

    • credit

    credit: Nullable<default>
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:15

    • debit

    debit: Nullable<default>
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:16

    • description

    description: string
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:17

    • detailId

    detailId: number
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:19

    • detailType

    detailType: string
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:18

    • entry

    entry: default
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:20

    • id

    id: number
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:21

    • name

    name: string
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:22

    • subAccount

    subAccount: default
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:23

    • userEnteredDate

    userEnteredDate: Date
    +
  • Defined in packages/api/src/models/JournalEntryDetail.ts:24
    • diff --git a/docs/interfaces/models.OtherIncome.html b/docs/interfaces/models.OtherIncome.html index 7494ab114..29cf7d174 100644 --- a/docs/interfaces/models.OtherIncome.html +++ b/docs/interfaces/models.OtherIncome.html @@ -21,7 +21,7 @@

    Hierarchy

    • OtherIncome
    +
  • Defined in packages/api/src/models/OtherIncome.ts:21
    • @@ -47,57 +47,57 @@

    Properties

    Optional amount

    amount?: default
    +
  • Defined in packages/api/src/models/OtherIncome.ts:23

    • Optional categoryName

    categoryName?: CategoryName
    +
  • Defined in packages/api/src/models/OtherIncome.ts:24

    • Optional createdAt

    createdAt?: Date
    +
  • Defined in packages/api/src/models/OtherIncome.ts:25

    • Optional date

    date?: Date
    +
  • Defined in packages/api/src/models/OtherIncome.ts:26

    • Optional incomeId

    incomeId?: string
    +
  • Defined in packages/api/src/models/OtherIncome.ts:22

    • Optional note

    note?: Text
    +
  • Defined in packages/api/src/models/OtherIncome.ts:27

    • paymentType

    paymentType: string
    +
  • Defined in packages/api/src/models/OtherIncome.ts:28

    • Optional source

    source?: string
    +
  • Defined in packages/api/src/models/OtherIncome.ts:29

    • Optional taxes

    taxes?: default[]
    +
  • Defined in packages/api/src/models/OtherIncome.ts:30

    • Optional updatedAt

    updatedAt?: Date
    +
  • Defined in packages/api/src/models/OtherIncome.ts:31

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/OtherIncome.ts:32
    • diff --git a/docs/interfaces/models.Pagination.html b/docs/interfaces/models.Pagination.html index b3f5d92a1..d75882d5b 100644 --- a/docs/interfaces/models.Pagination.html +++ b/docs/interfaces/models.Pagination.html @@ -32,7 +32,7 @@

    Hierarchy

    • Pagination
    +
  • Defined in packages/api/src/models/Pagination.ts:9
    • @@ -51,22 +51,22 @@

    Properties

    page

    page: number
    +
  • Defined in packages/api/src/models/Pagination.ts:10

    • pages

    pages: number
    +
  • Defined in packages/api/src/models/Pagination.ts:11

    • size

    size: number
    +
  • Defined in packages/api/src/models/Pagination.ts:13

    • total

    total: number
    +
  • Defined in packages/api/src/models/Pagination.ts:12
    • diff --git a/docs/interfaces/models.Payment.html b/docs/interfaces/models.Payment.html index dea3d1c31..12b8617a4 100644 --- a/docs/interfaces/models.Payment.html +++ b/docs/interfaces/models.Payment.html @@ -21,7 +21,7 @@

    Hierarchy

    • Payment
    +
  • Defined in packages/api/src/models/Payment.ts:28
    • @@ -53,87 +53,87 @@

    Properties

    Optional accountingSystemId

    accountingSystemId?: string
    +
  • Defined in packages/api/src/models/Payment.ts:30

    • amount

    amount: default
    +
  • Defined in packages/api/src/models/Payment.ts:34

    • Optional clientId

    clientId?: string
    +
  • Defined in packages/api/src/models/Payment.ts:35

    • Optional creditId

    creditId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Payment.ts:33

    • date

    date: Date
    +
  • Defined in packages/api/src/models/Payment.ts:41

    • Optional fromCredit

    fromCredit?: boolean
    +
  • Defined in packages/api/src/models/Payment.ts:43

    • Optional gateway

    gateway?: Nullable<string>
    +
  • Defined in packages/api/src/models/Payment.ts:40

    • Optional id

    id?: string
    +
  • Defined in packages/api/src/models/Payment.ts:45

    • invoiceId

    invoiceId: string
    +
  • Defined in packages/api/src/models/Payment.ts:32

    • Optional logId

    logId?: string
    +
  • Defined in packages/api/src/models/Payment.ts:37

    • Optional note

    note?: string
    +
  • Defined in packages/api/src/models/Payment.ts:38

    • Optional orderId

    orderId?: number
    +
  • Defined in packages/api/src/models/Payment.ts:29

    • Optional overpaymentId

    overpaymentId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Payment.ts:39

    • Optional transactionId

    transactionId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Payment.ts:42

    • Optional type

    type?: PaymentType
    +
  • Defined in packages/api/src/models/Payment.ts:44

    • Optional updated

    updated?: Date
    +
  • Defined in packages/api/src/models/Payment.ts:31

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/Payment.ts:36
    • diff --git a/docs/interfaces/models.PaymentOptions.html b/docs/interfaces/models.PaymentOptions.html index b4a42d295..1bfa44fa5 100644 --- a/docs/interfaces/models.PaymentOptions.html +++ b/docs/interfaces/models.PaymentOptions.html @@ -21,7 +21,7 @@

    Hierarchy

    • PaymentOptions
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:10
    • @@ -45,47 +45,47 @@

    Properties

    Optional allowPartialPayments

    allowPartialPayments?: boolean
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:19

    • entityId

    entityId: string
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:12

    • entityType

    entityType: string
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:13

    • gatewayName

    gatewayName: PaymentGatewayName
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:11

    • Optional hasAchTransfer

    hasAchTransfer?: boolean
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:15

    • Optional hasBacsDebit

    hasBacsDebit?: boolean
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:16

    • Optional hasCreditCard

    hasCreditCard?: boolean
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:14

    • Optional hasPayPalSmartCheckout

    hasPayPalSmartCheckout?: boolean
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:18

    • Optional hasSepaDebit

    hasSepaDebit?: boolean
    +
  • Defined in packages/api/src/models/PaymentOptions.ts:17
    • diff --git a/docs/interfaces/models.Project.html b/docs/interfaces/models.Project.html index b3ba53189..7a03f4e03 100644 --- a/docs/interfaces/models.Project.html +++ b/docs/interfaces/models.Project.html @@ -21,7 +21,7 @@

    Hierarchy

    • Project
    +
  • Defined in packages/api/src/models/Project.ts:27
    • @@ -61,127 +61,127 @@

    Properties

    Optional active

    active?: boolean
    +
  • Defined in packages/api/src/models/Project.ts:40

    • Optional billedAmount

    billedAmount?: number
    +
  • Defined in packages/api/src/models/Project.ts:47

    • Optional billedStatus

    billedStatus?: BilledStatus
    +
  • Defined in packages/api/src/models/Project.ts:48

    • Optional billingMethod

    billingMethod?: Nullable<BillingMethod>
    +
  • Defined in packages/api/src/models/Project.ts:37

    • Optional budget

    budget?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:34

    • Optional clientId

    clientId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:32

    • Optional complete

    complete?: boolean
    +
  • Defined in packages/api/src/models/Project.ts:41

    • Optional createdAt

    createdAt?: Date
    +
  • Defined in packages/api/src/models/Project.ts:43

    • Optional description

    description?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:30

    • Optional dueDate

    dueDate?: Nullable<Date>
    +
  • Defined in packages/api/src/models/Project.ts:31

    • Optional expenseMarkup

    expenseMarkup?: number
    +
  • Defined in packages/api/src/models/Project.ts:50

    • Optional fixedPrice

    fixedPrice?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:35

    • Optional group

    group?: Nullable<default>
    +
  • Defined in packages/api/src/models/Project.ts:52

    • Optional groupId

    groupId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:51

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/Project.ts:28

    • Optional internal

    internal?: boolean
    +
  • Defined in packages/api/src/models/Project.ts:33

    • Optional loggedDuration

    loggedDuration?: Nullable<number>
    +
  • Defined in packages/api/src/models/Project.ts:45

    • Optional projectManagerId

    projectManagerId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:39

    • Optional projectType

    projectType?: ProjectType
    +
  • Defined in packages/api/src/models/Project.ts:38

    • Optional rate

    rate?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:36

    • Optional retainerId

    retainerId?: Nullable<string>
    +
  • Defined in packages/api/src/models/Project.ts:49

    • Optional sample

    sample?: boolean
    +
  • Defined in packages/api/src/models/Project.ts:42

    • Optional services

    services?: Nullable<Service[]>
    +
  • Defined in packages/api/src/models/Project.ts:46

    • Optional title

    title?: string
    +
  • Defined in packages/api/src/models/Project.ts:29

    • Optional updatedAt

    updatedAt?: Date
    +
  • Defined in packages/api/src/models/Project.ts:44
    • diff --git a/docs/interfaces/models.Service.html b/docs/interfaces/models.Service.html index 5c2cdf8c8..28fe6fe8e 100644 --- a/docs/interfaces/models.Service.html +++ b/docs/interfaces/models.Service.html @@ -21,7 +21,7 @@

    Hierarchy

    • Service
    +
  • Defined in packages/api/src/models/Service.ts:7
    • @@ -41,27 +41,27 @@

    Properties

    Optional billable

    billable?: boolean
    +
  • Defined in packages/api/src/models/Service.ts:11

    • Optional businessId

    businessId?: number
    +
  • Defined in packages/api/src/models/Service.ts:8

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/Service.ts:9

    • Optional name

    name?: string
    +
  • Defined in packages/api/src/models/Service.ts:10

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/Service.ts:12
    • diff --git a/docs/interfaces/models.ServiceRate.html b/docs/interfaces/models.ServiceRate.html index ff425d009..53bf70eb1 100644 --- a/docs/interfaces/models.ServiceRate.html +++ b/docs/interfaces/models.ServiceRate.html @@ -21,7 +21,7 @@

    Hierarchy

    • ServiceRate
    +
  • Defined in packages/api/src/models/ServiceRate.ts:4
    • @@ -39,17 +39,17 @@

    Properties

    Optional businessId

    businessId?: number
    +
  • Defined in packages/api/src/models/ServiceRate.ts:6

    • Optional rate

    rate?: string
    +
  • Defined in packages/api/src/models/ServiceRate.ts:5

    • Optional serviceId

    serviceId?: number
    +
  • Defined in packages/api/src/models/ServiceRate.ts:7
    • diff --git a/docs/interfaces/models.ShareLink.html b/docs/interfaces/models.ShareLink.html index b95889073..98ad49589 100644 --- a/docs/interfaces/models.ShareLink.html +++ b/docs/interfaces/models.ShareLink.html @@ -21,7 +21,7 @@

    Hierarchy

    • ShareLink
    +
  • Defined in packages/api/src/models/ShareLink.ts:4
    • @@ -41,27 +41,27 @@

    Properties

    clientId

    clientId: number
    +
  • Defined in packages/api/src/models/ShareLink.ts:6

    • resourceId

    resourceId: number
    +
  • Defined in packages/api/src/models/ShareLink.ts:5

    • resourceType

    resourceType: string
    +
  • Defined in packages/api/src/models/ShareLink.ts:7

    • shareLink

    shareLink: string
    +
  • Defined in packages/api/src/models/ShareLink.ts:8

    • shareMethod

    shareMethod: string
    +
  • Defined in packages/api/src/models/ShareLink.ts:9
    • diff --git a/docs/interfaces/models.Tasks.html b/docs/interfaces/models.Tasks.html index 5cacc62c3..6bd5b7fef 100644 --- a/docs/interfaces/models.Tasks.html +++ b/docs/interfaces/models.Tasks.html @@ -21,7 +21,7 @@

    Hierarchy

    • Tasks
    +
  • Defined in packages/api/src/models/Tasks.ts:8
    • @@ -46,52 +46,52 @@

    Properties

    Optional billable

    billable?: boolean
    +
  • Defined in packages/api/src/models/Tasks.ts:10

    • Optional description

    description?: Nullable<string>
    +
  • Defined in packages/api/src/models/Tasks.ts:11

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/Tasks.ts:9

    • Optional name

    name?: Nullable<string>
    +
  • Defined in packages/api/src/models/Tasks.ts:12

    • Optional rate

    rate?: default
    +
  • Defined in packages/api/src/models/Tasks.ts:13

    • Optional taskid

    taskid?: number
    +
  • Defined in packages/api/src/models/Tasks.ts:14

    • Optional tdesc

    tdesc?: Nullable<string>
    +
  • Defined in packages/api/src/models/Tasks.ts:16

    • Optional tname

    tname?: Nullable<string>
    +
  • Defined in packages/api/src/models/Tasks.ts:15

    • Optional updated

    updated?: Date
    +
  • Defined in packages/api/src/models/Tasks.ts:18

    • Optional visState

    visState?: VisState
    +
  • Defined in packages/api/src/models/Tasks.ts:17
    • diff --git a/docs/interfaces/models.TimeEntry.html b/docs/interfaces/models.TimeEntry.html index cbf09bfb4..4ab97c512 100644 --- a/docs/interfaces/models.TimeEntry.html +++ b/docs/interfaces/models.TimeEntry.html @@ -21,7 +21,7 @@

    Hierarchy

    • TimeEntry
    +
  • Defined in packages/api/src/models/TimeEntry.ts:8
    • @@ -56,102 +56,102 @@

    Properties

    Optional active

    active?: boolean
    +
  • Defined in packages/api/src/models/TimeEntry.ts:22

    • Optional billable

    billable?: boolean
    +
  • Defined in packages/api/src/models/TimeEntry.ts:23

    • Optional billed

    billed?: boolean
    +
  • Defined in packages/api/src/models/TimeEntry.ts:24

    • Optional clientId

    clientId?: number
    +
  • Defined in packages/api/src/models/TimeEntry.ts:14

    • Optional createdAt

    createdAt?: Date
    +
  • Defined in packages/api/src/models/TimeEntry.ts:13

    • duration

    duration: number
    +
  • Defined in packages/api/src/models/TimeEntry.ts:27

    • Optional id

    id?: number
    +
  • Defined in packages/api/src/models/TimeEntry.ts:9

    • Optional identityId

    identityId?: number
    +
  • Defined in packages/api/src/models/TimeEntry.ts:10

    • Optional internal

    internal?: boolean
    +
  • Defined in packages/api/src/models/TimeEntry.ts:25

    • isLogged

    isLogged: boolean
    +
  • Defined in packages/api/src/models/TimeEntry.ts:11

    • Optional note

    note?: Nullable<string>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:21

    • Optional pendingClient

    pendingClient?: Nullable<string>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:16

    • Optional pendingProject

    pendingProject?: Nullable<string>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:17

    • Optional pendingTask

    pendingTask?: Nullable<string>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:18

    • Optional projectId

    projectId?: number
    +
  • Defined in packages/api/src/models/TimeEntry.ts:15

    • Optional retainerId

    retainerId?: Nullable<number>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:26

    • Optional serviceId

    serviceId?: Nullable<number>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:20

    • startedAt

    startedAt: Date
    +
  • Defined in packages/api/src/models/TimeEntry.ts:12

    • Optional taskId

    taskId?: Nullable<number>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:19

    • Optional timer

    timer?: Nullable<default>
    +
  • Defined in packages/api/src/models/TimeEntry.ts:28
    • diff --git a/docs/modules/index.html b/docs/modules/index.html index 28ca7d21d..7957e2782 100644 --- a/docs/modules/index.html +++ b/docs/modules/index.html @@ -16,7 +16,7 @@
  • index

    • Module index

    +
  • Defined in packages/api/src/index.ts:1
    • diff --git a/docs/modules/models.html b/docs/modules/models.html index 7f68c8dc7..4830f1af4 100644 --- a/docs/modules/models.html +++ b/docs/modules/models.html @@ -16,7 +16,7 @@
  • models

    • Module models

    +
  • Defined in packages/api/src/models/index.ts:1
    • diff --git a/docs/modules/models_builders.html b/docs/modules/models_builders.html index ab5e756bc..a4c45e658 100644 --- a/docs/modules/models_builders.html +++ b/docs/modules/models_builders.html @@ -16,7 +16,7 @@
  • models/builders

    • Module models/builders

    +
  • Defined in packages/api/src/models/builders/index.ts:2
    • diff --git a/docs/types/models_builders.QueryBuilderType.html b/docs/types/models_builders.QueryBuilderType.html index e342367a2..a7d258aac 100644 --- a/docs/types/models_builders.QueryBuilderType.html +++ b/docs/types/models_builders.QueryBuilderType.html @@ -18,7 +18,7 @@

    Type alias QueryBuilderType

    QueryBuilderType: IncludesQueryBuilder | SearchQueryBuilder | PaginationQueryBuilder | SortQueryBuilder
    +
  • Defined in packages/api/src/models/builders/index.ts:7