Koha REST API (1)

Download OpenAPI specification:Download

URL: https://koha-community.org/ License: GPL v3

oauth

tokenOAuth

Request Body schema: application/x-www-form-urlencoded
required

grant_type required	string grant type (client_credentials)
client_id	string client id
client_secret	string client secret

Responses

Response samples

200
400
403

Content type

application/json

{"access_token": "string",
"token_type": "string",
"expires_in": 0
}

acquisitions

listOrders

koha-authorization: {"permissions":{"acquisition":["order_manage","order_manage_all"]}}

query Parameters

biblio_id	integer Identifier for a linked bibliographic record
basket_id	integer Identifier for a linked acquisition basket
fund_id	integer Identifier for the fund the order goes against
status	string Current status for the order. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

Content type

application/json

[{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}
]

addOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

Request Body schema: application/json
required

A JSON object representing an order

order_id	integer Internally assigned order identifier
biblio_id	integer or null Identifier for the linked bibliographic record
created_by	integer or null Interal patron identifier of the order line creator
entry_date	string or null <date> Date the bib was added to the basket
quantity	integer or null Ordered quantity
currency	string or null Currency used for the purchase
list_price	number or null Vendor price for the line item
replacement_price	number or null Replacement cost for this item
date_received	string or null <date> Date the order was received
invoice_id	integer or null Id of the order invoice
shipping_cost	number or null Shipping cost
unit_price	number or null The actual cost entered when receiving this line item
unit_price_tax_excluded	number or null Unit price excluding tax (on receiving)
unit_price_tax_included	number or null Unit price including tax (on receiving)
quantity_received	integer Quantity received so far
cancellation_date	string or null <date> Date the line item was deleted
cancellation_reason	string or null Reason of cancellation
internal_note	string or null Notes related to this order line, made for staff
vendor_note	string or null Notes related to this order line, made for vendor
basket_id	integer or null Basket this order is linked to
timestamp	string <date-time> Date and time this order line was last modified
rrp	number or null Retail cost for this item
rrp_tax_excluded	number or null Replacement cost for this item (tax excluded)
rrp_tax_included	number or null Replacement cost for this item (tax included)
ecost	number or null Effective cost
ecost_tax_excluded	number or null Effective cost (tax excluded)
ecost_tax_included	number or null Effective cost (tax included)
tax_rate_on_ordering	number or null Tax rate on ordering (%)
tax_rate_on_receiving	number or null Tax rate on receiving (%)
tax_value_on_ordering	number or null Tax value on ordering
tax_value_on_receiving	number or null Tax value on receiving
discount_rate	number or null Discount rate
fund_id	integer Internal identifier for the fund this order goes against
statistics_1	string or null Statistical field
statistics_2	string or null Statistical field (2)
statistics_1_authcat	string or null Statistical category for this order
statistics_2_authcat	string or null Statistical category for this order (2)
uncertain_price	boolean If this price was uncertain
claims_count	integer Generated claim letters count
last_claim_date	string or null <date> Last date a claim letter was generated
subscription_id	integer or null Subscription ID linking the order to a subscription
parent_order_id	integer or null Order ID of parent order line if exists
status	string Enum: "new" "ordered" "partial" "complete" "cancelled" The current order status
basket	object or null
biblio	object or null
fund	object or null
invoice	object or null
items	Array of any
subscription	object or null

Responses

Request samples

Payload

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

Response samples

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

getOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

path Parameters

order_id

required

integer

Internal order identifier

Responses

Response samples

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

updateOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

path Parameters

order_id

required

integer

Internal order identifier

Request Body schema: application/json
required

A JSON object representing an order

order_id	integer Internally assigned order identifier
biblio_id	integer or null Identifier for the linked bibliographic record
created_by	integer or null Interal patron identifier of the order line creator
entry_date	string or null <date> Date the bib was added to the basket
quantity	integer or null Ordered quantity
currency	string or null Currency used for the purchase
list_price	number or null Vendor price for the line item
replacement_price	number or null Replacement cost for this item
date_received	string or null <date> Date the order was received
invoice_id	integer or null Id of the order invoice
shipping_cost	number or null Shipping cost
unit_price	number or null The actual cost entered when receiving this line item
unit_price_tax_excluded	number or null Unit price excluding tax (on receiving)
unit_price_tax_included	number or null Unit price including tax (on receiving)
quantity_received	integer Quantity received so far
cancellation_date	string or null <date> Date the line item was deleted
cancellation_reason	string or null Reason of cancellation
internal_note	string or null Notes related to this order line, made for staff
vendor_note	string or null Notes related to this order line, made for vendor
basket_id	integer or null Basket this order is linked to
timestamp	string <date-time> Date and time this order line was last modified
rrp	number or null Retail cost for this item
rrp_tax_excluded	number or null Replacement cost for this item (tax excluded)
rrp_tax_included	number or null Replacement cost for this item (tax included)
ecost	number or null Effective cost
ecost_tax_excluded	number or null Effective cost (tax excluded)
ecost_tax_included	number or null Effective cost (tax included)
tax_rate_on_ordering	number or null Tax rate on ordering (%)
tax_rate_on_receiving	number or null Tax rate on receiving (%)
tax_value_on_ordering	number or null Tax value on ordering
tax_value_on_receiving	number or null Tax value on receiving
discount_rate	number or null Discount rate
fund_id	integer Internal identifier for the fund this order goes against
statistics_1	string or null Statistical field
statistics_2	string or null Statistical field (2)
statistics_1_authcat	string or null Statistical category for this order
statistics_2_authcat	string or null Statistical category for this order (2)
uncertain_price	boolean If this price was uncertain
claims_count	integer Generated claim letters count
last_claim_date	string or null <date> Last date a claim letter was generated
subscription_id	integer or null Subscription ID linking the order to a subscription
parent_order_id	integer or null Order ID of parent order line if exists
status	string Enum: "new" "ordered" "partial" "complete" "cancelled" The current order status
basket	object or null
biblio	object or null
fund	object or null
invoice	object or null
items	Array of any
subscription	object or null

Responses

Request samples

Payload

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

Response samples

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

deleteOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

path Parameters

order_id

required

integer

Internal order identifier

Responses

Response samples

401
403
404
500
503

Content type

application/json

{"error": "string"
}

listVendors

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

query Parameters

name	string Case insensitive search on vendor name
accountnumber	string Case insensitive search on vendor's account number
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}
]

addVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

Request Body schema: application/json
required

A JSON object representing a vendor

name required	string Vendor name
address1	string or null Vendor physical address (line 1)
address2	string or null Vendor physical address (line 2)
address3	string or null Vendor physical address (line 3)
address4	string or null Vendor physical address (line 4)
phone	string or null Vendor phone number
fax	string or null Vendor fax number
accountnumber	string or null Vendor account number
notes	string or null Vendor notes
postal	string or null Vendor postal address
url	string or null Vendor web address
active	boolean or null Is this vendor active
list_currency	string or null List prices currency
invoice_currency	string or null Invoice prices currency
gst	boolean or null Is the library taxed when buying from this vendor
list_includes_gst	boolean or null List prices include taxes
invoice_includes_gst	boolean or null Invoice prices include taxes
tax_rate	number or null Default tax rate for items ordered from this vendor
discount	number or null Default discount rate for items ordered from this vendor
deliverytime	integer or null Expected delivery time (in days)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

getVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

path Parameters

vendor_id

required

integer

Vendor id

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

updateVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

path Parameters

vendor_id

required

integer

Vendor id

Request Body schema: application/json
required

A JSON object representing a vendor

name required	string Vendor name
address1	string or null Vendor physical address (line 1)
address2	string or null Vendor physical address (line 2)
address3	string or null Vendor physical address (line 3)
address4	string or null Vendor physical address (line 4)
phone	string or null Vendor phone number
fax	string or null Vendor fax number
accountnumber	string or null Vendor account number
notes	string or null Vendor notes
postal	string or null Vendor postal address
url	string or null Vendor web address
active	boolean or null Is this vendor active
list_currency	string or null List prices currency
invoice_currency	string or null Invoice prices currency
gst	boolean or null Is the library taxed when buying from this vendor
list_includes_gst	boolean or null List prices include taxes
invoice_includes_gst	boolean or null Invoice prices include taxes
tax_rate	number or null Default tax rate for items ordered from this vendor
discount	number or null Default discount rate for items ordered from this vendor
deliverytime	integer or null Expected delivery time (in days)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

deleteVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

path Parameters

vendor_id

required

integer

Vendor id

Responses

Response samples

401
403
404
500
503

Content type

application/json

{"error": "string"
}

listFunds

koha-authorization: {"permissions":{"acquisition":"budget_manage_all"}}

query Parameters

name	string Case insensitive search on fund name
fund_owner_id	integer Display only the funds that belongs to the given patron ID
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

Content type

application/json

[{"fund_id": 0,
"code": "string",
"name": "string",
"library_id": "string",
"total_amount": 0,
"warn_at_percentage": 0,
"warn_at_amount": 0,
"notes": "string",
"budget_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"fund_owner_id": 0,
"fund_access": 0,
"parent_fund_id": 0,
"statistic1_auth_value_category": "string",
"statistic2_auth_value_category": "string"
}
]

orders

listOrders

koha-authorization: {"permissions":{"acquisition":["order_manage","order_manage_all"]}}

query Parameters

biblio_id	integer Identifier for a linked bibliographic record
basket_id	integer Identifier for a linked acquisition basket
fund_id	integer Identifier for the fund the order goes against
status	string Current status for the order. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

Content type

application/json

[{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}
]

addOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

Request Body schema: application/json
required

A JSON object representing an order

order_id	integer Internally assigned order identifier
biblio_id	integer or null Identifier for the linked bibliographic record
created_by	integer or null Interal patron identifier of the order line creator
entry_date	string or null <date> Date the bib was added to the basket
quantity	integer or null Ordered quantity
currency	string or null Currency used for the purchase
list_price	number or null Vendor price for the line item
replacement_price	number or null Replacement cost for this item
date_received	string or null <date> Date the order was received
invoice_id	integer or null Id of the order invoice
shipping_cost	number or null Shipping cost
unit_price	number or null The actual cost entered when receiving this line item
unit_price_tax_excluded	number or null Unit price excluding tax (on receiving)
unit_price_tax_included	number or null Unit price including tax (on receiving)
quantity_received	integer Quantity received so far
cancellation_date	string or null <date> Date the line item was deleted
cancellation_reason	string or null Reason of cancellation
internal_note	string or null Notes related to this order line, made for staff
vendor_note	string or null Notes related to this order line, made for vendor
basket_id	integer or null Basket this order is linked to
timestamp	string <date-time> Date and time this order line was last modified
rrp	number or null Retail cost for this item
rrp_tax_excluded	number or null Replacement cost for this item (tax excluded)
rrp_tax_included	number or null Replacement cost for this item (tax included)
ecost	number or null Effective cost
ecost_tax_excluded	number or null Effective cost (tax excluded)
ecost_tax_included	number or null Effective cost (tax included)
tax_rate_on_ordering	number or null Tax rate on ordering (%)
tax_rate_on_receiving	number or null Tax rate on receiving (%)
tax_value_on_ordering	number or null Tax value on ordering
tax_value_on_receiving	number or null Tax value on receiving
discount_rate	number or null Discount rate
fund_id	integer Internal identifier for the fund this order goes against
statistics_1	string or null Statistical field
statistics_2	string or null Statistical field (2)
statistics_1_authcat	string or null Statistical category for this order
statistics_2_authcat	string or null Statistical category for this order (2)
uncertain_price	boolean If this price was uncertain
claims_count	integer Generated claim letters count
last_claim_date	string or null <date> Last date a claim letter was generated
subscription_id	integer or null Subscription ID linking the order to a subscription
parent_order_id	integer or null Order ID of parent order line if exists
status	string Enum: "new" "ordered" "partial" "complete" "cancelled" The current order status
basket	object or null
biblio	object or null
fund	object or null
invoice	object or null
items	Array of any
subscription	object or null

Responses

Request samples

Payload

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

Response samples

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

getOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

path Parameters

order_id

required

integer

Internal order identifier

Responses

Response samples

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

updateOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

path Parameters

order_id

required

integer

Internal order identifier

Request Body schema: application/json
required

A JSON object representing an order

order_id	integer Internally assigned order identifier
biblio_id	integer or null Identifier for the linked bibliographic record
created_by	integer or null Interal patron identifier of the order line creator
entry_date	string or null <date> Date the bib was added to the basket
quantity	integer or null Ordered quantity
currency	string or null Currency used for the purchase
list_price	number or null Vendor price for the line item
replacement_price	number or null Replacement cost for this item
date_received	string or null <date> Date the order was received
invoice_id	integer or null Id of the order invoice
shipping_cost	number or null Shipping cost
unit_price	number or null The actual cost entered when receiving this line item
unit_price_tax_excluded	number or null Unit price excluding tax (on receiving)
unit_price_tax_included	number or null Unit price including tax (on receiving)
quantity_received	integer Quantity received so far
cancellation_date	string or null <date> Date the line item was deleted
cancellation_reason	string or null Reason of cancellation
internal_note	string or null Notes related to this order line, made for staff
vendor_note	string or null Notes related to this order line, made for vendor
basket_id	integer or null Basket this order is linked to
timestamp	string <date-time> Date and time this order line was last modified
rrp	number or null Retail cost for this item
rrp_tax_excluded	number or null Replacement cost for this item (tax excluded)
rrp_tax_included	number or null Replacement cost for this item (tax included)
ecost	number or null Effective cost
ecost_tax_excluded	number or null Effective cost (tax excluded)
ecost_tax_included	number or null Effective cost (tax included)
tax_rate_on_ordering	number or null Tax rate on ordering (%)
tax_rate_on_receiving	number or null Tax rate on receiving (%)
tax_value_on_ordering	number or null Tax value on ordering
tax_value_on_receiving	number or null Tax value on receiving
discount_rate	number or null Discount rate
fund_id	integer Internal identifier for the fund this order goes against
statistics_1	string or null Statistical field
statistics_2	string or null Statistical field (2)
statistics_1_authcat	string or null Statistical category for this order
statistics_2_authcat	string or null Statistical category for this order (2)
uncertain_price	boolean If this price was uncertain
claims_count	integer Generated claim letters count
last_claim_date	string or null <date> Last date a claim letter was generated
subscription_id	integer or null Subscription ID linking the order to a subscription
parent_order_id	integer or null Order ID of parent order line if exists
status	string Enum: "new" "ordered" "partial" "complete" "cancelled" The current order status
basket	object or null
biblio	object or null
fund	object or null
invoice	object or null
items	Array of any
subscription	object or null

