Void

API Reference

V1

Invoices

Void an invoice

client.v1.invoices.void(InvoiceVoidParamsbody, RequestOptionsoptions?): dataDataInvoiceVoidResponse

post/v1/invoices/void

Void an invoice

Parameters

bodyidstringInvoiceVoidParams

Hide ParametersShow Parameters

idstring

The invoice id to void

formatuuid

Returns

InvoiceVoidResponse

Hide ParametersShow Parameters

dataidstringData

optional

Hide ParametersShow Parameters

idstring

formatuuid

HTTPTypeScriptPythonGoRubyTerraform

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.invoices.void({ id: '6a37bb88-8538-48c5-b37b-a41c836328bd' });

console.log(response.data);

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  }
}