@timesheet/sdk/dist/models/Document.d.ts

Official TypeScript SDK for the Timesheet API

import type { ListParams } from './common';
import type { Task } from './Task';
import type { Expense } from './Expense';
import type { Note } from './Note';
import type { Organization } from './Organization';
export interface Document {
    id: string;
    user?: string;
    deleted?: boolean;
    lastUpdate?: number;
    created?: number;
    organization?: Organization;
    organizationId?: string;
    category?: number;
    name?: string;
    date?: string;
    invoiceId?: string;
    invoiceSeriesId?: string;
    headline?: string;
    description?: string;
    terms?: string;
    signature?: string;
    image?: string;
    company?: string;
    companyDescription?: string;
    companyAddressLine1?: string;
    companyAddressLine2?: string;
    companyAddressLine3?: string;
    companyAddressLine4?: string;
    customer?: string;
    customerId?: string;
    customerAddressLine1?: string;
    customerAddressLine2?: string;
    customerAddressLine3?: string;
    customerAddressLine4?: string;
    taskSubtotal?: string;
    expenseSubtotal?: string;
    subtotal?: string;
    tax?: string;
    taxValue?: string;
    taxSecond?: string;
    taxSecondValue?: string;
    discount?: string;
    discountValue?: string;
    discountSecondValue?: string;
    total?: string;
    duration?: number;
    showQrCode?: boolean;
    qrCodeType?: string;
    qrCodeContent?: string;
    qrCodeDescription?: string;
    payment?: string;
    paymentDate?: string;
    paymentMethod?: string;
    paid?: boolean;
    approved?: boolean;
    fullyPaid?: boolean;
    partiallyPaid?: boolean;
    templateId?: string;
    templateName?: string;
    template?: boolean;
    saveAsTemplate?: boolean;
    refreshTemplate?: boolean;
    includeExpenses?: boolean;
    includeNotes?: boolean;
    useRelatives?: boolean;
    hideTaxes?: boolean;
    hideSummation?: boolean;
    showSecondTax?: boolean;
    showDiscount?: boolean;
    showDiscountSecond?: boolean;
    showMemberName?: boolean;
    showProjectTitle?: boolean;
    showTags?: boolean;
    hideTaskTime?: boolean;
    hideRate?: boolean;
    hideExpenseDateTime?: boolean;
    fieldTitle?: string;
    fieldItem?: string;
    fieldDescription?: string;
    fieldRate?: string;
    fieldQuantity?: string;
    fieldTotal?: string;
    fieldTotalSum?: string;
    fieldSubTotal?: string;
    fieldTax?: string;
    fieldSecondTax?: string;
    fieldDiscount?: string;
    fieldDiscountSecond?: string;
    fieldExpenseTitle?: string;
    fieldExpenseTotal?: string;
    tasks?: Task[];
    expenses?: Expense[];
    notes?: Note[];
    status?: number;
    invoiceTypeCode?: string;
    companyVatId?: string;
    companyTaxNumber?: string;
    companyRegistrationNumber?: string;
    companyBankAccount?: string;
    companyBankBIC?: string;
    customerVatId?: string;
    customerTaxNumber?: string;
    customerOrderNumber?: string;
    taxExemptionReason?: string;
    reverseChargeRate?: string;
    isReverseCharge?: boolean;
    cashDiscountRate?: string;
    cashDiscountDays?: number;
    paymentTermDays?: number;
    deliveryDate?: string;
    dueDate?: string;
    paymentReference?: string;
    orderReference?: string;
    projectReference?: string;
    costCenter?: string;
    isGovernmentInvoice?: boolean;
    procurementReference?: string;
    contractReference?: string;
    originalInvoiceNumber?: string;
    originalInvoiceDate?: string;
    invoice?: boolean;
    timesheet?: boolean;
    workRecord?: boolean;
    eInvoiceType?: string;
    eInvoiceCurrency?: string;
    eInvoiceDocumentType?: string;
}
export interface DocumentList {
    items: Document[];
    params: DocumentListParams;
}
export interface DocumentCreateRequest {
    organizationId?: string;
    category?: number;
    name?: string;
    date?: string;
    invoiceId?: string;
    invoiceSeriesId?: string;
    headline?: string;
    description?: string;
    terms?: string;
    signature?: string;
    image?: string;
    company?: string;
    companyDescription?: string;
    companyAddressLine1?: string;
    companyAddressLine2?: string;
    companyAddressLine3?: string;
    companyAddressLine4?: string;
    customer?: string;
    customerId?: string;
    customerAddressLine1?: string;
    customerAddressLine2?: string;
    customerAddressLine3?: string;
    customerAddressLine4?: string;
    taskSubtotal?: string;
    expenseSubtotal?: string;
    subtotal?: string;
    tax?: string;
    taxValue?: string;
    taxSecond?: string;
    taxSecondValue?: string;
    discount?: string;
    discountValue?: string;
    discountSecondValue?: string;
    total?: string;
    duration?: number;
    showQrCode?: boolean;
    qrCodeType?: string;
    qrCodeContent?: string;
    qrCodeDescription?: string;
    payment?: string;
    paymentDate?: string;
    paymentMethod?: string;
    paid?: boolean;
    approved?: boolean;
    templateId?: string;
    templateName?: string;
    template?: boolean;
    saveAsTemplate?: boolean;
    refreshTemplate?: boolean;
    includeExpenses?: boolean;
    includeNotes?: boolean;
    useRelatives?: boolean;
    hideTaxes?: boolean;
    hideSummation?: boolean;
    showSecondTax?: boolean;
    showDiscount?: boolean;
    showDiscountSecond?: boolean;
    showMemberName?: boolean;
    showProjectTitle?: boolean;
    showTags?: boolean;
    hideTaskTime?: boolean;
    hideRate?: boolean;
    hideExpenseDateTime?: boolean;
    fieldTitle?: string;
    fieldItem?: string;
    fieldDescription?: string;
    fieldRate?: string;
    fieldQuantity?: string;
    fieldTotal?: string;
    fieldTotalSum?: string;
    fieldSubTotal?: string;
    fieldTax?: string;
    fieldSecondTax?: string;
    fieldDiscount?: string;
    fieldDiscountSecond?: string;
    fieldExpenseTitle?: string;
    fieldExpenseTotal?: string;
    taskIds?: string[];
    expenseIds?: string[];
    noteIds?: string[];
    invoiceTypeCode?: string;
    companyVatId?: string;
    companyTaxNumber?: string;
    companyRegistrationNumber?: string;
    companyBankAccount?: string;
    companyBankBIC?: string;
    customerVatId?: string;
    customerTaxNumber?: string;
    customerOrderNumber?: string;
    taxExemptionReason?: string;
    reverseChargeRate?: string;
    isReverseCharge?: boolean;
    cashDiscountRate?: string;
    cashDiscountDays?: number;
    paymentTermDays?: number;
    deliveryDate?: string;
    dueDate?: string;
    paymentReference?: string;
    orderReference?: string;
    projectReference?: string;
    costCenter?: string;
    isGovernmentInvoice?: boolean;
    procurementReference?: string;
    contractReference?: string;
    originalInvoiceNumber?: string;
    originalInvoiceDate?: string;
    eInvoiceType?: string;
    eInvoiceCurrency?: string;
    eInvoiceDocumentType?: string;
}
export interface DocumentUpdateRequest {
    deleted?: boolean;
    category?: number;
    name?: string;
    date?: string;
    invoiceId?: string;
    invoiceSeriesId?: string;
    headline?: string;
    description?: string;
    terms?: string;
    signature?: string;
    image?: string;
    company?: string;
    companyDescription?: string;
    companyAddressLine1?: string;
    companyAddressLine2?: string;
    companyAddressLine3?: string;
    companyAddressLine4?: string;
    customer?: string;
    customerId?: string;
    customerAddressLine1?: string;
    customerAddressLine2?: string;
    customerAddressLine3?: string;
    customerAddressLine4?: string;
    taskSubtotal?: string;
    expenseSubtotal?: string;
    subtotal?: string;
    tax?: string;
    taxValue?: string;
    taxSecond?: string;
    taxSecondValue?: string;
    discount?: string;
    discountValue?: string;
    discountSecondValue?: string;
    total?: string;
    duration?: number;
    showQrCode?: boolean;
    qrCodeType?: string;
    qrCodeContent?: string;
    qrCodeDescription?: string;
    payment?: string;
    paymentDate?: string;
    paymentMethod?: string;
    paid?: boolean;
    approved?: boolean;
    templateId?: string;
    templateName?: string;
    template?: boolean;
    saveAsTemplate?: boolean;
    refreshTemplate?: boolean;
    includeExpenses?: boolean;
    includeNotes?: boolean;
    useRelatives?: boolean;
    hideTaxes?: boolean;
    hideSummation?: boolean;
    showSecondTax?: boolean;
    showDiscount?: boolean;
    showDiscountSecond?: boolean;
    showMemberName?: boolean;
    showProjectTitle?: boolean;
    showTags?: boolean;
    hideTaskTime?: boolean;
    hideRate?: boolean;
    hideExpenseDateTime?: boolean;
    fieldTitle?: string;
    fieldItem?: string;
    fieldDescription?: string;
    fieldRate?: string;
    fieldQuantity?: string;
    fieldTotal?: string;
    fieldTotalSum?: string;
    fieldSubTotal?: string;
    fieldTax?: string;
    fieldSecondTax?: string;
    fieldDiscount?: string;
    fieldDiscountSecond?: string;
    fieldExpenseTitle?: string;
    fieldExpenseTotal?: string;
    taskIds?: string[];
    expenseIds?: string[];
    noteIds?: string[];
    invoiceTypeCode?: string;
    companyVatId?: string;
    companyTaxNumber?: string;
    companyRegistrationNumber?: string;
    companyBankAccount?: string;
    companyBankBIC?: string;
    customerVatId?: string;
    customerTaxNumber?: string;
    customerOrderNumber?: string;
    taxExemptionReason?: string;
    reverseChargeRate?: string;
    isReverseCharge?: boolean;
    cashDiscountRate?: string;
    cashDiscountDays?: number;
    paymentTermDays?: number;
    deliveryDate?: string;
    dueDate?: string;
    paymentReference?: string;
    orderReference?: string;
    projectReference?: string;
    costCenter?: string;
    isGovernmentInvoice?: boolean;
    procurementReference?: string;
    contractReference?: string;
    originalInvoiceNumber?: string;
    originalInvoiceDate?: string;
    eInvoiceType?: string;
    eInvoiceCurrency?: string;
    eInvoiceDocumentType?: string;
}
export interface DocumentPrint {
    id: string;
    zugferd?: boolean;
}
export interface DocumentListParams extends ListParams {
    organizationId?: string;
    organizationUnassigned?: boolean;
    category?: number;
    type?: number;
    status?: string;
    template?: boolean;
    empty?: boolean;
}
//# sourceMappingURL=Document.d.ts.map