Responses

Request samples

Payload

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

Response samples

Content type

application/json

{"order_id": 0,
"biblio_id": 0,
"created_by": 0,
"entry_date": "2019-08-24",
"quantity": 0,
"currency": "string",
"list_price": 0,
"replacement_price": 0,
"date_received": "2019-08-24",
"invoice_id": 0,
"shipping_cost": 0,
"unit_price": 0,
"unit_price_tax_excluded": 0,
"unit_price_tax_included": 0,
"quantity_received": 0,
"cancellation_date": "2019-08-24",
"cancellation_reason": "string",
"internal_note": "string",
"vendor_note": "string",
"basket_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"rrp": 0,
"rrp_tax_excluded": 0,
"rrp_tax_included": 0,
"ecost": 0,
"ecost_tax_excluded": 0,
"ecost_tax_included": 0,
"tax_rate_on_ordering": 0,
"tax_rate_on_receiving": 0,
"tax_value_on_ordering": 0,
"tax_value_on_receiving": 0,
"discount_rate": 0,
"fund_id": 0,
"statistics_1": "string",
"statistics_2": "string",
"statistics_1_authcat": "string",
"statistics_2_authcat": "string",
"uncertain_price": true,
"claims_count": 0,
"last_claim_date": "2019-08-24",
"subscription_id": 0,
"parent_order_id": 0,
"status": "new",
"basket": { },
"biblio": { },
"fund": { },
"invoice": { },
"items": [null
],
"subscription": { }
}

deleteOrder

koha-authorization: {"permissions":{"acquisition":"order_manage"}}

path Parameters

order_id

required

integer

Internal order identifier

Responses

Response samples

401
403
404
500
503

Content type

application/json

{"error": "string"
}

vendors

listVendors

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

query Parameters

name	string Case insensitive search on vendor name
accountnumber	string Case insensitive search on vendor's account number
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

Content type

application/json

[{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}
]

addVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

Request Body schema: application/json
required

A JSON object representing a vendor

name required	string Vendor name
address1	string or null Vendor physical address (line 1)
address2	string or null Vendor physical address (line 2)
address3	string or null Vendor physical address (line 3)
address4	string or null Vendor physical address (line 4)
phone	string or null Vendor phone number
fax	string or null Vendor fax number
accountnumber	string or null Vendor account number
notes	string or null Vendor notes
postal	string or null Vendor postal address
url	string or null Vendor web address
active	boolean or null Is this vendor active
list_currency	string or null List prices currency
invoice_currency	string or null Invoice prices currency
gst	boolean or null Is the library taxed when buying from this vendor
list_includes_gst	boolean or null List prices include taxes
invoice_includes_gst	boolean or null Invoice prices include taxes
tax_rate	number or null Default tax rate for items ordered from this vendor
discount	number or null Default discount rate for items ordered from this vendor
deliverytime	integer or null Expected delivery time (in days)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

getVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

path Parameters

vendor_id

required

integer

Vendor id

Responses

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

updateVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

path Parameters

vendor_id

required

integer

Vendor id

Request Body schema: application/json
required

A JSON object representing a vendor

name required	string Vendor name
address1	string or null Vendor physical address (line 1)
address2	string or null Vendor physical address (line 2)
address3	string or null Vendor physical address (line 3)
address4	string or null Vendor physical address (line 4)
phone	string or null Vendor phone number
fax	string or null Vendor fax number
accountnumber	string or null Vendor account number
notes	string or null Vendor notes
postal	string or null Vendor postal address
url	string or null Vendor web address
active	boolean or null Is this vendor active
list_currency	string or null List prices currency
invoice_currency	string or null Invoice prices currency
gst	boolean or null Is the library taxed when buying from this vendor
list_includes_gst	boolean or null List prices include taxes
invoice_includes_gst	boolean or null Invoice prices include taxes
tax_rate	number or null Default tax rate for items ordered from this vendor
discount	number or null Default discount rate for items ordered from this vendor
deliverytime	integer or null Expected delivery time (in days)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

Response samples

Content type

application/json

{"id": 0,
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"phone": "string",
"fax": "string",
"accountnumber": "string",
"notes": "string",
"postal": "string",
"url": "string",
"active": true,
"list_currency": "string",
"invoice_currency": "string",
"gst": true,
"list_includes_gst": true,
"invoice_includes_gst": true,
"tax_rate": 0,
"discount": 0,
"deliverytime": 0
}

deleteVendor

koha-authorization: {"permissions":{"acquisition":"vendors_manage"}}

path Parameters

vendor_id

required

integer

Vendor id

Responses

Response samples

401
403
404
500
503

Content type

application/json

{"error": "string"
}

funds

listFunds

koha-authorization: {"permissions":{"acquisition":"budget_manage_all"}}

query Parameters

name	string Case insensitive search on fund name
fund_owner_id	integer Display only the funds that belongs to the given patron ID
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

Content type

application/json

[{"fund_id": 0,
"code": "string",
"name": "string",
"library_id": "string",
"total_amount": 0,
"warn_at_percentage": 0,
"warn_at_amount": 0,
"notes": "string",
"budget_id": 0,
"timestamp": "2019-08-24T14:15:22Z",
"fund_owner_id": 0,
"fund_access": 0,
"parent_fund_id": 0,
"statistic1_auth_value_category": "string",
"statistic2_auth_value_category": "string"
}
]

patrons

listCheckouts

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

query Parameters

patron_id	integer Internal patron identifier
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
checked_in	boolean By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.

Responses

Response samples

200
403
404

Content type

application/json

[{"checkout_id": 0,
"patron_id": 0,
"item_id": 0,
"due_date": "2019-08-24T14:15:22Z",
"library_id": "string",
"issuer_id": 0,
"checkin_date": "2019-08-24T14:15:22Z",
"last_renewed_date": "2019-08-24T14:15:22Z",
"renewals": 0,
"unseen_renewals": 0,
"auto_renew": true,
"auto_renew_error": "string",
"timestamp": "string",
"checkout_date": "2019-08-24T14:15:22Z",
"onsite_checkout": true,
"note": "string",
"note_date": "2019-08-24",
"issuer": { }
}
]

getCheckout

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

path Parameters

