kiotviet-client-sdk - v0.3.4
    Preparing search index...

    Class InvoiceHandler

    Index

    Constructors

    constructor

    Methods

    cancel create delete getByCode getByCustomer getByDateRange getById getByOrder list update

    Constructors

    Methods

    • Cancel an invoice

      Parameters

      • invoiceId: number

        The ID of the invoice to cancel

      • Optionalreason: string

        Optional cancellation reason

      Returns Promise<Invoice>

    • Create a new invoice

      Parameters

      • invoiceData: InvoiceCreateParams

        The invoice data to create

      Returns Promise<Invoice>

    • Delete/void an invoice

      Parameters

      • invoiceId: number

        The ID of the invoice to delete

      • isVoidPayment: boolean = false

        Whether to void the associated payment

      Returns Promise<void>

    • Get an invoice by its code

      Parameters

      • code: string

        The code of the invoice to retrieve

      Returns Promise<Invoice>

    • Get invoices by customer

      Parameters

      • customerIdentifier: string

        Customer's phone number or code

      • params: Omit<InvoiceListParams, "customerCode" | "customerPhone"> = {}

        Additional filter parameters

      Returns Promise<InvoiceListResponse>

    • Get invoices by date range

      Parameters

      • fromDate: string

        Start date (YYYY-MM-DD)

      • toDate: string

        End date (YYYY-MM-DD)

      • params: Omit<InvoiceListParams, "fromPurchaseDate" | "toPurchaseDate"> = {}

        Additional filter parameters

      Returns Promise<InvoiceListResponse>

    • Get an invoice by its ID

      Parameters

      • invoiceId: number

        The ID of the invoice to retrieve

      Returns Promise<Invoice>

    • Get invoices by order

      Parameters

      • orderId: number

        The ID of the order

      • params: Omit<InvoiceListParams, "orderId"> = {}

        Additional filter parameters

      Returns Promise<InvoiceListResponse>

    • List invoices with optional filtering

      Parameters

      • params: InvoiceListParams = {}

        Filter parameters

      Returns Promise<InvoiceListResponse>

    • Update an existing invoice

      Parameters

      • invoiceId: number

        The ID of the invoice to update

      • invoiceData: Partial<InvoiceUpdateParams>

        The invoice data to update

      Returns Promise<Invoice>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods