Type alias CreateInvoicePayload

CreateInvoicePayload: {
    clientId: string;
    currency: string;
    date: string;
    deliveryOptions: DeliveryOptions;
    discountType?: CreateInvoicePayload.discountType;
    discountValue?: number;
    dueDate?: string;
    lineItems: LineItem[];
    prefix?: string;
    status?: string;
}

Type declaration

  • clientId: string

    Client against whom the invoice needs to be generated

  • currency: string

    Valid ISO 4217 currency code for the invoice

  • date: string

    The date of the invoice

  • deliveryOptions: DeliveryOptions

    Options to send the invoice to the customer

  • Optional discountType?: CreateInvoicePayload.discountType

    Type of discount to apply to the invoice

  • Optional discountValue?: number

    Value of the discount. For percentage type: 1-100, for flat type: positive number

  • Optional dueDate?: string

    Date that the payment of this invoice is due

  • lineItems: LineItem[]

    The line items of the invoice

  • Optional prefix?: string

    Custom prefix for this invoice. All invoices for a pefix series are guaranteed to have separate counters

  • Optional status?: string

    The status of the invoice