Animal Health Data Store - V1 API Documentation
AHDS Store API (1.0)
https://docs.heydonto.com/_mock/apis/animal-health/openapi/
http://localhost:8083/
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Absolute discount amount (excluding tax) applied to this line, as a decimal string.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the parent invoice.
Canonical identifier for this invoice line.
Identifier of the ledger or GL account associated with this line.
Extended line total (excluding tax) after discount, as a decimal string.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Human-readable description of the invoice line, typically the product or service name.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
Service or supply date associated with this line, if distinct from the invoice date.
Standard or list unit price (excluding tax) before discount, as a decimal string.
Standard tax amount per unit before discount, as a decimal string.
Net unit price (excluding tax) after discount, as a decimal string.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoiceline
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoiceline
- 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/invoiceline' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"batch": "string",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"currency": "string",
"discountAmount": "100.00",
"extensions": {},
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceId": "123e4567-e89b-12d3-a456-426614174000",
"invoicelineId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"lineTaxTotal": "100.00",
"lineTotal": "100.00",
"lineType": "product",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "string",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": "100.00",
"salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
"serviceDate": "2025-01-01",
"standardUnitPrice": "100.00",
"standardUnitTaxAmount": "100.00",
"status": "draft",
"taxCode": "string",
"taxPercent": 0,
"unitPrice": "100.00",
"unitTaxAmount": "100.00"
}'Invoiceline created successfully
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Timestamp when the invoice line was created.
Absolute discount amount (excluding tax) applied to this line, as a decimal string.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the parent invoice.
Canonical identifier for this invoice line.
Identifier of the ledger or GL account associated with this line.
Extended line total (excluding tax) after discount, as a decimal string.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Human-readable description of the invoice line, typically the product or service name.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
Service or supply date associated with this line, if distinct from the invoice date.
Standard or list unit price (excluding tax) before discount, as a decimal string.
Standard tax amount per unit before discount, as a decimal string.
Net unit price (excluding tax) after discount, as a decimal string.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }
Field to sort by
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the parent invoice.
Identifier of the ledger or GL account associated with this line.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoiceline
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoiceline
- 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/invoiceline?page=0&pageSize=10&sortBy=createdAt&sortOrder=asc&animalId=123e4567-e89b-12d3-a456-426614174000&batch=string&consultId=123e4567-e89b-12d3-a456-426614174000¤cy=string&groupId=123e4567-e89b-12d3-a456-426614174000&invoiceId=123e4567-e89b-12d3-a456-426614174000&isActive=true&ledgerAccountId=123e4567-e89b-12d3-a456-426614174000&lineType=product&locationId=123e4567-e89b-12d3-a456-426614174000&name=string&ownershipId=123e4567-e89b-12d3-a456-426614174000&productId=123e4567-e89b-12d3-a456-426614174000&salesPersonId=123e4567-e89b-12d3-a456-426614174000&status=draft&taxCode=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- 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/invoiceline/{invoicelineId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Invoiceline found
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Timestamp when the invoice line was created.
Absolute discount amount (excluding tax) applied to this line, as a decimal string.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the parent invoice.
Canonical identifier for this invoice line.
Identifier of the ledger or GL account associated with this line.
Extended line total (excluding tax) after discount, as a decimal string.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Human-readable description of the invoice line, typically the product or service name.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
Service or supply date associated with this line, if distinct from the invoice date.
Standard or list unit price (excluding tax) before discount, as a decimal string.
Standard tax amount per unit before discount, as a decimal string.
Net unit price (excluding tax) after discount, as a decimal string.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Absolute discount amount (excluding tax) applied to this line, as a decimal string.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the ledger or GL account associated with this line.
Extended line total (excluding tax) after discount, as a decimal string.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
Service or supply date associated with this line, if distinct from the invoice date.
Standard or list unit price (excluding tax) before discount, as a decimal string.
Standard tax amount per unit before discount, as a decimal string.
Net unit price (excluding tax) after discount, as a decimal string.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- 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/invoiceline/{invoicelineId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"batch": "string",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"currency": "string",
"discountAmount": "100.00",
"extensions": {},
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"lineTaxTotal": "100.00",
"lineTotal": "100.00",
"lineType": "product",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "string",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": "100.00",
"salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
"serviceDate": "2025-01-01",
"standardUnitPrice": "100.00",
"standardUnitTaxAmount": "100.00",
"status": "draft",
"taxCode": "string",
"taxPercent": 0,
"unitPrice": "100.00",
"unitTaxAmount": "100.00"
}'Invoiceline updated successfully
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Timestamp when the invoice line was created.
Absolute discount amount (excluding tax) applied to this line, as a decimal string.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the parent invoice.
Canonical identifier for this invoice line.
Identifier of the ledger or GL account associated with this line.
Extended line total (excluding tax) after discount, as a decimal string.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Human-readable description of the invoice line, typically the product or service name.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
Service or supply date associated with this line, if distinct from the invoice date.
Standard or list unit price (excluding tax) before discount, as a decimal string.
Standard tax amount per unit before discount, as a decimal string.
Net unit price (excluding tax) after discount, as a decimal string.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Absolute discount amount (excluding tax) applied to this line, as a decimal string.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the parent invoice.
Identifier of the ledger or GL account associated with this line.
Extended line total (excluding tax) after discount, as a decimal string.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Human-readable description of the invoice line, typically the product or service name.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
Service or supply date associated with this line, if distinct from the invoice date.
Standard or list unit price (excluding tax) before discount, as a decimal string.
Standard tax amount per unit before discount, as a decimal string.
Net unit price (excluding tax) after discount, as a decimal string.
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- 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/invoiceline/{invoicelineId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"animalId": "123e4567-e89b-12d3-a456-426614174000",
"batch": "string",
"consultId": "123e4567-e89b-12d3-a456-426614174000",
"currency": "string",
"discountAmount": "100.00",
"extensions": {},
"groupId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceId": "123e4567-e89b-12d3-a456-426614174000",
"isActive": true,
"ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000",
"lineTaxTotal": "100.00",
"lineTotal": "100.00",
"lineType": "product",
"locationId": "123e4567-e89b-12d3-a456-426614174000",
"name": "string",
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"productId": "123e4567-e89b-12d3-a456-426614174000",
"quantity": "100.00",
"salesPersonId": "123e4567-e89b-12d3-a456-426614174000",
"serviceDate": "2025-01-01",
"standardUnitPrice": "100.00",
"standardUnitTaxAmount": "100.00",
"status": "draft",
"taxCode": "string",
"taxPercent": 0,
"unitPrice": "100.00",
"unitTaxAmount": "100.00"
}'Invoiceline replaced successfully
Identifier of the animal associated with this invoice line, if any.
Identifier of the consultation associated with this invoice line, if any.
Timestamp when the invoice line was created.
Absolute discount amount (excluding tax) applied to this line, as a decimal string.
Identifier for a grouping of invoice lines (e.g., package or section).
Identifier of the parent invoice.
Canonical identifier for this invoice line.
Identifier of the ledger or GL account associated with this line.
Extended line total (excluding tax) after discount, as a decimal string.
Type of invoice line (e.g., product, service, discount).
Identifier of the practice location where this line item was generated.
Human-readable description of the invoice line, typically the product or service name.
Identifier representing the ownership or billing entity associated with this line.
Reference to the billed product or service.
Identifier of the staff member credited as salesperson for this line.
Service or supply date associated with this line, if distinct from the invoice date.
Standard or list unit price (excluding tax) before discount, as a decimal string.
Standard tax amount per unit before discount, as a decimal string.
Net unit price (excluding tax) after discount, as a decimal string.
{ "animalId": "123e4567-e89b-12d3-a456-426614174000", "batch": "string", "consultId": "123e4567-e89b-12d3-a456-426614174000", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "string", "discountAmount": "100.00", "extensions": {}, "groupId": "123e4567-e89b-12d3-a456-426614174000", "invoiceId": "123e4567-e89b-12d3-a456-426614174000", "invoicelineId": "123e4567-e89b-12d3-a456-426614174000", "isActive": true, "ledgerAccountId": "123e4567-e89b-12d3-a456-426614174000", "lineTaxTotal": "100.00", "lineTotal": "100.00", "lineType": "product", "locationId": "123e4567-e89b-12d3-a456-426614174000", "name": "string", "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "productId": "123e4567-e89b-12d3-a456-426614174000", "quantity": "100.00", "salesPersonId": "123e4567-e89b-12d3-a456-426614174000", "serviceDate": "2025-01-01T00:00:00Z", "standardUnitPrice": "100.00", "standardUnitTaxAmount": "100.00", "status": "draft", "taxCode": "string", "taxPercent": 0, "unitPrice": "100.00", "unitTaxAmount": "100.00", "updatedAt": "2025-01-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- Local Development
http://localhost:8083/site/{siteId}/ahds/v1/invoiceline/{invoicelineId}
- 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/invoiceline/{invoicelineId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'