checkout_id

required

integer

Internal checkout identifier

Responses

Response samples

200
403
404

Content type

application/json

{"checkout_id": 0,
"patron_id": 0,
"item_id": 0,
"due_date": "2019-08-24T14:15:22Z",
"library_id": "string",
"issuer_id": 0,
"checkin_date": "2019-08-24T14:15:22Z",
"last_renewed_date": "2019-08-24T14:15:22Z",
"renewals": 0,
"unseen_renewals": 0,
"auto_renew": true,
"auto_renew_error": "string",
"timestamp": "string",
"checkout_date": "2019-08-24T14:15:22Z",
"onsite_checkout": true,
"note": "string",
"note_date": "2019-08-24",
"issuer": { }
}

renewCheckout

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

path Parameters

checkout_id

required

integer

Internal checkout identifier

query Parameters

seen	integer Item was seen flag

Responses

Response samples

201
403
404

Content type

application/json

{"checkout_id": 0,
"patron_id": 0,
"item_id": 0,
"due_date": "2019-08-24T14:15:22Z",
"library_id": "string",
"issuer_id": 0,
"checkin_date": "2019-08-24T14:15:22Z",
"last_renewed_date": "2019-08-24T14:15:22Z",
"renewals": 0,
"unseen_renewals": 0,
"auto_renew": true,
"auto_renew_error": "string",
"timestamp": "string",
"checkout_date": "2019-08-24T14:15:22Z",
"onsite_checkout": true,
"note": "string",
"note_date": "2019-08-24",
"issuer": { }
}

listHolds

koha-authorization: {"permissions":{"borrowers":"edit_borrowers"}}

query Parameters

hold_id	integer Internal reserve identifier
patron_id	integer Internal patron identifier
hold_date	string <date> Hold
biblio_id	integer Internal biblio identifier
pickup_library_id	string Internal library identifier for the pickup library
cancellation_date	string <date> The date the hold was cancelled
notes	string Notes related to this hold
priority	integer Where in the queue the patron sits
status	string Found status
timestamp	string Time of latest update
item_id	integer Internal item identifier
waiting_date	string Date the item was marked as waiting for the patron
expiration_date	string Date the hold expires
lowest_priority	boolean Lowest priority
suspended	boolean Suspended
suspended_until	string Suspended until
non_priority	boolean Non priority hold
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

Content type

application/json

[{"hold_id": 0,
"patron_id": 0,
"hold_date": "2019-08-24",
"biblio_id": 0,
"pickup_library_id": "string",
"cancellation_date": "2019-08-24",
"notes": "string",
"priority": 0,
"status": "string",
"timestamp": "2019-08-24T14:15:22Z",
"item_id": "string",
"waiting_date": "2019-08-24",
"expiration_date": "2019-08-24",
"lowest_priority": true,
"suspended": true,
"suspended_until": "2019-08-24T14:15:22Z",
"non_priority": true,
"item_type": "string",
"item_level": true
}
]

addHold

koha-authorization: {"permissions":{"reserveforothers":"1"}}

Request Body schema: application/json
required

A JSON object containing informations about the new hold

patron_id required	integer Internal patron identifier
biblio_id	integer or null Internal biblio identifier
item_id	integer or null Internal item identifier
pickup_library_id required	string Internal library identifier for the pickup library
expiration_date	string or null <date> Hold end date
notes	string or null Notes related to this hold
item_type	string or null Limit hold on one itemtype (ignored for item-level holds)
non_priority	boolean or null Set this hold as non priority

Responses

Request samples

Payload

Content type

application/json

{"patron_id": 0,
"biblio_id": 0,
"item_id": 0,
"pickup_library_id": "string",
"expiration_date": "2019-08-24",
"notes": "string",
"item_type": "string",
"non_priority": true
}

Response samples

Content type

application/json

{"hold_id": 0,
"patron_id": 0,
"hold_date": "2019-08-24",
"biblio_id": 0,
"pickup_library_id": "string",
"cancellation_date": "2019-08-24",
"notes": "string",
"priority": 0,
"status": "string",
"timestamp": "2019-08-24T14:15:22Z",
"item_id": "string",
"waiting_date": "2019-08-24",
"expiration_date": "2019-08-24",
"lowest_priority": true,
"suspended": true,
"suspended_until": "2019-08-24T14:15:22Z",
"non_priority": true,
"item_type": "string",
"item_level": true
}

allows_renewalCheckout

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

path Parameters

checkout_id

required

integer

Internal checkout identifier

Responses

Response samples

200
403
404

Content type

application/json

{"allows_renewal": true,
"max_renewals": 0,
"current_renewals": 0,
"error": "string"
}

listPatrons

koha-authorization: {"permissions":{"borrowers":"1"}}

query Parameters

patron_id	string Search on patron_id
cardnumber	string Case insensitive search on cardnumber
surname	string Case insensitive search on surname
firstname	string Case insensitive search on firstname
title	string Case insensitive search on title
other_name	string Case insensitive search on othernames
initials	string Case insensitive search on initials
street_number	string Case insensitive search on streetnumber
street_type	string Case insensitive search on streettype
address	string Case insensitive search on address
address2	string Case insensitive search on address2
city	string Case insensitive search on city
state	string Case insensitive search on state
postal_code	string Case insensitive search on zipcode
country	string Case insensitive search on country
email	string Case insensitive search on email
phone	string Case insensitive search on phone
mobile	string Case insensitive search on mobile
fax	string Case insensitive search on fax
secondary_email	string Case insensitive search on secondary_email
secondary_phone	string Case insensitive search on secondary_phone
altaddress_street_number	string Case insensitive search on altaddress_street_number
altaddress_street_type	string Case insensitive search on altaddress_street_type
altaddress_address	string Case insensitive search on altaddress_address
altaddress_address2	string Case insensitive search on altaddress_address2
altaddress_city	string Case insensitive search on altaddress_city
altaddress_state	string Case insensitive search on altaddress_state
altaddress_postal_code	string Case insensitive search on altaddress_postal_code
altaddress_country	string Case insensitive search on altaddress_country
altaddress_email	string Case insensitive search on altaddress_email
altaddress_phone	string Case insensitive search on altaddress_phone
date_of_birth	string Case insensitive search on date_of_birth
library_id	string Case insensitive search on library_id
category_id	string Case insensitive search on category_id
date_enrolled	string Case insensitive search on date_enrolled
expiry_date	string Case insensitive search on expiry_date
incorrect_address	boolean Search on incorrect_address
patron_card_lost	boolean Search on patron_card_lost
restricted	boolean Filter search by restricted
guarantor_id	string Search on guarantor_id
staff_notes	string Case insensitive search on staff_notes
relationship_type	string Case insensitive search on relationship_type
gender	string Case insensitive search on gender
userid	string Case insensitive search on userid
opac_notes	string Case insensitive search on opac_notes
altaddress_notes	string Case insensitive search on altaddress_notes
statistics_1	string Case insensitive search on statistics_1
statistics_2	string Case insensitive search on statistics_2
autorenew_checkouts	boolean Search on autorenew_checkouts
altcontact_firstname	string Case insensitive search on altcontact_firstname
altcontact_surname	string Case insensitive search on altcontact_surname
altcontact_address	string Case insensitive search on altcontact_address
altcontact_address2	string Case insensitive search on altcontact_address2
altcontact_city	string Case insensitive search on altcontact_city
altcontact_state	string Case insensitive search on altcontact_state
altcontact_postal_code	string Case insensitive search on altcontact_postal_code
altcontact_country	string Case insensitive search on altcontact_country
altcontact_phone	string Case insensitive search on altcontact_phone
sms_number	string Case insensitive search on sms_number
sms_provider_id	string Case insensitive search on sms_provider_id
privacy	string Search on privacy
privacy_guarantor_checkouts	string Search on privacy_guarantor_checkouts
check_previous_checkout	string Case insensitive search on check_previous_checkout
updated_on	string Search on updated_on
last_seen	string Case insensitive search on last_seen
lang	string Case insensitive search on lang
login_attempts	string Search on login_attempts
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing

