Find Purchase By Reference

get https://{api_url}/api/v5/admin/{company_id}/purchases/find_by_ref/{ref}

Retrieves a purchase that has a particular reference ID.
Returns last created purchase with matching reference.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

total_price

number

price

integer

paid

integer

deposit

integer

tax_payable_on_price

integer

tax_payable_on_deposit

integer

tax_payable_on_due_now

integer

due_now

integer

long_id

string

integer

affiliate_ref

string

client_name

string

created_at

string

certificate_paid

integer

payment_type

string

original_price

integer

last_payment_log

object

payment_reference

string

external_ref

string

_embedded

object

client

object

        Updates an existing client.

member

object

bookings

array of objects

bookings

object

string

full_describe

string

resource_name

string

person_name

string

service_name

string

resource_id

string

member_id

string

client_name

string

client_email

string

client_phone

string

client_mobile

string

service_id

string

datetime

string

end_datetime

string

duration

string

duration_span

string

listed_duration

string

on_waitlist

string

company_id

string

company_name

string

company_time_zone

string

attended

string

booking_updated

string

updated_at

string

created_at

string

client_id

string

person_id

string

people_ids

string

price

string

paid

string

quantity

string

is_cancelled

string

multi_status

string

purchase_id

string

purchase_ref

string

event_chain_id

string

notes

string

channel

string

user_id

string

status

string

ticket_name

string

_embedded

object

slot_id

string

settings

string

slot_settings

string

answers_summary

string

survey_answers_summary

string

queue_status

string

questions

string

current_multi_status

string

private_note

string

pre_time

string

post_time

string

min_cancellation_time

string

cancellation_date

string

cancel_reason

string

mobile

string

booked_by

string

booked_by_email

string

time_zone

string

person_ids

string

resource_ids

string

cancelled_by

string

checked_in

string

check_in_code

string

external_cal_id

string

price_in_major_units

string

paid_in_major_units

string

assets

string

private_notes

array of strings

private_notes

edit_notes

array of strings

edit_notes

packages

array of objects

packages

object

integer

name

string

description

string

price

integer

paid

integer

products

array of objects

products

object

integer

name

string

description

string

group

string

make

string

sku

string

qty

integer

price

integer

paid

integer

pre_paid_bookings

array of objects

pre_paid_bookings

object

integer

price

integer

number_of_bookings

integer

number_of_bookings_remaining

integer

use_from

string

use_by

string

book_by

string

paid

integer

service_name

string

linked_package_id

integer

deals

array of objects

deals

object

string

name

string

ref

string

num

string

description

string

category_id

string

service_id

string

affiliate_id

string

price

string

created_at

string

redemption

string

expires

string

total_codes

string

used_codes

string

link

string

tandc

string

vendor

string

allow_mixed_bookings

string

widget_show

string

course_bookings

array of objects

course_bookings

object

string

full_describe

string

resource_name

string

person_name

string

service_name

string

resource_id

string

member_id

string

client_name

string

client_email

string

client_phone

string

client_mobile

string

service_id

string

datetime

string

end_datetime

string

duration

string

duration_span

string

listed_duration

string

on_waitlist

string

company_id

string

company_name

string

company_time_zone

string

attended

string

booking_updated

string

updated_at

string

created_at

string

client_id

string

person_id

string

people_ids

string

price

string

paid

string

quantity

string

is_cancelled

string

multi_status

string

purchase_id

string

purchase_ref

string

event_chain_id

string

notes

string

channel

string

user_id

string

status

string

ticket_name

string

_embedded

object

slot_id

string

settings

string

slot_settings

string

answers_summary

string

survey_answers_summary

string

queue_status

string

questions

string

current_multi_status

string

private_note

string

pre_time

string

post_time

string

min_cancellation_time

string

cancellation_date

string

cancel_reason

string

mobile

string

booked_by

string

booked_by_email

string

time_zone

string

person_ids

string

resource_ids

string

cancelled_by

string

checked_in

string

check_in_code

string

external_cal_id

string

price_in_major_units

string

paid_in_major_units

string

assets

string

private_notes

array of strings

private_notes

edit_notes

array of strings

edit_notes

external_purchases

array of objects

external_purchases

object

integer

name

string

description

string

settings

object

reference

string

purchase_item_id

integer

is_cancelled

boolean

payment_callbacks

array of objects

payment_callbacks

object

verification_key

string

payer_name

string

payer_email

string

payer_id

integer

receiver_email

integer

payment_date

string

amount

integer

confirm_messages

array of objects

confirm_messages

object

integer

message

string

message_type

string

item_type

string

refund

object

amount_refunded

integer

amount_remaining

integer

price_in_major_units

number

total_price_in_major_units

number

paid_in_major_units

number

deposit_in_major_units

number

tax_payable_on_price_in_major_units

number

tax_payable_on_deposit_in_major_units

number

tax_payable_on_due_now_in_major_units

number

due_now_in_major_units

number

404

Not Found

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.jrni.com/api/v5/admin/company_id/purchases/find_by_ref/ref?include_cancelled=true' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Purchase