Purchase orders

Create a purchase order

This endpoint is available to Group API Keys only.

Creates a new purchase order in draft status with the specified line items. The quantities specified in the line items are expected to be in the same unit of measure as the configured unit of measure for the inventory code.

A purchase order tracks an order placed by a clinic to a supplier for inventory items. Each purchase order contains one or more line items identifying the inventory being ordered, the quantity, and the price. Purchase orders are created in draft status and can later be finalized in the pims web ui.

POST

ext

purchase-orders

Create a purchase order

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/purchase-orders/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clinic_id": 123,
  "order_datetime": "2023-11-07T05:31:56Z",
  "purchase_order_items": [
    {
      "quantity": 1,
      "inventory_id": 1,
      "inventory_shortcode": "<string>",
      "sku": "",
      "total_price": 0
    }
  ],
  "supplier": "<string>",
  "po_number": "<string>"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/purchase-orders/"

payload = {
    "clinic_id": 123,
    "order_datetime": "2023-11-07T05:31:56Z",
    "purchase_order_items": [
        {
            "quantity": 1,
            "inventory_id": 1,
            "inventory_shortcode": "<string>",
            "sku": "",
            "total_price": 0
        }
    ],
    "supplier": "<string>",
    "po_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clinic_id: 123,
    order_datetime: '2023-11-07T05:31:56Z',
    purchase_order_items: [
      {
        quantity: 1,
        inventory_id: 1,
        inventory_shortcode: '<string>',
        sku: '',
        total_price: 0
      }
    ],
    supplier: '<string>',
    po_number: '<string>'
  })
};

fetch('https://connect.vetcove.com/ext/v2/purchase-orders/', 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/purchase-orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clinic_id' => 123,
    'order_datetime' => '2023-11-07T05:31:56Z',
    'purchase_order_items' => [
        [
                'quantity' => 1,
                'inventory_id' => 1,
                'inventory_shortcode' => '<string>',
                'sku' => '',
                'total_price' => 0
        ]
    ],
    'supplier' => '<string>',
    'po_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://connect.vetcove.com/ext/v2/purchase-orders/"

	payload := strings.NewReader("{\n  \"clinic_id\": 123,\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"purchase_order_items\": [\n    {\n      \"quantity\": 1,\n      \"inventory_id\": 1,\n      \"inventory_shortcode\": \"<string>\",\n      \"sku\": \"\",\n      \"total_price\": 0\n    }\n  ],\n  \"supplier\": \"<string>\",\n  \"po_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://connect.vetcove.com/ext/v2/purchase-orders/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clinic_id\": 123,\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"purchase_order_items\": [\n    {\n      \"quantity\": 1,\n      \"inventory_id\": 1,\n      \"inventory_shortcode\": \"<string>\",\n      \"sku\": \"\",\n      \"total_price\": 0\n    }\n  ],\n  \"supplier\": \"<string>\",\n  \"po_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/purchase-orders/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clinic_id\": 123,\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"purchase_order_items\": [\n    {\n      \"quantity\": 1,\n      \"inventory_id\": 1,\n      \"inventory_shortcode\": \"<string>\",\n      \"sku\": \"\",\n      \"total_price\": 0\n    }\n  ],\n  \"supplier\": \"<string>\",\n  \"po_number\": \"<string>\"\n}"

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

{
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "effective_total": 123,
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "order_datetime": "2023-11-07T05:31:56Z",
  "po_number": "<string>",
  "purchase_order_items": [
    {
      "created": "2023-11-07T05:31:56Z",
      "id": 123,
      "inventory_id": 123,
      "modified": "2023-11-07T05:31:56Z",
      "quantity": 123,
      "sku": "<string>",
      "total_price": 123,
      "unit_of_measure": "<string>",
      "inventory_shortcode": ""
    }
  ],
  "raw_total": 123,
  "status": "DRAFT",
  "supplier": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

clinic_id

integer

required

The ID of the clinic this purchase order belongs to

order_datetime

string<date-time>

required

The datetime when the order was placed

purchase_order_items

PurchaseOrderItemCreateSchema · object[]

required

The line items to include in the purchase order

Minimum array length: 1

Show child attributes

supplier

string

required

The name of the supplier for this order

po_number

string | null

An optional purchase order number. If omitted, one is auto-generated.

Response

201 - application/json

Created

clinic_id

integer

required

The ID of the clinic this purchase order belongs to

created

string<date-time>

required

The datetime this object was created.

effective_total

integer

required

The effective total of the order, in cents

integer

required

The unique identifier for the purchase order

modified

string<date-time>

required

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

order_datetime

string<date-time>

required

The datetime when the order was placed

po_number

string

required

The purchase order number

purchase_order_items

ExternalPurchaseOrderItemSchema · object[]

required

The line items included in this purchase order

Show child attributes

raw_total

integer

required

The raw total of the order, in cents

status

enum<string>

required

The current status of the purchase order

Available options:

DRAFT,

PENDING,

PARTIALLY_RECEIVED,

FULLY_RECEIVED,

CANCELED,

RETURNED,

CLOSED

supplier

string

required

The name of the supplier for this order

⌘I

Create a purchase order

curl --request POST \
  --url https://connect.vetcove.com/ext/v2/purchase-orders/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clinic_id": 123,
  "order_datetime": "2023-11-07T05:31:56Z",
  "purchase_order_items": [
    {
      "quantity": 1,
      "inventory_id": 1,
      "inventory_shortcode": "<string>",
      "sku": "",
      "total_price": 0
    }
  ],
  "supplier": "<string>",
  "po_number": "<string>"
}
'

import requests

url = "https://connect.vetcove.com/ext/v2/purchase-orders/"

payload = {
    "clinic_id": 123,
    "order_datetime": "2023-11-07T05:31:56Z",
    "purchase_order_items": [
        {
            "quantity": 1,
            "inventory_id": 1,
            "inventory_shortcode": "<string>",
            "sku": "",
            "total_price": 0
        }
    ],
    "supplier": "<string>",
    "po_number": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    clinic_id: 123,
    order_datetime: '2023-11-07T05:31:56Z',
    purchase_order_items: [
      {
        quantity: 1,
        inventory_id: 1,
        inventory_shortcode: '<string>',
        sku: '',
        total_price: 0
      }
    ],
    supplier: '<string>',
    po_number: '<string>'
  })
};

