Creates a new Payment record. Payment resource in the Animal Health Data Store
Total amount of the payment that has been allocated to invoices.
Identifier of the client associated with this payment.
Identifier for the owning organization or practice.
Free-text or structured details about the payment method (e.g., last 4 digits, reference number).
Canonical unique identifier for the payment.
Method used to make the payment.
- Mock serverhttps://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment
- Local Developmenthttp://localhost:8083/site/{siteId}/ahds/v1/payment
curl -i -X POST \
'https://docs.axiomera.com/_mock/apis/animal-health/openapi/site/{siteId}/ahds/v1/payment' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"allocatedAmount": "100.00",
"amount": "100.00",
"availableAmount": "100.00",
"cashAmount": "100.00",
"cashChange": "100.00",
"clientId": "123e4567-e89b-12d3-a456-426614174000",
"comments": "Example description",
"currency": "CODE-001",
"extensions": {},
"isActive": true,
"linkedInvoices": [
{
"allocatedAmount": "100.00",
"invoiceId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"ownershipId": "123e4567-e89b-12d3-a456-426614174000",
"paymentDate": "2025-01-01",
"paymentDetails": "example",
"paymentId": "123e4567-e89b-12d3-a456-426614174000",
"paymentMethod": "cash",
"roundingFactor": "100.00",
"status": "pending"
}'Payment created successfully
Total amount of the payment that has been allocated to invoices.
Unallocated portion of the payment that is still available.
Portion of the payment that was paid in cash, if applicable.
Change returned to the client for cash payments, if applicable.
Identifier of the client associated with this payment.
Timestamp when the payment record was created.
Invoices to which this payment has been allocated.
Identifier for the owning organization or practice.
Calendar date the payment was received or processed.
Free-text or structured details about the payment method (e.g., last 4 digits, reference number).
Canonical unique identifier for the payment.
Method used to make the payment.
Lifecycle status of the payment.
{ "allocatedAmount": "100.00", "amount": "100.00", "availableAmount": "100.00", "cashAmount": "100.00", "cashChange": "100.00", "clientId": "123e4567-e89b-12d3-a456-426614174000", "comments": "Example description", "createdAt": "2025-01-01T00:00:00.000Z", "currency": "CODE-001", "extensions": {}, "isActive": true, "linkedInvoices": [ { … } ], "ownershipId": "123e4567-e89b-12d3-a456-426614174000", "paymentDate": "2025-01-01T00:00:00Z", "paymentDetails": "example", "paymentId": "123e4567-e89b-12d3-a456-426614174000", "paymentMethod": "cash", "roundingFactor": "100.00", "status": "pending", "updatedAt": "2025-01-01T00:00:00.000Z" }