Fetch an invoice

GET

ext

invoices

{invoice_id}

Fetch an invoice

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/', 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://connect.vetcove.com/ext/v2/invoices/{invoice_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://connect.vetcove.com/ext/v2/invoices/{invoice_id}/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "amount_paid": 1,
  "clinic_client_id": 123,
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "date_posted": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "discount": 1,
  "finalized_at": "2023-11-07T05:31:56Z",
  "id": 123,
  "is_deleted": true,
  "locked_at": "2023-11-07T05:31:56Z",
  "marked_as_collections_at": "2023-11-07T05:31:56Z",
  "marked_not_rendered_at": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "remaining_balance": 123,
  "status": "IN_PROGRESS",
  "subtotal": 1,
  "tax": 1,
  "total": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

invoice_id

integer

required

The ID of the invoice to fetch

Response

200 - application/json

An invoice represents a bill issued by a clinic to a client (pet parent) for services rendered, products sold, or other charges. Invoices track the total amount, payments made, discounts applied, and remaining balance.

amount_paid

integer

required

The amount paid so far for this invoice

Required range: x >= 0

clinic_client_id

integer

required

The ID of the client this invoice is for

clinic_id

integer

required

The ID of the clinic which issued this invoice

created

string<date-time>

required

The datetime this object was created.

date_posted

string<date-time>

required

The datetime this invoice was posted

deleted

string<date-time> | null

required

The datetime this record was soft deleted.

discount

integer

required

The discount given to the client for this invoice, if any

Required range: x >= 0

finalized_at

string<date-time> | null

required

The datetime at which this invoice was marked as finalized and became due

integer

required

The unique identifier for the invoice

is_deleted

boolean

required

Whether this record is soft deleted or not.

locked_at

string<date-time> | null

required

The datetime at which this invoice was marked as locked

marked_as_collections_at

string<date-time> | null

required

The datetime at which this invoice was marked as collections (a.k.a. written off)

marked_not_rendered_at

string<date-time> | null

required

The datetime at which this invoice was marked as not-rendered

modified

string<date-time>

required

The datetime this object was last modified; changes to related entities will not update this field.

remaining_balance

integer

required

The remaining balance for this invoice

status

required

The status of the invoice

Available options:

IN_PROGRESS,

READY_FOR_PAYMENT,

FINALIZED,

LOCKED,

IMPORTED

subtotal

integer

required

The subtotal due for this invoice

Required range: x >= 0

tax

integer

required

The amount of tax charged to the client for this invoice

Required range: x >= 0

total

integer

required

The total amount billed to the client for this invoice

⌘I

Fetch an invoice

curl --request GET \
  --url https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/ \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/', 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://connect.vetcove.com/ext/v2/invoices/{invoice_id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://connect.vetcove.com/ext/v2/invoices/{invoice_id}/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "amount_paid": 1,
  "clinic_client_id": 123,
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "date_posted": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "discount": 1,
  "finalized_at": "2023-11-07T05:31:56Z",
  "id": 123,
  "is_deleted": true,
  "locked_at": "2023-11-07T05:31:56Z",
  "marked_as_collections_at": "2023-11-07T05:31:56Z",
  "marked_not_rendered_at": "2023-11-07T05:31:56Z",
  "modified": "2023-11-07T05:31:56Z",
  "remaining_balance": 123,
  "status": "IN_PROGRESS",
  "subtotal": 1,
  "tax": 1,
  "total": 123
}

Using the API

Developer guides

Accounts

Care plans

Catalog

Checkout links

Clients & patients

Clinics

External Rx

Insurance

Inbox

Invoices

Labs

Onboardings

Orders

Payments

PDFs

Prescriptions

Scheduler

Service pricing

Standard care

Subscriptions

File uploads

Inventory

Forms

Medical records

Authorizations

Path Parameters

Response