fetch('https://connect.vetcove.com/ext/v2/purchase-orders/', 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/purchase-orders/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'clinic_id' => 123,
    'order_datetime' => '2023-11-07T05:31:56Z',
    'purchase_order_items' => [
        [
                'quantity' => 1,
                'inventory_id' => 1,
                'inventory_shortcode' => '<string>',
                'sku' => '',
                'total_price' => 0
        ]
    ],
    'supplier' => '<string>',
    'po_number' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://connect.vetcove.com/ext/v2/purchase-orders/"

	payload := strings.NewReader("{\n  \"clinic_id\": 123,\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"purchase_order_items\": [\n    {\n      \"quantity\": 1,\n      \"inventory_id\": 1,\n      \"inventory_shortcode\": \"<string>\",\n      \"sku\": \"\",\n      \"total_price\": 0\n    }\n  ],\n  \"supplier\": \"<string>\",\n  \"po_number\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://connect.vetcove.com/ext/v2/purchase-orders/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"clinic_id\": 123,\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"purchase_order_items\": [\n    {\n      \"quantity\": 1,\n      \"inventory_id\": 1,\n      \"inventory_shortcode\": \"<string>\",\n      \"sku\": \"\",\n      \"total_price\": 0\n    }\n  ],\n  \"supplier\": \"<string>\",\n  \"po_number\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://connect.vetcove.com/ext/v2/purchase-orders/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"clinic_id\": 123,\n  \"order_datetime\": \"2023-11-07T05:31:56Z\",\n  \"purchase_order_items\": [\n    {\n      \"quantity\": 1,\n      \"inventory_id\": 1,\n      \"inventory_shortcode\": \"<string>\",\n      \"sku\": \"\",\n      \"total_price\": 0\n    }\n  ],\n  \"supplier\": \"<string>\",\n  \"po_number\": \"<string>\"\n}"

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

{
  "clinic_id": 123,
  "created": "2023-11-07T05:31:56Z",
  "effective_total": 123,
  "id": 123,
  "modified": "2023-11-07T05:31:56Z",
  "order_datetime": "2023-11-07T05:31:56Z",
  "po_number": "<string>",
  "purchase_order_items": [
    {
      "created": "2023-11-07T05:31:56Z",
      "id": 123,
      "inventory_id": 123,
      "modified": "2023-11-07T05:31:56Z",
      "quantity": 123,
      "sku": "<string>",
      "total_price": 123,
      "unit_of_measure": "<string>",
      "inventory_shortcode": ""
    }
  ],
  "raw_total": 123,
  "status": "DRAFT",
  "supplier": "<string>"
}

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

Create a purchase order

Authorizations

Body

Response