Accept Invoice Deletions

POST

api

invoice-deletions

curl --request POST \
  --url https://webhooks.nest.vet/api/v1/invoice-deletions \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "invoices": [
    {
      "invoice_id": "<string>",
      "clinic_id": "<string>",
      "client_id": "<string>"
    }
  ],
  "invoice_lines": [
    {
      "invoice_line_id": "<string>",
      "invoice_id": "<string>",
      "clinic_id": "<string>",
      "client_id": "<string>"
    }
  ]
}
'

import requests

url = "https://webhooks.nest.vet/api/v1/invoice-deletions"

payload = {
    "invoices": [
        {
            "invoice_id": "<string>",
            "clinic_id": "<string>",
            "client_id": "<string>"
        }
    ],
    "invoice_lines": [
        {
            "invoice_line_id": "<string>",
            "invoice_id": "<string>",
            "clinic_id": "<string>",
            "client_id": "<string>"
        }
    ]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Organization-Id": "<x-organization-id>",
    "X-API-Key": "<api-key>",
    "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>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    invoices: [{invoice_id: '<string>', clinic_id: '<string>', client_id: '<string>'}],
    invoice_lines: [
      {
        invoice_line_id: '<string>',
        invoice_id: '<string>',
        clinic_id: '<string>',
        client_id: '<string>'
      }
    ]
  })
};

fetch('https://webhooks.nest.vet/api/v1/invoice-deletions', 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/invoice-deletions",
  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>',
                'clinic_id' => '<string>',
                'client_id' => '<string>'
        ]
    ],
    'invoice_lines' => [
        [
                'invoice_line_id' => '<string>',
                'invoice_id' => '<string>',
                'clinic_id' => '<string>',
                'client_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-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/invoice-deletions"

	payload := strings.NewReader("{\n  \"invoices\": [\n    {\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ],\n  \"invoice_lines\": [\n    {\n      \"invoice_line_id\": \"<string>\",\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\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("X-API-Key", "<api-key>")
	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/invoice-deletions")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"invoices\": [\n    {\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ],\n  \"invoice_lines\": [\n    {\n      \"invoice_line_id\": \"<string>\",\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://webhooks.nest.vet/api/v1/invoice-deletions")

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["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invoices\": [\n    {\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ],\n  \"invoice_lines\": [\n    {\n      \"invoice_line_id\": \"<string>\",\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\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,
  "invoice_lines_count": 123,
  "received_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Service API key. Required on every endpoint except /api/v1/health.

Headers

Idempotency-Key

string

required

Unique key for this webhook delivery, used for request tracing (max 36 chars). Each delivery is scheduled as its own Cloud Task rather than deduplicated by this key -- see the response's task_id for why.

X-Organization-Id

string

required

Identifier of the organization/tenant that owns the invoice data.

Body

application/json

invoices

WebhookInvoiceDeletion · object[]

Collection of invoice-level deletions. When provided, all invoice lines for the invoice will also be marked as deleted.

Show child attributes

invoice_lines

WebhookInvoiceLineDeletion · object[]

Collection of individual invoice line deletions. May be supplied without invoice-level deletions or alongside them.

Show child attributes

Response

Successful Response

status

enum<string>

required

Scheduling outcome for this deletion webhook delivery; semantics mirror WebhookInvoicesResponse (with 'completed' reserved for future use).

Available options:

scheduled,

duplicate,

completed,

error

task_id

string

required

Cloud Tasks identifier for this delivery. Includes the organization and Idempotency-Key for traceability, but is suffixed with a random value per call -- it is not deterministic, so reusing the same Idempotency-Key across deliveries produces a different task_id each time and does not collide with (or get silently dropped in favor of) an earlier delivery.

scheduled_for

string<date-time>

required

UTC timestamp when the deletion task is scheduled to run.

idempotency_key

string

required

Opaque key supplied via the Idempotency-Key header, echoed back for correlation (max 36 chars). Does not deduplicate deliveries -- see task_id.

Required string length: 1 - 36

invoices_count

integer

required

Number of invoice records included in the deletion payload.

invoice_lines_count

integer

required

Number of invoice-line records included in the deletion payload.

received_at

string<date-time> | null

UTC timestamp when the webhook was received by the service.

Accept Invoice Deletions

curl --request POST \
  --url https://webhooks.nest.vet/api/v1/invoice-deletions \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Organization-Id: <x-organization-id>' \
  --data '
{
  "invoices": [
    {
      "invoice_id": "<string>",
      "clinic_id": "<string>",
      "client_id": "<string>"
    }
  ],
  "invoice_lines": [
    {
      "invoice_line_id": "<string>",
      "invoice_id": "<string>",
      "clinic_id": "<string>",
      "client_id": "<string>"
    }
  ]
}
'

import requests

url = "https://webhooks.nest.vet/api/v1/invoice-deletions"

payload = {
    "invoices": [
        {
            "invoice_id": "<string>",
            "clinic_id": "<string>",
            "client_id": "<string>"
        }
    ],
    "invoice_lines": [
        {
            "invoice_line_id": "<string>",
            "invoice_id": "<string>",
            "clinic_id": "<string>",
            "client_id": "<string>"
        }
    ]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Organization-Id": "<x-organization-id>",
    "X-API-Key": "<api-key>",
    "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>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    invoices: [{invoice_id: '<string>', clinic_id: '<string>', client_id: '<string>'}],
    invoice_lines: [
      {
        invoice_line_id: '<string>',
        invoice_id: '<string>',
        clinic_id: '<string>',
        client_id: '<string>'
      }
    ]
  })
};

fetch('https://webhooks.nest.vet/api/v1/invoice-deletions', 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/invoice-deletions",
  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>',
                'clinic_id' => '<string>',
                'client_id' => '<string>'
        ]
    ],
    'invoice_lines' => [
        [
                'invoice_line_id' => '<string>',
                'invoice_id' => '<string>',
                'clinic_id' => '<string>',
                'client_id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>",
    "X-API-Key: <api-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/invoice-deletions"

	payload := strings.NewReader("{\n  \"invoices\": [\n    {\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ],\n  \"invoice_lines\": [\n    {\n      \"invoice_line_id\": \"<string>\",\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\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("X-API-Key", "<api-key>")
	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/invoice-deletions")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("X-Organization-Id", "<x-organization-id>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"invoices\": [\n    {\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ],\n  \"invoice_lines\": [\n    {\n      \"invoice_line_id\": \"<string>\",\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://webhooks.nest.vet/api/v1/invoice-deletions")

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["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"invoices\": [\n    {\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\n    }\n  ],\n  \"invoice_lines\": [\n    {\n      \"invoice_line_id\": \"<string>\",\n      \"invoice_id\": \"<string>\",\n      \"clinic_id\": \"<string>\",\n      \"client_id\": \"<string>\"\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,
  "invoice_lines_count": 123,
  "received_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Webhook API Reference

Invoices

health

invoices

invoice-deletions

tasks

Authorizations

Headers

Body

Response