Responses

Response samples

200
401
403
500

Content type

application/json

[{"patron_id": 0,
"cardnumber": "string",
"surname": "string",
"firstname": "string",
"title": "string",
"other_name": "string",
"initials": "string",
"street_number": "string",
"street_type": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"fax": "string",
"secondary_email": "string",
"secondary_phone": "string",
"altaddress_street_number": "string",
"altaddress_street_type": "string",
"altaddress_address": "string",
"altaddress_address2": "string",
"altaddress_city": "string",
"altaddress_state": "string",
"altaddress_postal_code": "string",
"altaddress_country": "string",
"altaddress_email": "string",
"altaddress_phone": "string",
"date_of_birth": "2019-08-24",
"library_id": "string",
"category_id": "string",
"date_enrolled": "2019-08-24",
"expiry_date": "2019-08-24",
"date_renewed": "2019-08-24",
"incorrect_address": true,
"patron_card_lost": true,
"restricted": true,
"staff_notes": "string",
"relationship_type": "string",
"gender": "string",
"userid": "string",
"opac_notes": "string",
"altaddress_notes": "string",
"statistics_1": "string",
"statistics_2": "string",
"autorenew_checkouts": true,
"altcontact_firstname": "string",
"altcontact_surname": "string",
"altcontact_address": "string",
"altcontact_address2": "string",
"altcontact_city": "string",
"altcontact_state": "string",
"altcontact_postal_code": "string",
"altcontact_country": "string",
"altcontact_phone": "string",
"sms_number": "string",
"sms_provider_id": 0,
"privacy": 0,
"privacy_guarantor_checkouts": 0,
"privacy_guarantor_fines": true,
"check_previous_checkout": "string",
"updated_on": "2019-08-24T14:15:22Z",
"last_seen": "2019-08-24T14:15:22Z",
"lang": "string",
"login_attempts": 0,
"overdrive_auth_token": "string",
"anonymized": true
}
]

addPatron

koha-authorization: {"permissions":{"borrowers":"edit_borrowers"}}

Request Body schema: application/json
required

A JSON object containing information about the new patron

patron_id	integer (patron_id) Internal patron identifier
cardnumber	string or null (cardnumber) library assigned user identifier
surname required	string or null (surname) patron's last name
firstname	string or null (firstname) patron's first name
title	string or null patron's title
other_name	string or null any other names associated with the patron
initials	string or null initials of the patron
street_number	string or null street number of patron's primary address
street_type	string or null street type of patron's primary address
address required	string or null first address line of patron's primary address
address2	string or null second address line of patron's primary address
city required	string or null city or town of patron's primary address
state	string or null state or province of patron's primary address
postal_code	string or null zip or postal code of patron's primary address
country	string or null country of patron's primary address
email	string or null (email) primary email address for patron's primary address
phone	string or null (phone) primary phone number for patron's primary address
mobile	string or null the other phone number for patron's primary address
fax	string or null fax number for patron's primary address
secondary_email	string or null secondary email address for patron's primary address
secondary_phone	string or null secondary phone number for patron's primary address
altaddress_street_number	string or null street number of patron's alternate address
altaddress_street_type	string or null street type of patron's alternate address
altaddress_address	string or null first address line of patron's alternate address
altaddress_address2	string or null second address line of patron's alternate address
altaddress_city	string or null city or town of patron's alternate address
altaddress_state	string or null state or province of patron's alternate address
altaddress_postal_code	string or null zip or postal code of patron's alternate address
altaddress_country	string or null country of patron's alternate address
altaddress_email	string or null email address for patron's alternate address
altaddress_phone	string or null phone number for patron's alternate address
date_of_birth	string or null <date> patron's date of birth
library_id required	string Internal identifier for the patron's home library
category_id required	string Internal identifier for the patron's category
date_enrolled	string or null <date> date the patron was added to Koha
expiry_date	string or null <date> date the patron's card is set to expire
date_renewed	string or null <date> date the patron's card was last renewed
incorrect_address	boolean or null set to 1 if library marked this patron as having an unconfirmed address
patron_card_lost	boolean or null set to 1 if library marked this patron as having lost his card
staff_notes	string or null a note on the patron's account
relationship_type	string or null used for children to include the relationship to their guarantor
gender	string or null patron's gender
userid	string or null patron's login
opac_notes	string or null a note on the patron's account visible in OPAC and staff interface
altaddress_notes	string or null a note related to patron's alternate address
statistics_1	string or null a field that can be used for any information unique to the library
statistics_2	string or null a field that can be used for any information unique to the library
autorenew_checkouts	boolean indicate whether auto-renewal is allowed for patron
altcontact_firstname	string or null first name of alternate contact for the patron
altcontact_surname	string or null surname or last name of the alternate contact for the patron
altcontact_address	string or null the first address line for the alternate contact for the patron
altcontact_address2	string or null the second address line for the alternate contact for the patron
altcontact_city	string or null the city for the alternate contact for the patron
altcontact_state	string or null the state for the alternate contact for the patron
altcontact_postal_code	string or null the zipcode for the alternate contact for the patron
altcontact_country	string or null the country for the alternate contact for the patron
altcontact_phone	string or null the phone number for the alternate contact for the patron
sms_number	string or null the mobile phone number where the patron would like to receive notices (if SMS turned on)
sms_provider_id	integer or null the provider of the mobile phone number defined in smsalertnumber
privacy	integer patron's privacy settings related to their checkout history
privacy_guarantor_checkouts	integer controls if relatives can see this patron's checkouts
privacy_guarantor_fines	boolean controls if relatives can see this patron's fines
check_previous_checkout	string produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'
updated_on	string <date-time> time of last change could be useful for synchronization with external systems (among others)
last_seen	string or null <date-time> last time a patron has been seen (connected at the OPAC or staff interface)
lang	string lang to use to send notices to this patron
login_attempts	integer or null number of failed login attemps
overdrive_auth_token	string or null persist OverDrive auth token

Responses

