Billing App APIs
Invoice Actions
Cancel invoice (general)
1 min
code examples curl location globoff 'https //{tenant id} {stack base domain}/tms/api/v1/billing/transporter/cancel invoice' \\ \ header 'accept application/json' \\ \ header 'content type application/json' \\ \ data '{ "invoiceid" "inv 20241201 001", "cancellationreason" "customer requested cancellation" }'var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("content type", "application/json"); var raw = json stringify({ "invoiceid" "inv 20241201 001", "cancellationreason" "customer requested cancellation" }); var requestoptions = { method 'post', headers myheaders, body raw, redirect 'follow' }; fetch("https //{tenant id} {stack base domain}/tms/api/v1/billing/transporter/cancel invoice", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));require "uri" require "json" require "net/http" url = uri("https //{tenant id} {stack base domain}/tms/api/v1/billing/transporter/cancel invoice") https = net http new(url host, url port) https use ssl = true request = net http post new(url) request\["accept"] = "application/json" request\["content type"] = "application/json" request body = json dump({ "invoiceid" "inv 20241201 001", "cancellationreason" "customer requested cancellation" }) response = https request(request) puts response read body import requests import json url = "https //{tenant id} {stack base domain}/tms/api/v1/billing/transporter/cancel invoice" payload = json dumps({ "invoiceid" "inv 20241201 001", "cancellationreason" "customer requested cancellation" }) headers = { 'accept' 'application/json', 'content type' 'application/json' } response = requests request("post", url, headers=headers, data=payload) print(response text) responses // invoice cancelled successfully { "data" { "success" true, "message" "invoice cancelled successfully", "invoiceid" "inv 20241201 001" }, "message" "success", "status" "success" }// bad request invalid invoice data { "message" "invalid charge id provided", "status" "error", "errorcode" "invalid charge id" }// unauthorized invalid authentication { "message" "invalid charge id provided", "status" "error", "errorcode" "invalid charge id" }// forbidden cannot cancel this invoice { "message" "invalid charge id provided", "status" "error", "errorcode" "invalid charge id" }// invoice not found { "message" "invalid charge id provided", "status" "error", "errorcode" "invalid charge id" }// internal server error { "message" "invalid charge id provided", "status" "error", "errorcode" "invalid charge id" }
