List Invoices

List Invoices

GET /v1/invoices

List Invoices

cURL

curl --request GET \
  --url https://api.wizcommerce.com/v1/invoices \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://api.wizcommerce.com/v1/invoices"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.wizcommerce.com/v1/invoices', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.wizcommerce.com/v1/invoices",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.wizcommerce.com/v1/invoices"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.wizcommerce.com/v1/invoices")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.wizcommerce.com/v1/invoices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": [
    {
      "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
      "reference_id": "INV-20250101",
      "order_id": "ORD-20250101",
      "invoice_number": "INV-20250101",
      "total_amount": 269.96,
      "paid_amount": 100,
      "status": "PAID",
      "due_date": "2025-01-01T00:00:00Z",
      "remarks": "Remarks",
      "url": "https://example.com/invoice/INV-20250101",
      "created_at": "2025-01-01T00:00:00Z",
      "updated_at": "2025-01-01T00:00:00Z",
      "items": [
        {
          "name": "Item Name",
          "product_id": "1234567890",
          "amount": 1000000,
          "item_total": 1000000,
          "id": "01f5d171-d3e3-4b2b-bd57-0727194b5bed",
          "quantity": 1000000,
          "reference_id": "ITEM-20250101"
        }
      ]
    }
  ],
  "pagination": {
    "total_records": 100,
    "total_pages": 10,
    "current_page": 1,
    "next_page": 2,
    "prev_page": 0,
    "page_size": 10
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "details": [
    {
      "field": "<string>",
      "reason": "<string>"
    }
  ]
}

Authorizations

X-API-Key · string · header · required

API Key for authentication

Query Parameters

page · integer

Required range: x >= 1

reference_ids · string[]

Maximum array length: 255

page_size · integer

Required range: 1 <= x <= 100

sort_by · enum<string>

Available options: created_at, updated_at

sort · enum<string>

Available options: asc, desc

status · enum<string>

Available options: PAID, UNPAID

Response

200

application/json

OK

data · object[]

Show child attributes

pagination · object

Show child attributes