Interface KitsasBookInterface

Interface representing an accounting of the organization.

You get KitsasBookInterface from KitsasOfficeInterface.getBooks

interface KitsasBookInterface {
    getAccounts(): Promise<Account[]>;
    getBookId(): string;
    getConnection(): KitsasConnectionInterface;
    getDimensions(): Promise<Dimension[]>;
    getFiscalYears(): Promise<FiscalYear[]>;
    getProducts(): Promise<Product[]>;
    getSettings(): Promise<Record<string, string>>;
    saveInvoice(invoice: InvoiceDto, attachments: AttachmentDto[]): Promise<CreateInvoiceResponseDto>;
    saveTransactions(iban: string, startDate: Date, endDate: Date, entries: TransactionEntryDto[], original?: object, attachments?: AttachmentDto[]): Promise<CreateVoucherResponseDto>;
    saveVoucher(voucher: CreateVoucherDto, attachments: AttachmentDto[]): Promise<CreateVoucherResponseDto>;
}

Index

Methods

getAccounts getBookId getConnection getDimensions getFiscalYears getProducts getSettings saveInvoice saveTransactions saveVoucher

Methods

getAccounts

getAccounts(): Promise<Account[]>
Get the accounting accounts.

Returns Promise<Account[]>
A promise that resolves to an array of Account objects.
- Defined in src/interfaces/kitsasbook.interface.ts:36

getBookId

getBookId(): string
Get the book ID.

Returns string
The book ID as a string.
- Defined in src/interfaces/kitsasbook.interface.ts:30

getConnection

getConnection(): KitsasConnectionInterface
Get the connection.

Returns KitsasConnectionInterface
- Defined in src/interfaces/kitsasbook.interface.ts:24

getDimensions

getDimensions(): Promise<Dimension[]>
Get the dimensions.

Returns Promise<Dimension[]>
A promise that resolves to an array of Dimension objects.
- Defined in src/interfaces/kitsasbook.interface.ts:42

getFiscalYears

getFiscalYears(): Promise<FiscalYear[]>
Get the fiscal years.

Returns Promise<FiscalYear[]>
A promise that resolves to an array of FiscalYear objects.
- Defined in src/interfaces/kitsasbook.interface.ts:48

getProducts

getProducts(): Promise<Product[]>
Get the products.

Returns Promise<Product[]>
A promise that resolves to an array of Product objects.
- Defined in src/interfaces/kitsasbook.interface.ts:95

getSettings

getSettings(): Promise<Record<string, string>>
Get the settings.

Returns Promise<Record<string, string>>
- Defined in src/interfaces/kitsasbook.interface.ts:100

saveInvoice

saveInvoice(invoice, attachments): Promise<CreateInvoiceResponseDto>
Save an invoice.
Parameters
- invoice: InvoiceDto
  The invoice to save.
- attachments: AttachmentDto[]
  The attachments associated with the invoice.
Returns Promise<CreateInvoiceResponseDto>
A promise that resolves to a CreateInvoiceResponseDto object.
- Defined in src/interfaces/kitsasbook.interface.ts:67

saveTransactions

saveTransactions(iban, startDate, endDate, entries, original?, attachments?): Promise<CreateVoucherResponseDto>
Save transactions.
Parameters
- iban: string
  The IBAN of the bank account.
- startDate: Date
  The start date of the transactions.
- endDate: Date
  The end date of the transactions.
- entries: TransactionEntryDto[]
  The transaction entries.
- Optionaloriginal: object
  The original object.
- Optionalattachments: AttachmentDto[]
  The attachments associated with the transactions.
Returns Promise<CreateVoucherResponseDto>
A promise that resolves to a CreateVoucherResponseDto object.
- Defined in src/interfaces/kitsasbook.interface.ts:82

saveVoucher

saveVoucher(voucher, attachments): Promise<CreateVoucherResponseDto>
Save a voucher.
Parameters
- voucher: CreateVoucherDto
  The voucher to save.
- attachments: AttachmentDto[]
  The attachments associated with the voucher.
Returns Promise<CreateVoucherResponseDto>
A promise that resolves to a CreateVoucherResponseDto object.
- Defined in src/interfaces/kitsasbook.interface.ts:56

Interface KitsasBookInterface

Index

Methods

Methods

getAccounts

Returns Promise<Account[]>

getBookId

Returns string

getConnection

Returns KitsasConnectionInterface

getDimensions

Returns Promise<Dimension[]>

getFiscalYears

Returns Promise<FiscalYear[]>

getProducts

Returns Promise<Product[]>

getSettings

Returns Promise<Record<string, string>>

saveInvoice

Parameters

Returns Promise<CreateInvoiceResponseDto>

saveTransactions

Parameters

Returns Promise<CreateVoucherResponseDto>

saveVoucher

Parameters

Returns Promise<CreateVoucherResponseDto>

Settings

On This Page