Void

API Reference

V1

Invoices

Void an invoice

client.V1.Invoices.Void(ctx, body) (*DataV1InvoiceVoidResponseDataV1InvoiceVoidResponse, error)

post/v1/invoices/void

Void an invoice

Parameters

bodyIDfieldV1InvoiceVoidParams

Hide ParametersShow Parameters

IDfield

param.Field[string]

The invoice id to void

formatuuid

Returns

V1InvoiceVoidResponsestruct

Hide ParametersShow Parameters

DataIDstringV1InvoiceVoidResponseData

optional

Hide ParametersShow Parameters

IDstring

formatuuid

HTTPTypeScriptPythonGoRubyTerraform

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Invoices.Void(context.TODO(), metronome.V1InvoiceVoidParams{
    ID: metronome.F("6a37bb88-8538-48c5-b37b-a41c836328bd"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

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