Request samples

Payload

Content type

application/json

{"patron_id": 0,
"cardnumber": "string",
"surname": "string",
"firstname": "string",
"title": "string",
"other_name": "string",
"initials": "string",
"street_number": "string",
"street_type": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"fax": "string",
"secondary_email": "string",
"secondary_phone": "string",
"altaddress_street_number": "string",
"altaddress_street_type": "string",
"altaddress_address": "string",
"altaddress_address2": "string",
"altaddress_city": "string",
"altaddress_state": "string",
"altaddress_postal_code": "string",
"altaddress_country": "string",
"altaddress_email": "string",
"altaddress_phone": "string",
"date_of_birth": "2019-08-24",
"library_id": "string",
"category_id": "string",
"date_enrolled": "2019-08-24",
"expiry_date": "2019-08-24",
"date_renewed": "2019-08-24",
"incorrect_address": true,
"patron_card_lost": true,
"staff_notes": "string",
"relationship_type": "string",
"gender": "string",
"userid": "string",
"opac_notes": "string",
"altaddress_notes": "string",
"statistics_1": "string",
"statistics_2": "string",
"autorenew_checkouts": true,
"altcontact_firstname": "string",
"altcontact_surname": "string",
"altcontact_address": "string",
"altcontact_address2": "string",
"altcontact_city": "string",
"altcontact_state": "string",
"altcontact_postal_code": "string",
"altcontact_country": "string",
"altcontact_phone": "string",
"sms_number": "string",
"sms_provider_id": 0,
"privacy": 0,
"privacy_guarantor_checkouts": 0,
"privacy_guarantor_fines": true,
"check_previous_checkout": "string",
"updated_on": "2019-08-24T14:15:22Z",
"last_seen": "2019-08-24T14:15:22Z",
"lang": "string",
"login_attempts": 0,
"overdrive_auth_token": "string"
}

Response samples

Content type

application/json

[{"patron_id": 0,
"cardnumber": "string",
"surname": "string",
"firstname": "string",
"title": "string",
"other_name": "string",
"initials": "string",
"street_number": "string",
"street_type": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"fax": "string",
"secondary_email": "string",
"secondary_phone": "string",
"altaddress_street_number": "string",
"altaddress_street_type": "string",
"altaddress_address": "string",
"altaddress_address2": "string",
"altaddress_city": "string",
"altaddress_state": "string",
"altaddress_postal_code": "string",
"altaddress_country": "string",
"altaddress_email": "string",
"altaddress_phone": "string",
"date_of_birth": "2019-08-24",
"library_id": "string",
"category_id": "string",
"date_enrolled": "2019-08-24",
"expiry_date": "2019-08-24",
"date_renewed": "2019-08-24",
"incorrect_address": true,
"patron_card_lost": true,
"restricted": true,
"staff_notes": "string",
"relationship_type": "string",
"gender": "string",
"userid": "string",
"opac_notes": "string",
"altaddress_notes": "string",
"statistics_1": "string",
"statistics_2": "string",
"autorenew_checkouts": true,
"altcontact_firstname": "string",
"altcontact_surname": "string",
"altcontact_address": "string",
"altcontact_address2": "string",
"altcontact_city": "string",
"altcontact_state": "string",
"altcontact_postal_code": "string",
"altcontact_country": "string",
"altcontact_phone": "string",
"sms_number": "string",
"sms_provider_id": 0,
"privacy": 0,
"privacy_guarantor_checkouts": 0,
"privacy_guarantor_fines": true,
"check_previous_checkout": "string",
"updated_on": "2019-08-24T14:15:22Z",
"last_seen": "2019-08-24T14:15:22Z",
"lang": "string",
"login_attempts": 0,
"overdrive_auth_token": "string",
"anonymized": true
}
]

getPatron

koha-authorization: {"permissions":{"borrowers":"edit_borrowers"}}

path Parameters

patron_id

required

integer

Internal patron identifier

Responses

Response samples

Content type

application/json

{"patron_id": 0,
"cardnumber": "string",
"surname": "string",
"firstname": "string",
"title": "string",
"other_name": "string",
"initials": "string",
"street_number": "string",
"street_type": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"fax": "string",
"secondary_email": "string",
"secondary_phone": "string",
"altaddress_street_number": "string",
"altaddress_street_type": "string",
"altaddress_address": "string",
"altaddress_address2": "string",
"altaddress_city": "string",
"altaddress_state": "string",
"altaddress_postal_code": "string",
"altaddress_country": "string",
"altaddress_email": "string",
"altaddress_phone": "string",
"date_of_birth": "2019-08-24",
"library_id": "string",
"category_id": "string",
"date_enrolled": "2019-08-24",
"expiry_date": "2019-08-24",
"date_renewed": "2019-08-24",
"incorrect_address": true,
"patron_card_lost": true,
"restricted": true,
"staff_notes": "string",
"relationship_type": "string",
"gender": "string",
"userid": "string",
"opac_notes": "string",
"altaddress_notes": "string",
"statistics_1": "string",
"statistics_2": "string",
"autorenew_checkouts": true,
"altcontact_firstname": "string",
"altcontact_surname": "string",
"altcontact_address": "string",
"altcontact_address2": "string",
"altcontact_city": "string",
"altcontact_state": "string",
"altcontact_postal_code": "string",
"altcontact_country": "string",
"altcontact_phone": "string",
"sms_number": "string",
"sms_provider_id": 0,
"privacy": 0,
"privacy_guarantor_checkouts": 0,
"privacy_guarantor_fines": true,
"check_previous_checkout": "string",
"updated_on": "2019-08-24T14:15:22Z",
"last_seen": "2019-08-24T14:15:22Z",
"lang": "string",
"login_attempts": 0,
"overdrive_auth_token": "string",
"anonymized": true
}

updatePatron

koha-authorization: {"permissions":{"borrowers":"1"}}

path Parameters

patron_id

required

integer

Internal patron identifier

Request Body schema: application/json
required

A JSON object containing new information about existing patron

