voidInvoice( )

Voids an invoice.

Description

The voidInvoice() function returns a Promise that resolves when the invoice with the specified ID is voided.

Calling voidInvoice() on a draft invoice causes an error.

Syntax

function voidInvoice(id: IdAndVersion): Promise<void>

voidInvoice Parameters

NAME

TYPE

DESCRIPTION

IdAndVersion

ID and version of the invoice to void.

Returns

Fulfilled - When the specified invoice is voided.

Return Type:

Promise<void>

Was this helpful?

Void invoice

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { invoices } from 'wix-billing-backend';
3
4export const voidInvoice = webMethod(Permissions.Anyone, (id) => {
5  return invoices.getInvoice(id)
6    .then((result) => {
7      return invoices.voidInvoice(result.id);
8    });
9});

Get the invoice version and void the invoice

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { invoices } from 'wix-billing-backend';
3
4export const voidInvoice = webMethod(Permissions.Anyone, (id, version) => {
5  const idAndVersion = {
6    "id": id,
7    "version": version
8  };
9
10  return invoices.getInvoice(id)
11    .then((result) => {
12      return invoices.voidInvoice(idAndVersion);
13    });
14});