Void an invoice

POST 
https://example.chargeover.com/api/v3/invoice/:invoice_id/_action/void

Voiding an invoice effectively makes the total due/balance zero, and will halt all dunning attempts/payments against this invoice.

Request

application/json

Body

object

Responses

200

Action completed successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": true
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Authorization: http

name: basictype: httpscheme: basic

• php
• nodejs
• python
• curl
• csharp
• go
• ruby
• java
• powershell
• dart
• c
• objective-c
• ocaml
• r
• swift
• kotlin
• rust

• CURL
• GUZZLE
• HTTP_REQUEST2
• PECL_HTTP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://example.chargeover.com/api/v3/invoice/:invoice_id/_action/void',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Accept: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Request Collapse all

Base URL

https://example.chargeover.com

Auth

Username

Password

Body

• Example (from schema)
• Example 1

{}

ResponseClear

Click the Send API Request button above and see the response here!