patron_id	integer (patron_id) Internal patron identifier
cardnumber	string or null (cardnumber) library assigned user identifier
surname required	string or null (surname) patron's last name
firstname	string or null (firstname) patron's first name
title	string or null patron's title
other_name	string or null any other names associated with the patron
initials	string or null initials of the patron
street_number	string or null street number of patron's primary address
street_type	string or null street type of patron's primary address
address required	string or null first address line of patron's primary address
address2	string or null second address line of patron's primary address
city required	string or null city or town of patron's primary address
state	string or null state or province of patron's primary address
postal_code	string or null zip or postal code of patron's primary address
country	string or null country of patron's primary address
email	string or null (email) primary email address for patron's primary address
phone	string or null (phone) primary phone number for patron's primary address
mobile	string or null the other phone number for patron's primary address
fax	string or null fax number for patron's primary address
secondary_email	string or null secondary email address for patron's primary address
secondary_phone	string or null secondary phone number for patron's primary address
altaddress_street_number	string or null street number of patron's alternate address
altaddress_street_type	string or null street type of patron's alternate address
altaddress_address	string or null first address line of patron's alternate address
altaddress_address2	string or null second address line of patron's alternate address
altaddress_city	string or null city or town of patron's alternate address
altaddress_state	string or null state or province of patron's alternate address
altaddress_postal_code	string or null zip or postal code of patron's alternate address
altaddress_country	string or null country of patron's alternate address
altaddress_email	string or null email address for patron's alternate address
altaddress_phone	string or null phone number for patron's alternate address
date_of_birth	string or null <date> patron's date of birth
library_id required	string Internal identifier for the patron's home library
category_id required	string Internal identifier for the patron's category
date_enrolled	string or null <date> date the patron was added to Koha
expiry_date	string or null <date> date the patron's card is set to expire
date_renewed	string or null <date> date the patron's card was last renewed
incorrect_address	boolean or null set to 1 if library marked this patron as having an unconfirmed address
patron_card_lost	boolean or null set to 1 if library marked this patron as having lost his card
staff_notes	string or null a note on the patron's account
relationship_type	string or null used for children to include the relationship to their guarantor
gender	string or null patron's gender
userid	string or null patron's login
opac_notes	string or null a note on the patron's account visible in OPAC and staff interface
altaddress_notes	string or null a note related to patron's alternate address
statistics_1	string or null a field that can be used for any information unique to the library
statistics_2	string or null a field that can be used for any information unique to the library
autorenew_checkouts	boolean indicate whether auto-renewal is allowed for patron
altcontact_firstname	string or null first name of alternate contact for the patron
altcontact_surname	string or null surname or last name of the alternate contact for the patron
altcontact_address	string or null the first address line for the alternate contact for the patron
altcontact_address2	string or null the second address line for the alternate contact for the patron
altcontact_city	string or null the city for the alternate contact for the patron
altcontact_state	string or null the state for the alternate contact for the patron
altcontact_postal_code	string or null the zipcode for the alternate contact for the patron
altcontact_country	string or null the country for the alternate contact for the patron
altcontact_phone	string or null the phone number for the alternate contact for the patron
sms_number	string or null the mobile phone number where the patron would like to receive notices (if SMS turned on)
sms_provider_id	integer or null the provider of the mobile phone number defined in smsalertnumber
privacy	integer patron's privacy settings related to their checkout history
privacy_guarantor_checkouts	integer controls if relatives can see this patron's checkouts
privacy_guarantor_fines	boolean controls if relatives can see this patron's fines
check_previous_checkout	string produce a warning for this patron if this item has previously been checked out to this patron if 'yes', not if 'no', defer to category setting if 'inherit'
updated_on	string <date-time> time of last change could be useful for synchronization with external systems (among others)
last_seen	string or null <date-time> last time a patron has been seen (connected at the OPAC or staff interface)
lang	string lang to use to send notices to this patron
login_attempts	integer or null number of failed login attemps
overdrive_auth_token	string or null persist OverDrive auth token

Responses

Request samples

Payload

Content type

application/json

{"patron_id": 0,
"cardnumber": "string",
"surname": "string",
"firstname": "string",
"title": "string",
"other_name": "string",
"initials": "string",
"street_number": "string",
"street_type": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"fax": "string",
"secondary_email": "string",
"secondary_phone": "string",
"altaddress_street_number": "string",
"altaddress_street_type": "string",
"altaddress_address": "string",
"altaddress_address2": "string",
"altaddress_city": "string",
"altaddress_state": "string",
"altaddress_postal_code": "string",
"altaddress_country": "string",
"altaddress_email": "string",
"altaddress_phone": "string",
"date_of_birth": "2019-08-24",
"library_id": "string",
"category_id": "string",
"date_enrolled": "2019-08-24",
"expiry_date": "2019-08-24",
"date_renewed": "2019-08-24",
"incorrect_address": true,
"patron_card_lost": true,
"staff_notes": "string",
"relationship_type": "string",
"gender": "string",
"userid": "string",
"opac_notes": "string",
"altaddress_notes": "string",
"statistics_1": "string",
"statistics_2": "string",
"autorenew_checkouts": true,
"altcontact_firstname": "string",
"altcontact_surname": "string",
"altcontact_address": "string",
"altcontact_address2": "string",
"altcontact_city": "string",
"altcontact_state": "string",
"altcontact_postal_code": "string",
"altcontact_country": "string",
"altcontact_phone": "string",
"sms_number": "string",
"sms_provider_id": 0,
"privacy": 0,
"privacy_guarantor_checkouts": 0,
"privacy_guarantor_fines": true,
"check_previous_checkout": "string",
"updated_on": "2019-08-24T14:15:22Z",
"last_seen": "2019-08-24T14:15:22Z",
"lang": "string",
"login_attempts": 0,
"overdrive_auth_token": "string"
}

Response samples

Content type

application/json

[{"patron_id": 0,
"cardnumber": "string",
"surname": "string",
"firstname": "string",
"title": "string",
"other_name": "string",
"initials": "string",
"street_number": "string",
"street_type": "string",
"address": "string",
"address2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"email": "string",
"phone": "string",
"mobile": "string",
"fax": "string",
"secondary_email": "string",
"secondary_phone": "string",
"altaddress_street_number": "string",
"altaddress_street_type": "string",
"altaddress_address": "string",
"altaddress_address2": "string",
"altaddress_city": "string",
"altaddress_state": "string",
"altaddress_postal_code": "string",
"altaddress_country": "string",
"altaddress_email": "string",
"altaddress_phone": "string",
"date_of_birth": "2019-08-24",
"library_id": "string",
"category_id": "string",
"date_enrolled": "2019-08-24",
"expiry_date": "2019-08-24",
"date_renewed": "2019-08-24",
"incorrect_address": true,
"patron_card_lost": true,
"restricted": true,
"staff_notes": "string",
"relationship_type": "string",
"gender": "string",
"userid": "string",
"opac_notes": "string",
"altaddress_notes": "string",
"statistics_1": "string",
"statistics_2": "string",
"autorenew_checkouts": true,
"altcontact_firstname": "string",
"altcontact_surname": "string",
"altcontact_address": "string",
"altcontact_address2": "string",
"altcontact_city": "string",
"altcontact_state": "string",
"altcontact_postal_code": "string",
"altcontact_country": "string",
"altcontact_phone": "string",
"sms_number": "string",
"sms_provider_id": 0,
"privacy": 0,
"privacy_guarantor_checkouts": 0,
"privacy_guarantor_fines": true,
"check_previous_checkout": "string",
"updated_on": "2019-08-24T14:15:22Z",
"last_seen": "2019-08-24T14:15:22Z",
"lang": "string",
"login_attempts": 0,
"overdrive_auth_token": "string",
"anonymized": true
}
]

deletePatron

koha-authorization: {"permissions":{"borrowers":"1"}}

path Parameters

patron_id

required

integer

Internal patron identifier

Responses

Response samples

Content type

application/json

{"error": "string"
}

getPatronHolds

