Skip to main content
GET
/
v1
/
invoices
/
view
/
{number}
Get invoice by number
curl --request GET \
  --url https://api.platnova.com/v1/invoices/view/{number} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.platnova.com/v1/invoices/view/{number}"

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.platnova.com/v1/invoices/view/{number}', 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.platnova.com/v1/invoices/view/{number}",
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.platnova.com/v1/invoices/view/{number}"

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.platnova.com/v1/invoices/view/{number}")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.platnova.com/v1/invoices/view/{number}")

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
{
  "status": true,
  "data": {
    "id": "<string>",
    "invoice_number": "<string>",
    "items": "<array>",
    "subtotal": "<string>",
    "total": "<string>",
    "charges": {},
    "note": "<string>",
    "payment_schedule": {},
    "payment_details": {
      "account_name": "<string>",
      "account_number": "<string>",
      "bank_name": "<string>",
      "currency": "<string>",
      "swift_code": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z"
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}
{
"status": true,
"data": {},
"error": [
"<unknown>"
],
"message": "<string>"
}

Overview

Retrieve invoice details by invoice number. This endpoint can be used by customers to view their invoices or by your system to retrieve invoice information.

Authorizations

X-API-KEY
string
header
required

API key for authentication.

Path Parameters

number
string
required

Invoice number (e.g. INVxxxxxxxxxx)

Response

Invoice retrieved successfully

status
boolean
data
object
error
any[]
message
string