Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
http://localhost:8083/
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
Canonical identifier for the invoice.
Line items that make up the invoice.
Timestamp when the line item was created.
Discount applied to this line item, as a decimal string.
Grouping identifier for related line items.
Identifier for the invoice line item.
Ledger account associated with this line item.
Total amount for this line excluding tax.
Location associated with this line item.
Owning organization or business unit for this line item.
Product or service associated with this line item.
Salesperson associated with this line item.
Standard (list) unit price excluding tax.
Unit price excluding tax, as a decimal string.
Owning organization or business unit.
Payment terms associated with the invoice.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoice
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"approvedAt": "2025-01-01T00:00:00.000Z",
"approvedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"currency": "string",
"customerReferenceNumber": "string",
"dueDate": "2025-01-01",
"extensions": {},
"financials": {},
"invoiceCode": "string",
"invoiceDate": "2025-01-01",
"invoiceId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"isTaxIncluded": true,
"lineItems": [
{
"createdAt": "2025-01-01T00:00:00.000Z",
"discountAmount": "100.00",
"extensions": {},
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceLineItemId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"lineTaxAmount": "100.00",
"lineTotalAmount": "100.00",
"lineType": "string",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "string",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": 0,
"salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
"standardUnitPriceAmount": "100.00",
"standardUnitTaxAmount": "100.00",
"status": "string",
"taxCode": "string",
"taxPercent": 0,
"unitPriceAmount": "100.00",
"unitTaxAmount": "100.00",
"updatedAt": "2025-01-01T00:00:00.000Z"
}
],
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"paymentTermsId": "123e4567-e89b-12d3-a456-426614174000",
"subtotalAmount": "100.00",
"taxAmount": "100.00",
"updatedByUserId": "123e4567-e89b-12d3-a456-426614174000"
}'Invoice created successfully
Animal associated with the invoice.
Timestamp when the invoice was approved.
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
Timestamp when the invoice was created.
User who created the invoice.
Canonical identifier for the invoice.
Line items that make up the invoice.
Timestamp when the line item was created.
Discount applied to this line item, as a decimal string.
Grouping identifier for related line items.
Identifier for the invoice line item.
Ledger account associated with this line item.
Total amount for this line excluding tax.
Location associated with this line item.
Owning organization or business unit for this line item.
Product or service associated with this line item.
Salesperson associated with this line item.
Standard (list) unit price excluding tax.
Unit price excluding tax, as a decimal string.
Owning organization or business unit.
Payment terms associated with the invoice.
Timestamp when the invoice was last modified.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }
Field to sort by
Animal associated with the invoice.
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
User who created the invoice.
Owning organization or business unit.
Payment terms associated with the invoice.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoice
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&approvedByUserId=123e4567-e89b-12d3-a456-426614174000&consultId=123e4567-e89b-12d3-a456-426614174000&contactId=123e4567-e89b-12d3-a456-426614174000&createdByUserId=123e4567-e89b-12d3-a456-426614174000¤cy=string&customerReferenceNumber=string&invoiceCode=string&isActive=true&isTaxIncluded=true&ownershipId=123e4567-e89b-12d3-a456-426614174000&paymentTermsId=123e4567-e89b-12d3-a456-426614174000&updatedByUserId=123e4567-e89b-12d3-a456-426614174000' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoice/{invoiceId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Invoice found
Animal associated with the invoice.
Timestamp when the invoice was approved.
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
Timestamp when the invoice was created.
User who created the invoice.
Canonical identifier for the invoice.
Line items that make up the invoice.
Timestamp when the line item was created.
Discount applied to this line item, as a decimal string.
Grouping identifier for related line items.
Identifier for the invoice line item.
Ledger account associated with this line item.
Total amount for this line excluding tax.
Location associated with this line item.
Owning organization or business unit for this line item.
Product or service associated with this line item.
Salesperson associated with this line item.
Standard (list) unit price excluding tax.
Unit price excluding tax, as a decimal string.
Owning organization or business unit.
Payment terms associated with the invoice.
Timestamp when the invoice was last modified.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
Owning organization or business unit.
Payment terms associated with the invoice.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoice/{invoiceId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"approvedAt": "2025-01-01T00:00:00.000Z",
"approvedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"currency": "string",
"customerReferenceNumber": "string",
"dueDate": "2025-01-01",
"extensions": {},
"financials": {},
"invoiceCode": "string",
"invoiceDate": "2025-01-01",
"isActive": true,
"isTaxIncluded": true,
"lineItems": [
{
"createdAt": "2025-01-01T00:00:00.000Z",
"discountAmount": "100.00",
"extensions": {},
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceLineItemId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"lineTaxAmount": "100.00",
"lineTotalAmount": "100.00",
"lineType": "string",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "string",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": 0,
"salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
"standardUnitPriceAmount": "100.00",
"standardUnitTaxAmount": "100.00",
"status": "string",
"taxCode": "string",
"taxPercent": 0,
"unitPriceAmount": "100.00",
"unitTaxAmount": "100.00",
"updatedAt": "2025-01-01T00:00:00.000Z"
}
],
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"paymentTermsId": "123e4567-e89b-12d3-a456-426614174000",
"subtotalAmount": "100.00",
"taxAmount": "100.00",
"updatedByUserId": "123e4567-e89b-12d3-a456-426614174000"
}'Invoice updated successfully
Animal associated with the invoice.
Timestamp when the invoice was approved.
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
Timestamp when the invoice was created.
User who created the invoice.
Canonical identifier for the invoice.
Line items that make up the invoice.
Timestamp when the line item was created.
Discount applied to this line item, as a decimal string.
Grouping identifier for related line items.
Identifier for the invoice line item.
Ledger account associated with this line item.
Total amount for this line excluding tax.
Location associated with this line item.
Owning organization or business unit for this line item.
Product or service associated with this line item.
Salesperson associated with this line item.
Standard (list) unit price excluding tax.
Unit price excluding tax, as a decimal string.
Owning organization or business unit.
Payment terms associated with the invoice.
Timestamp when the invoice was last modified.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }
Animal associated with the invoice.
Timestamp when the invoice was approved.
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
User who created the invoice.
Line items that make up the invoice.
Timestamp when the line item was created.
Discount applied to this line item, as a decimal string.
Grouping identifier for related line items.
Identifier for the invoice line item.
Ledger account associated with this line item.
Total amount for this line excluding tax.
Location associated with this line item.
Owning organization or business unit for this line item.
Product or service associated with this line item.
Salesperson associated with this line item.
Standard (list) unit price excluding tax.
Unit price excluding tax, as a decimal string.
Owning organization or business unit.
Payment terms associated with the invoice.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoice/{invoiceId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"approvedAt": "2025-01-01T00:00:00.000Z",
"approvedByUserId": "123e4567-e89b-12d3-a456-426614174000",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"contactId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"currency": "string",
"customerReferenceNumber": "string",
"dueDate": "2025-01-01",
"extensions": {},
"financials": {},
"invoiceCode": "string",
"invoiceDate": "2025-01-01",
"isActive": true,
"isTaxIncluded": true,
"lineItems": [
{
"createdAt": "2025-01-01T00:00:00.000Z",
"discountAmount": "100.00",
"extensions": {},
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceLineItemId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"lineTaxAmount": "100.00",
"lineTotalAmount": "100.00",
"lineType": "string",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "string",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": 0,
"salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
"standardUnitPriceAmount": "100.00",
"standardUnitTaxAmount": "100.00",
"status": "string",
"taxCode": "string",
"taxPercent": 0,
"unitPriceAmount": "100.00",
"unitTaxAmount": "100.00",
"updatedAt": "2025-01-01T00:00:00.000Z"
}
],
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"paymentTermsId": "123e4567-e89b-12d3-a456-426614174000",
"subtotalAmount": "100.00",
"taxAmount": "100.00",
"updatedByUserId": "123e4567-e89b-12d3-a456-426614174000"
}'Invoice replaced successfully
Animal associated with the invoice.
Timestamp when the invoice was approved.
User who approved the invoice.
Consultation associated with the invoice.
Client/contact associated with the invoice.
Timestamp when the invoice was created.
User who created the invoice.
Canonical identifier for the invoice.
Line items that make up the invoice.
Timestamp when the line item was created.
Discount applied to this line item, as a decimal string.
Grouping identifier for related line items.
Identifier for the invoice line item.
Ledger account associated with this line item.
Total amount for this line excluding tax.
Location associated with this line item.
Owning organization or business unit for this line item.
Product or service associated with this line item.
Salesperson associated with this line item.
Standard (list) unit price excluding tax.
Unit price excluding tax, as a decimal string.
Owning organization or business unit.
Payment terms associated with the invoice.
Timestamp when the invoice was last modified.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "approvedAt": "2025-01-01T00:00:00.000Z", "approvedByUserId": "123e4567-e89b-12d3-a456-426614174000", "consultId": "123e4567-e89b-12d3-a456-426614174000", "contactId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "createdByUserId": "123e4567-e89b-12d3-a456-426614174000", "currency": "string", "customerReferenceNumber": "string", "dueDate": "2025-01-01T00:00:00Z", "extensions": {}, "financials": {}, "invoiceCode": "string", "invoiceDate": "2025-01-01T00:00:00Z", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "isTaxIncluded": true, "lineItems": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentTermsId": "123e4567-e89b-12d3-a456-426614174000", "subtotalAmount": "100.00", "taxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z", "updatedByUserId": "123e4567-e89b-12d3-a456-426614174000" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoice/{invoiceId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoice/{invoiceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'