Record what was done
For a booked or checked-in appointment (409 for one done, canceled or a no-show). services is what was done: a service booked keeps the price it was booked at, one added is copied at its price now, and one left out is taken off, so what is charged is what was done. Each becomes a record on the pet; a microchip (whose number is needed) becomes the pet’s chip, and a procedure whose catalog item spays or neuters marks the pet altered. In house names no practice. Needs write on Animals.
POST
https://{organization}.rescueconsole.com
/
api
/
animals
/
clinic-days
/
{id}
/
appointments
/
{appointmentId}
/
done
Record what was done
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/clinic-days/{id}/appointments/{appointmentId}/done \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"services": [
{
"sale_item_id": "<string>",
"next_due_on": "2023-12-25",
"notes": "<string>",
"details": {
"tag_number": "<string>",
"lot_number": "<string>",
"product_expires_on": "2023-12-25",
"result": "<string>"
},
"microchip_number": "<string>",
"microchip_vendor": "<string>"
}
],
"performed_on": "2023-12-25",
"veterinarian_person_id": "<string>",
"veterinary_practice_id": "<string>",
"performed_in_house": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
services: [
{
sale_item_id: '<string>',
next_due_on: '2023-12-25',
notes: '<string>',
details: {
tag_number: '<string>',
lot_number: '<string>',
product_expires_on: '2023-12-25',
result: '<string>'
},
microchip_number: '<string>',
microchip_vendor: '<string>'
}
],
performed_on: '2023-12-25',
veterinarian_person_id: '<string>',
veterinary_practice_id: '<string>',
performed_in_house: true
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/clinic-days/{id}/appointments/{appointmentId}/done', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/clinic-days/{id}/appointments/{appointmentId}/done"
payload = {
"services": [
{
"sale_item_id": "<string>",
"next_due_on": "2023-12-25",
"notes": "<string>",
"details": {
"tag_number": "<string>",
"lot_number": "<string>",
"product_expires_on": "2023-12-25",
"result": "<string>"
},
"microchip_number": "<string>",
"microchip_vendor": "<string>"
}
],
"performed_on": "2023-12-25",
"veterinarian_person_id": "<string>",
"veterinary_practice_id": "<string>",
"performed_in_house": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"appointment": {
"id": "<string>",
"clinic": {
"id": "<string>",
"name": "<string>",
"held_on": "2023-12-25"
},
"status": "booked",
"pet": {
"id": "<string>",
"name": "<string>",
"species": "<string>",
"breed": "<string>",
"sex": "male",
"altered": true,
"microchip_number": "<string>"
},
"owner": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"services": [
{
"id": "<string>",
"sale_item_id": "<string>",
"name": "<string>",
"price_cents": 123,
"clinic_record": "vaccination"
}
],
"subtotal_cents": 123,
"tax_cents": 123,
"total_cents": 123,
"at_time": "<string>",
"notes": "<string>",
"checked_in_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"done_at": "2023-11-07T05:31:56Z",
"done_by_person_id": "<string>",
"records": [
{
"id": "<string>",
"record_type": "vaccination",
"name": "<string>",
"performed_on": "2023-12-25",
"appointment_id": "<string>",
"catalogue_item_id": "<string>",
"next_due_on": "2023-12-25",
"details": {},
"notes": "<string>",
"performed_in_house": true,
"veterinarian": {
"id": "<string>",
"name": "<string>"
},
"practice": {
"id": "<string>",
"name": "<string>"
},
"sac_line": "microchip_id"
}
],
"payment": {
"sale_id": "<string>",
"status": "open",
"tender": "card",
"total_cents": 123,
"refunded_cents": 123,
"paid_at": "2023-11-07T05:31:56Z"
}
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
Body
application/json
⌘I
Record what was done
curl --request POST \
--url https://{organization}.rescueconsole.com/api/animals/clinic-days/{id}/appointments/{appointmentId}/done \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"services": [
{
"sale_item_id": "<string>",
"next_due_on": "2023-12-25",
"notes": "<string>",
"details": {
"tag_number": "<string>",
"lot_number": "<string>",
"product_expires_on": "2023-12-25",
"result": "<string>"
},
"microchip_number": "<string>",
"microchip_vendor": "<string>"
}
],
"performed_on": "2023-12-25",
"veterinarian_person_id": "<string>",
"veterinary_practice_id": "<string>",
"performed_in_house": true
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
services: [
{
sale_item_id: '<string>',
next_due_on: '2023-12-25',
notes: '<string>',
details: {
tag_number: '<string>',
lot_number: '<string>',
product_expires_on: '2023-12-25',
result: '<string>'
},
microchip_number: '<string>',
microchip_vendor: '<string>'
}
],
performed_on: '2023-12-25',
veterinarian_person_id: '<string>',
veterinary_practice_id: '<string>',
performed_in_house: true
})
};
fetch('https://{organization}.rescueconsole.com/api/animals/clinic-days/{id}/appointments/{appointmentId}/done', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/animals/clinic-days/{id}/appointments/{appointmentId}/done"
payload = {
"services": [
{
"sale_item_id": "<string>",
"next_due_on": "2023-12-25",
"notes": "<string>",
"details": {
"tag_number": "<string>",
"lot_number": "<string>",
"product_expires_on": "2023-12-25",
"result": "<string>"
},
"microchip_number": "<string>",
"microchip_vendor": "<string>"
}
],
"performed_on": "2023-12-25",
"veterinarian_person_id": "<string>",
"veterinary_practice_id": "<string>",
"performed_in_house": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"appointment": {
"id": "<string>",
"clinic": {
"id": "<string>",
"name": "<string>",
"held_on": "2023-12-25"
},
"status": "booked",
"pet": {
"id": "<string>",
"name": "<string>",
"species": "<string>",
"breed": "<string>",
"sex": "male",
"altered": true,
"microchip_number": "<string>"
},
"owner": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"phone": "<string>"
},
"services": [
{
"id": "<string>",
"sale_item_id": "<string>",
"name": "<string>",
"price_cents": 123,
"clinic_record": "vaccination"
}
],
"subtotal_cents": 123,
"tax_cents": 123,
"total_cents": 123,
"at_time": "<string>",
"notes": "<string>",
"checked_in_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"done_at": "2023-11-07T05:31:56Z",
"done_by_person_id": "<string>",
"records": [
{
"id": "<string>",
"record_type": "vaccination",
"name": "<string>",
"performed_on": "2023-12-25",
"appointment_id": "<string>",
"catalogue_item_id": "<string>",
"next_due_on": "2023-12-25",
"details": {},
"notes": "<string>",
"performed_in_house": true,
"veterinarian": {
"id": "<string>",
"name": "<string>"
},
"practice": {
"id": "<string>",
"name": "<string>"
},
"sac_line": "microchip_id"
}
],
"payment": {
"sale_id": "<string>",
"status": "open",
"tender": "card",
"total_cents": 123,
"refunded_cents": 123,
"paid_at": "2023-11-07T05:31:56Z"
}
}
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}
