Invoices
Accept Invoices
POST
/
api
/
v1
/
invoices
Accept Invoices
curl --request POST \
--url https://webhooks.nest.vet/api/v1/invoices \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"invoices": [
{
"invoice_id": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"subtotal": 123,
"tax": 123,
"clinic_id": "<string>",
"client_id": "<string>",
"invoice_code": "<string>",
"due_date": "2023-11-07T05:31:56Z",
"last_modified": "2023-11-07T05:31:56Z",
"deleted": false,
"team_member_id": "<string>",
"invoice_lines": [
{
"invoice_line_id": "<string>",
"date": "2023-11-07T05:31:56Z",
"product_name": "<string>",
"product_id": "<string>",
"product_code": "<string>",
"quantity": 123,
"total": 123,
"total_tax": 123,
"standard_price": 123,
"invoice_line_code": "<string>",
"last_modified": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"team_member_id": "<string>",
"is_payment": false,
"deleted": false,
"finalized": true,
"voided": false,
"voided_at": "2023-11-07T05:31:56Z",
"tip": 0
}
]
}
]
}
'import requests
url = "https://webhooks.nest.vet/api/v1/invoices"
payload = { "invoices": [
{
"invoice_id": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"subtotal": 123,
"tax": 123,
"clinic_id": "<string>",
"client_id": "<string>",
"invoice_code": "<string>",
"due_date": "2023-11-07T05:31:56Z",
"last_modified": "2023-11-07T05:31:56Z",
"deleted": False,
"team_member_id": "<string>",
"invoice_lines": [
{
"invoice_line_id": "<string>",
"date": "2023-11-07T05:31:56Z",
"product_name": "<string>",
"product_id": "<string>",
"product_code": "<string>",
"quantity": 123,
"total": 123,
"total_tax": 123,
"standard_price": 123,
"invoice_line_code": "<string>",
"last_modified": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"team_member_id": "<string>",
"is_payment": False,
"deleted": False,
"finalized": True,
"voided": False,
"voided_at": "2023-11-07T05:31:56Z",
"tip": 0
}
]
}
] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Organization-Id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Organization-Id': '<x-organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
invoices: [
{
invoice_id: '<string>',
created_date: '2023-11-07T05:31:56Z',
subtotal: 123,
tax: 123,
clinic_id: '<string>',
client_id: '<string>',
invoice_code: '<string>',
due_date: '2023-11-07T05:31:56Z',
last_modified: '2023-11-07T05:31:56Z',
deleted: false,
team_member_id: '<string>',
invoice_lines: [
{
invoice_line_id: '<string>',
date: '2023-11-07T05:31:56Z',
product_name: '<string>',
product_id: '<string>',
product_code: '<string>',
quantity: 123,
total: 123,
total_tax: 123,
standard_price: 123,
invoice_line_code: '<string>',
last_modified: '2023-11-07T05:31:56Z',
patient_id: '<string>',
team_member_id: '<string>',
is_payment: false,
deleted: false,
finalized: true,
voided: false,
voided_at: '2023-11-07T05:31:56Z',
tip: 0
}
]
}
]
})
};
fetch('https://webhooks.nest.vet/api/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://webhooks.nest.vet/api/v1/invoices",
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([
'invoices' => [
[
'invoice_id' => '<string>',
'created_date' => '2023-11-07T05:31:56Z',
'subtotal' => 123,
'tax' => 123,
'clinic_id' => '<string>',
'client_id' => '<string>',
'invoice_code' => '<string>',
'due_date' => '2023-11-07T05:31:56Z',
'last_modified' => '2023-11-07T05:31:56Z',
'deleted' => false,
'team_member_id' => '<string>',
'invoice_lines' => [
[
'invoice_line_id' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'product_name' => '<string>',
'product_id' => '<string>',
'product_code' => '<string>',
'quantity' => 123,
'total' => 123,
'total_tax' => 123,
'standard_price' => 123,
'invoice_line_code' => '<string>',
'last_modified' => '2023-11-07T05:31:56Z',
'patient_id' => '<string>',
'team_member_id' => '<string>',
'is_payment' => false,
'deleted' => false,
'finalized' => true,
'voided' => false,
'voided_at' => '2023-11-07T05:31:56Z',
'tip' => 0
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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://webhooks.nest.vet/api/v1/invoices"
payload := strings.NewReader("{\n \"invoices\": [\n {\n \"invoice_id\": \"<string>\",\n \"created_date\": \"2023-11-07T05:31:56Z\",\n \"subtotal\": 123,\n \"tax\": 123,\n \"clinic_id\": \"<string>\",\n \"client_id\": \"<string>\",\n \"invoice_code\": \"<string>\",\n \"due_date\": \"2023-11-07T05:31:56Z\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"deleted\": false,\n \"team_member_id\": \"<string>\",\n \"invoice_lines\": [\n {\n \"invoice_line_id\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"product_name\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_code\": \"<string>\",\n \"quantity\": 123,\n \"total\": 123,\n \"total_tax\": 123,\n \"standard_price\": 123,\n \"invoice_line_code\": \"<string>\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"patient_id\": \"<string>\",\n \"team_member_id\": \"<string>\",\n \"is_payment\": false,\n \"deleted\": false,\n \"finalized\": true,\n \"voided\": false,\n \"voided_at\": \"2023-11-07T05:31:56Z\",\n \"tip\": 0\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
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://webhooks.nest.vet/api/v1/invoices")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Organization-Id", "<x-organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"invoices\": [\n {\n \"invoice_id\": \"<string>\",\n \"created_date\": \"2023-11-07T05:31:56Z\",\n \"subtotal\": 123,\n \"tax\": 123,\n \"clinic_id\": \"<string>\",\n \"client_id\": \"<string>\",\n \"invoice_code\": \"<string>\",\n \"due_date\": \"2023-11-07T05:31:56Z\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"deleted\": false,\n \"team_member_id\": \"<string>\",\n \"invoice_lines\": [\n {\n \"invoice_line_id\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"product_name\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_code\": \"<string>\",\n \"quantity\": 123,\n \"total\": 123,\n \"total_tax\": 123,\n \"standard_price\": 123,\n \"invoice_line_code\": \"<string>\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"patient_id\": \"<string>\",\n \"team_member_id\": \"<string>\",\n \"is_payment\": false,\n \"deleted\": false,\n \"finalized\": true,\n \"voided\": false,\n \"voided_at\": \"2023-11-07T05:31:56Z\",\n \"tip\": 0\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://webhooks.nest.vet/api/v1/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoices\": [\n {\n \"invoice_id\": \"<string>\",\n \"created_date\": \"2023-11-07T05:31:56Z\",\n \"subtotal\": 123,\n \"tax\": 123,\n \"clinic_id\": \"<string>\",\n \"client_id\": \"<string>\",\n \"invoice_code\": \"<string>\",\n \"due_date\": \"2023-11-07T05:31:56Z\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"deleted\": false,\n \"team_member_id\": \"<string>\",\n \"invoice_lines\": [\n {\n \"invoice_line_id\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"product_name\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_code\": \"<string>\",\n \"quantity\": 123,\n \"total\": 123,\n \"total_tax\": 123,\n \"standard_price\": 123,\n \"invoice_line_code\": \"<string>\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"patient_id\": \"<string>\",\n \"team_member_id\": \"<string>\",\n \"is_payment\": false,\n \"deleted\": false,\n \"finalized\": true,\n \"voided\": false,\n \"voided_at\": \"2023-11-07T05:31:56Z\",\n \"tip\": 0\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "scheduled",
"task_id": "<string>",
"scheduled_for": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"invoices_count": 123,
"received_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Unique key for this webhook delivery used to deduplicate scheduling. Recommended to use a UUID. Maximum length 36 characters.
Identifier of the organization/tenant that owns the invoices. Used for routing, logging, and idempotent task naming.
Body
application/json
List of invoice payloads to process. A single request may contain up to 100 invoices; larger payloads will be rejected.
Show child attributes
Show child attributes
Response
Successful Response
Scheduling outcome for this webhook: 'scheduled' when a new Task is enqueued, 'duplicate' when a task already exists for the same Idempotency-Key, 'completed' (reserved for future use and not currently emitted), or 'error' when Cloud Tasks rejected the request.
Available options:
scheduled, duplicate, completed, error Deterministic Tasks identifier derived from organization and Idempotency-Key.
UTC timestamp when the Task is scheduled to run.
Opaque key supplied by the caller to deduplicate webhook deliveries (max 36 chars).
Required string length:
1 - 36Number of invoices accepted from the request payload.
UTC timestamp when the webhook was received by the service.
⌘I
Accept Invoices
curl --request POST \
--url https://webhooks.nest.vet/api/v1/invoices \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Organization-Id: <x-organization-id>' \
--data '
{
"invoices": [
{
"invoice_id": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"subtotal": 123,
"tax": 123,
"clinic_id": "<string>",
"client_id": "<string>",
"invoice_code": "<string>",
"due_date": "2023-11-07T05:31:56Z",
"last_modified": "2023-11-07T05:31:56Z",
"deleted": false,
"team_member_id": "<string>",
"invoice_lines": [
{
"invoice_line_id": "<string>",
"date": "2023-11-07T05:31:56Z",
"product_name": "<string>",
"product_id": "<string>",
"product_code": "<string>",
"quantity": 123,
"total": 123,
"total_tax": 123,
"standard_price": 123,
"invoice_line_code": "<string>",
"last_modified": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"team_member_id": "<string>",
"is_payment": false,
"deleted": false,
"finalized": true,
"voided": false,
"voided_at": "2023-11-07T05:31:56Z",
"tip": 0
}
]
}
]
}
'import requests
url = "https://webhooks.nest.vet/api/v1/invoices"
payload = { "invoices": [
{
"invoice_id": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"subtotal": 123,
"tax": 123,
"clinic_id": "<string>",
"client_id": "<string>",
"invoice_code": "<string>",
"due_date": "2023-11-07T05:31:56Z",
"last_modified": "2023-11-07T05:31:56Z",
"deleted": False,
"team_member_id": "<string>",
"invoice_lines": [
{
"invoice_line_id": "<string>",
"date": "2023-11-07T05:31:56Z",
"product_name": "<string>",
"product_id": "<string>",
"product_code": "<string>",
"quantity": 123,
"total": 123,
"total_tax": 123,
"standard_price": 123,
"invoice_line_code": "<string>",
"last_modified": "2023-11-07T05:31:56Z",
"patient_id": "<string>",
"team_member_id": "<string>",
"is_payment": False,
"deleted": False,
"finalized": True,
"voided": False,
"voided_at": "2023-11-07T05:31:56Z",
"tip": 0
}
]
}
] }
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-Organization-Id": "<x-organization-id>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
'X-Organization-Id': '<x-organization-id>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
invoices: [
{
invoice_id: '<string>',
created_date: '2023-11-07T05:31:56Z',
subtotal: 123,
tax: 123,
clinic_id: '<string>',
client_id: '<string>',
invoice_code: '<string>',
due_date: '2023-11-07T05:31:56Z',
last_modified: '2023-11-07T05:31:56Z',
deleted: false,
team_member_id: '<string>',
invoice_lines: [
{
invoice_line_id: '<string>',
date: '2023-11-07T05:31:56Z',
product_name: '<string>',
product_id: '<string>',
product_code: '<string>',
quantity: 123,
total: 123,
total_tax: 123,
standard_price: 123,
invoice_line_code: '<string>',
last_modified: '2023-11-07T05:31:56Z',
patient_id: '<string>',
team_member_id: '<string>',
is_payment: false,
deleted: false,
finalized: true,
voided: false,
voided_at: '2023-11-07T05:31:56Z',
tip: 0
}
]
}
]
})
};
fetch('https://webhooks.nest.vet/api/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://webhooks.nest.vet/api/v1/invoices",
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([
'invoices' => [
[
'invoice_id' => '<string>',
'created_date' => '2023-11-07T05:31:56Z',
'subtotal' => 123,
'tax' => 123,
'clinic_id' => '<string>',
'client_id' => '<string>',
'invoice_code' => '<string>',
'due_date' => '2023-11-07T05:31:56Z',
'last_modified' => '2023-11-07T05:31:56Z',
'deleted' => false,
'team_member_id' => '<string>',
'invoice_lines' => [
[
'invoice_line_id' => '<string>',
'date' => '2023-11-07T05:31:56Z',
'product_name' => '<string>',
'product_id' => '<string>',
'product_code' => '<string>',
'quantity' => 123,
'total' => 123,
'total_tax' => 123,
'standard_price' => 123,
'invoice_line_code' => '<string>',
'last_modified' => '2023-11-07T05:31:56Z',
'patient_id' => '<string>',
'team_member_id' => '<string>',
'is_payment' => false,
'deleted' => false,
'finalized' => true,
'voided' => false,
'voided_at' => '2023-11-07T05:31:56Z',
'tip' => 0
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"X-Organization-Id: <x-organization-id>"
],
]);
$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://webhooks.nest.vet/api/v1/invoices"
payload := strings.NewReader("{\n \"invoices\": [\n {\n \"invoice_id\": \"<string>\",\n \"created_date\": \"2023-11-07T05:31:56Z\",\n \"subtotal\": 123,\n \"tax\": 123,\n \"clinic_id\": \"<string>\",\n \"client_id\": \"<string>\",\n \"invoice_code\": \"<string>\",\n \"due_date\": \"2023-11-07T05:31:56Z\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"deleted\": false,\n \"team_member_id\": \"<string>\",\n \"invoice_lines\": [\n {\n \"invoice_line_id\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"product_name\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_code\": \"<string>\",\n \"quantity\": 123,\n \"total\": 123,\n \"total_tax\": 123,\n \"standard_price\": 123,\n \"invoice_line_code\": \"<string>\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"patient_id\": \"<string>\",\n \"team_member_id\": \"<string>\",\n \"is_payment\": false,\n \"deleted\": false,\n \"finalized\": true,\n \"voided\": false,\n \"voided_at\": \"2023-11-07T05:31:56Z\",\n \"tip\": 0\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-Organization-Id", "<x-organization-id>")
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://webhooks.nest.vet/api/v1/invoices")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-Organization-Id", "<x-organization-id>")
.header("Content-Type", "application/json")
.body("{\n \"invoices\": [\n {\n \"invoice_id\": \"<string>\",\n \"created_date\": \"2023-11-07T05:31:56Z\",\n \"subtotal\": 123,\n \"tax\": 123,\n \"clinic_id\": \"<string>\",\n \"client_id\": \"<string>\",\n \"invoice_code\": \"<string>\",\n \"due_date\": \"2023-11-07T05:31:56Z\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"deleted\": false,\n \"team_member_id\": \"<string>\",\n \"invoice_lines\": [\n {\n \"invoice_line_id\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"product_name\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_code\": \"<string>\",\n \"quantity\": 123,\n \"total\": 123,\n \"total_tax\": 123,\n \"standard_price\": 123,\n \"invoice_line_code\": \"<string>\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"patient_id\": \"<string>\",\n \"team_member_id\": \"<string>\",\n \"is_payment\": false,\n \"deleted\": false,\n \"finalized\": true,\n \"voided\": false,\n \"voided_at\": \"2023-11-07T05:31:56Z\",\n \"tip\": 0\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://webhooks.nest.vet/api/v1/invoices")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-Organization-Id"] = '<x-organization-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invoices\": [\n {\n \"invoice_id\": \"<string>\",\n \"created_date\": \"2023-11-07T05:31:56Z\",\n \"subtotal\": 123,\n \"tax\": 123,\n \"clinic_id\": \"<string>\",\n \"client_id\": \"<string>\",\n \"invoice_code\": \"<string>\",\n \"due_date\": \"2023-11-07T05:31:56Z\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"deleted\": false,\n \"team_member_id\": \"<string>\",\n \"invoice_lines\": [\n {\n \"invoice_line_id\": \"<string>\",\n \"date\": \"2023-11-07T05:31:56Z\",\n \"product_name\": \"<string>\",\n \"product_id\": \"<string>\",\n \"product_code\": \"<string>\",\n \"quantity\": 123,\n \"total\": 123,\n \"total_tax\": 123,\n \"standard_price\": 123,\n \"invoice_line_code\": \"<string>\",\n \"last_modified\": \"2023-11-07T05:31:56Z\",\n \"patient_id\": \"<string>\",\n \"team_member_id\": \"<string>\",\n \"is_payment\": false,\n \"deleted\": false,\n \"finalized\": true,\n \"voided\": false,\n \"voided_at\": \"2023-11-07T05:31:56Z\",\n \"tip\": 0\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "scheduled",
"task_id": "<string>",
"scheduled_for": "2023-11-07T05:31:56Z",
"idempotency_key": "<string>",
"invoices_count": 123,
"received_at": "2023-11-07T05:31:56Z"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}