PowerShell

Quickbooks Delete an Invoice

See more QuickBooks Examples

Demonstrates how to delete an invoice using the Quickbooks REST API. PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

# First get our previously obtained OAuth2 access token.
$jsonToken = New-Object Chilkat.JsonObject
$success = $jsonToken.LoadFile("qa_data/tokens/qb-access-token.json")

$rest = New-Object Chilkat.Rest

# Connect to the REST server.
$bTls = $true
$port = 443
$bAutoReconnect = $true
$success = $rest.Connect("sandbox-quickbooks.api.intuit.com",$port,$bTls,$bAutoReconnect)

$sbAuth = New-Object Chilkat.StringBuilder
$sbAuth.Append("Bearer ")
$sbAuth.Append($jsonToken.StringOf("access_token"))
$rest.Authorization = $sbAuth.GetAsString()

# --------------------------------------------------------------------------
# Note: The above code to setup the initial REST connection
# can be done once.  After connecting, any number of REST calls can be made.
# If the connection is lost, the next REST method call will automatically
# reconnect if needed.
# --------------------------------------------------------------------------

# Create the following JSON:

# {
#   "SyncToken": "3",
#   "Id": "33"
# }
# 
# Use the this online tool to generate the code from sample JSON: 
# Generate Code to Create JSON

$jsonReq = New-Object Chilkat.JsonObject
$jsonReq.UpdateString("SyncToken","3")
$jsonReq.UpdateString("Id","33")

$sbRequestBody = New-Object Chilkat.StringBuilder
$jsonReq.EmitSb($sbRequestBody)

$rest.AddHeader("Content-Type","application/json")
$rest.AddHeader("Accept","application/json")
$rest.AllowHeaderFolding = $false

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $rest.FullRequestSb("POST","/v3/company/<realmID>/invoice?operation=delete",$sbRequestBody,$sbResponseBody)
if ($success -ne $true) {
    $($rest.LastErrorText)
    exit
}

$respStatusCode = $rest.ResponseStatusCode

# Success is indicated by a 200 response status code.
$("response status code = " + $respStatusCode)

$jsonResponse = New-Object Chilkat.JsonObject
$jsonResponse.LoadSb($sbResponseBody)
$jsonResponse.EmitCompact = $false
$($jsonResponse.Emit())

if ($rest.ResponseStatusCode -ne 200) {
    $("Failed.")
    exit
}

# Sample output...
# (See the parsing code below..)
# 
# Use the this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

# {
#   "Invoice": {
#     "status": "Deleted",
#     "domain": "QBO",
#     "Id": "33"
#   },
#   "time": "2013-03-15T00:18:15.322-07:00"
# }
# 

$InvoiceStatus = $jsonResponse.StringOf("Invoice.status")
$InvoiceDomain = $jsonResponse.StringOf("Invoice.domain")
$InvoiceId = $jsonResponse.StringOf("Invoice.Id")
$time = $jsonResponse.StringOf("time")