Type alias Invoice

Invoice: {
    client: Record<string, any>;
    clientId: string;
    company: Record<string, any>;
    companyId: string;
    createdAt: string;
    currency: string;
    date: string;
    discountType: Invoice.discountType;
    discountValue: number;
    dueDate: string;
    financialYear: string;
    id: string;
    lineItems: InvoiceLineItem[];
    number: number;
    paymentStatus: paymentStatus;
    payments: Payment[];
    prefix: string;
    status: string;
}

Type declaration

  • client: Record<string, any>

    Client to whom the invoice is raised

  • clientId: string

    ID of the client the invoice is raised against

  • company: Record<string, any>

    The company from which this invoice was raised

  • companyId: string

    ID of the company the invoice belongs to

  • createdAt: string

    Timestamp of invoice creation

  • currency: string

    Currency of the invoice

  • date: string

    Date of the invoice

  • discountType: Invoice.discountType

    The treatment of discount value. Either flat rate or percentage

  • discountValue: number

    The value of the discount

  • dueDate: string

    Date on which this invoice must be paid, beyond which it becomes overdue

  • financialYear: string

    The financial year this invoice belongs to

  • id: string

    ID of the created invoice

  • lineItems: InvoiceLineItem[]

    Line items of this invoice

  • number: number

    Invoice number

  • paymentStatus: paymentStatus

    The payment status of the invoice

  • payments: Payment[]

    The payments made against this invoice

  • prefix: string

    Prefix of the invoice series

  • status: string

    The current status of the invoice