koha-authorization: {"permissions":{"borrowers":"edit_borrowers"}}

path Parameters

patron_id

required

integer

Internal patron identifier

query Parameters

_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing
q	string Query filter sent as a request parameter

header Parameters

x-koha-query

string

Query filter sent as a request header

Request Body schema: application/json

Query filter sent through request's body

One of

object

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

Content type

application/json

[{"hold_id": 0,
"patron_id": 0,
"hold_date": "2019-08-24",
"biblio_id": 0,
"pickup_library_id": "string",
"cancellation_date": "2019-08-24",
"notes": "string",
"priority": 0,
"status": "string",
"timestamp": "2019-08-24T14:15:22Z",
"item_id": "string",
"waiting_date": "2019-08-24",
"expiration_date": "2019-08-24",
"lowest_priority": true,
"suspended": true,
"suspended_until": "2019-08-24T14:15:22Z",
"non_priority": true,
"item_type": "string",
"item_level": true
}
]

checkouts

listCheckouts

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

query Parameters

patron_id	integer Internal patron identifier
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
checked_in	boolean By default, current checkouts are returned, when this is true then checked in checkouts are returned as result.

Responses

Response samples

200
403
404

Content type

application/json

[{"checkout_id": 0,
"patron_id": 0,
"item_id": 0,
"due_date": "2019-08-24T14:15:22Z",
"library_id": "string",
"issuer_id": 0,
"checkin_date": "2019-08-24T14:15:22Z",
"last_renewed_date": "2019-08-24T14:15:22Z",
"renewals": 0,
"unseen_renewals": 0,
"auto_renew": true,
"auto_renew_error": "string",
"timestamp": "string",
"checkout_date": "2019-08-24T14:15:22Z",
"onsite_checkout": true,
"note": "string",
"note_date": "2019-08-24",
"issuer": { }
}
]

getCheckout

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

path Parameters

checkout_id

required

integer

Internal checkout identifier

Responses

Response samples

200
403
404

Content type

application/json

{"checkout_id": 0,
"patron_id": 0,
"item_id": 0,
"due_date": "2019-08-24T14:15:22Z",
"library_id": "string",
"issuer_id": 0,
"checkin_date": "2019-08-24T14:15:22Z",
"last_renewed_date": "2019-08-24T14:15:22Z",
"renewals": 0,
"unseen_renewals": 0,
"auto_renew": true,
"auto_renew_error": "string",
"timestamp": "string",
"checkout_date": "2019-08-24T14:15:22Z",
"onsite_checkout": true,
"note": "string",
"note_date": "2019-08-24",
"issuer": { }
}

renewCheckout

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

path Parameters

checkout_id

required

integer

Internal checkout identifier

query Parameters

seen	integer Item was seen flag

Responses

Response samples

201
403
404

Content type

application/json

{"checkout_id": 0,
"patron_id": 0,
"item_id": 0,
"due_date": "2019-08-24T14:15:22Z",
"library_id": "string",
"issuer_id": 0,
"checkin_date": "2019-08-24T14:15:22Z",
"last_renewed_date": "2019-08-24T14:15:22Z",
"renewals": 0,
"unseen_renewals": 0,
"auto_renew": true,
"auto_renew_error": "string",
"timestamp": "string",
"checkout_date": "2019-08-24T14:15:22Z",
"onsite_checkout": true,
"note": "string",
"note_date": "2019-08-24",
"issuer": { }
}

allows_renewalCheckout

koha-authorization: {"permissions":{"circulate":"circulate_remaining_permissions"}}

path Parameters

checkout_id

required

integer

Internal checkout identifier

Responses

Response samples

200
403
404

Content type

application/json

{"allows_renewal": true,
"max_renewals": 0,
"current_renewals": 0,
"error": "string"
}

cities

getCirculationRuleKinds

Responses

Response samples

200
403
500

Content type

application/json

{"property1": {"scope": ["branchcode"
]
},
"property2": {"scope": ["branchcode"
]
}
}

listCities

koha-authorization: {"permissions":{"catalogue":"1"}}

query Parameters

name	string Case insensative search on city name
state	string Case insensative search on city state
country	string Case insensative search on city country
postal_code	string Case Insensative search on city postal code
_match	string Enum: "contains" "exact" "starts_with" "ends_with" Matching criteria
_order_by	Array of strings Sorting criteria
_page	integer Page number, for paginated object listing
_per_page	integer Page size, for paginated object listing
q	string Query filter sent as a request parameter

header Parameters

x-koha-query

string

Query filter sent as a request header

Request Body schema: application/json

Query filter sent through request's body

One of

object

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

200
403
500
503

Content type

application/json

[{"city_id": 0,
"name": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}
]

addCity

koha-authorization: {"permissions":{"parameters":"manage_cities"}}

Request Body schema: application/json
required

A JSON object containing informations about the new hold

name required	string city name
state required	string or null city state
postal_code required	string or null city postal code
country required	string or null city country

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}

Response samples

201
401
403
500
503

Content type

application/json

{"city_id": 0,
"name": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}

getCity

koha-authorization: {"permissions":{"catalogue":"1"}}

path Parameters

city_id

required

integer

City internal identifier

Responses

Response samples

200
404
500
503

Content type

application/json

{"city_id": 0,
"name": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}

updateCity

koha-authorization: {"permissions":{"parameters":"manage_cities"}}

path Parameters

city_id

required

integer

City internal identifier

Request Body schema: application/json
required

A city object

name required	string city name
state required	string or null city state
postal_code required	string or null city postal code
country required	string or null city country

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}

Response samples

Content type

application/json

{"city_id": 0,
"name": "string",
"state": "string",
"postal_code": "string",
"country": "string"
}

deleteCity

koha-authorization: {"permissions":{"parameters":"manage_cities"}}

path Parameters

city_id

required

integer

City internal identifier

Responses

Response samples

401
403
404
500
503

Content type

application/json

{"error": "string"
}

biblios

getBiblio

koha-authorization: {"permissions":{"catalogue":"1"}}

path Parameters

biblio_id

required

integer

Record internal identifier

Responses

Response samples

Content type

application/json

{"error": "string"
}

deleteBiblio

koha-authorization: {"permissions":{"editcatalogue":"edit_catalogue"}}

path Parameters

biblio_id

required

integer

Record internal identifier

Responses

Response samples

Content type

application/json

"string"

Koha REST API (1)

oauth

tokenOAuth

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

acquisitions

listOrders

query Parameters

Responses

Response samples

addOrder

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getOrder

path Parameters

Responses

Response samples

updateOrder

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

deleteOrder

path Parameters

Responses

Response samples

listVendors

query Parameters

Responses

Response samples

addVendor

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getVendor

path Parameters

Responses

Response samples

updateVendor

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

deleteVendor

path Parameters

Responses

Response samples

listFunds

query Parameters

Responses

Response samples

orders

listOrders

query Parameters

Responses

Response samples

addOrder

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

getOrder

path Parameters

Responses

Response samples

updateOrder

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

deleteOrder

path Parameters

Responses

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required