Attachment #96966 for bug #18731

View | Details | Raw Unified | Return to bug 18731
Collapse All | Expand All

Lines 2-16 Link Here

(-)a/api/v1/swagger/definitions.json (-3 / +12 lines)
2	"account_line": {	2	"account_line": {
3	"$ref": "definitions/account_line.json"	3	"$ref": "definitions/account_line.json"
4	},	4	},
		5	"basket": {
		6	"$ref": "definitions/basket.json"
		7	},
5	"city": {	8	"city": {
6	"$ref": "definitions/city.json"	9	"$ref": "definitions/city.json"
7	},	10	},
8	"error": {	11	"error": {
9	"$ref": "definitions/error.json"	12	"$ref": "definitions/error.json"
10	},	13	},
		14	"fund": {
		15	"$ref": "definitions/fund.json"
		16	},
11	"hold": {	17	"hold": {
12	"$ref": "definitions/hold.json"	18	"$ref": "definitions/hold.json"
13	},	19	},
		20	"invoice": {
		21	"$ref": "definitions/invoice.json"
		22	},
14	"checkouts": {	23	"checkouts": {
15	"$ref": "definitions/checkouts.json"	24	"$ref": "definitions/checkouts.json"
16	},	25	},
Lines 26-31 Link Here
26	"item": {	35	"item": {
27	"$ref": "definitions/item.json"	36	"$ref": "definitions/item.json"
28	},	37	},
		38	"order": {
		39	"$ref": "definitions/order.json"
		40	},
29	"patron": {	41	"patron": {
30	"$ref": "definitions/patron.json"	42	"$ref": "definitions/patron.json"
31	},	43	},
Lines 41-49 Link Here
41	"vendor": {	53	"vendor": {
42	"$ref": "definitions/vendor.json"	54	"$ref": "definitions/vendor.json"
43	},	55	},
44	"fund": {
45	"$ref": "definitions/fund.json"
46	},
47	"return_claim": {	56	"return_claim": {
48	"$ref": "definitions/return_claim.json"	57	"$ref": "definitions/return_claim.json"
49	}	58	}




{
    "type": "object",
    "properties": {
        "basket_id": {
            "type": "integer",
            "description": "Internal identifier for the basket"
        },
        "name": {
            "type": "string",
            "description": "Basket name"
        },
        "internal_note": {
            "type": [
                "string",
                "null"
            ],
            "description": "Internal note"
        },
        "vendor_note": {
            "type": [
                "string",
                "null"
            ],
            "description": "Vendor note"
        },
        "contract_id": {
            "type": "integer",
            "description": "Internal identifier of the linked contract"
        },
        "creation_date": {
            "type": [
                "string",
                "null"
            ],
            "format": "date",
            "description": "The date the basket was created"
        },
        "close_date": {
            "type": [
                "string",
                "null"
            ],
            "format": "date",
            "description": "The date the basket was closed"
        },
        "vendor_id": {
            "type": "integer",
            "description": "Internal identifier for the vendor"
        },
        "authorised_by": {
            "type": [
                "integer",
                "null"
            ],
            "description": "Internal patron identifier of the basket creator"
        },
        "basket_group_id": {
            "type": [
                "integer",
                "null"
            ],
            "description": "links this basket to its group (aqbasketgroups.id)"
        },
        "delivery_library": {
            "type": [
                "string",
                "null"
            ],
            "description": "basket delivery place"
        },
        "billing_library": {
            "type": [
                "string",
                "null"
            ],
            "description": "basket billing place"
        },
        "library_id": {
            "type": [
                "integer",
                "null"
            ],
            "description": "Library the basket belongs to"
        },
        "standing": {
            "type": "boolean",
            "description": "If the orders in this basket are standing"
        },
        "create_items": {
            "type": "string",
            "enum": [
                "ordering",
                "receiving",
                "cataloguing"
            ],
            "description": "When items should be created for orders in this basket (Options: 'ordering', 'receiving', 'cataloguing'. Null means system wide config)"
        }
    }
}




{
    "type": "object",
    "properties": {
        "invoice_id": {
            "type": "integer",
            "description": "Internal identifier for the incoide. Generated on POST"
        },
        "invoice_number": {
            "type": "string",
            "description": "Invoice number assigned by the vendor"
        },
        "vendor_id": {
            "type": "integer",
            "description": "Internal identifier for the vendor"
        },
        "shipping_date": {
            "type": [
                "string",
                "null"
            ],
            "format": "date",
            "description": "Date of shipping"
        },
        "invoice_date": {
            "type": [
                "string",
                "null"
            ],
            "format": "date",
            "description": "Date of billing"
        },
        "closed": {
            "type": "boolean",
            "description": "If the invoice is closed"
        },
        "close_date": {
            "type": "string",
            "format": "date",
            "description": "Invoice close date (only when the invoice is closed)"
        },
        "shipping_cost": {
            "type": [
                "integer",
                "null"
            ],
            "description": "Shipping cost"
        },
        "shipping_cost_budget_id": {
            "type": [
                "integer",
                "null"
            ],
            "description": "Shipping cost linking to budget"
        }
    },
    "additionalProperties": false
}




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

Lines 23-28 Link Here

(-)a/api/v1/swagger/parameters.json (+3 lines)
23	"item_id_pp": {	23	"item_id_pp": {
24	"$ref": "parameters/item.json#/item_id_pp"	24	"$ref": "parameters/item.json#/item_id_pp"
25	},	25	},
		26	"order_id_pp": {
		27	"$ref": "parameters/order.json#/order_id_pp"
		28	},
26	"vendoridPathParam": {	29	"vendoridPathParam": {
27	"$ref": "parameters/vendor.json#/vendoridPathParam"	30	"$ref": "parameters/vendor.json#/vendoridPathParam"
28	},	31	},

Line 0 Link Here

(-)a/api/v1/swagger/parameters/order.json (+9 lines)
	1	{
	2	"order_id_pp": {
	3	"name": "order_id",
	4	"in": "path",
	5	"description": "Internal order identifier",
	6	"required": true,
	7	"type": "integer"
	8	}
	9	}

Lines 2-7 Link Here

(-)a/api/v1/swagger/paths.json (+6 lines)
2	"/oauth/token": {	2	"/oauth/token": {
3	"$ref": "paths/oauth.json#/~1oauth~1token"	3	"$ref": "paths/oauth.json#/~1oauth~1token"
4	},	4	},
		5	"/acquisitions/orders": {
		6	"$ref": "paths/acquisitions_orders.json#/~1acquisitions~1orders"
		7	},
		8	"/acquisitions/orders/{order_id}": {
		9	"$ref": "paths/acquisitions_orders.json#/~1acquisitions~1orders~1{order_id}"
		10	},
5	"/acquisitions/vendors": {	11	"/acquisitions/vendors": {
6	"$ref": "paths/acquisitions_vendors.json#/~1acquisitions~1vendors"	12	"$ref": "paths/acquisitions_vendors.json#/~1acquisitions~1vendors"
7	},	13	},




{
    "/acquisitions/orders": {
        "get": {
            "x-mojo-to": "Acquisitions::Orders#list",
            "operationId": "listOrders",
            "tags": [
                "acquisitions",
                "orders"
            ],
            "produces": [
                "application/json"
            ],
            "parameters": [
                {
                    "name": "biblio_id",
                    "in": "query",
                    "description": "Identifier for a linked bibliographic record",
                    "required": false,
                    "type": "integer"
                },
                {
                    "name": "basket_id",
                    "in": "query",
                    "description": "Identifier for a linked acquisition basket",
                    "required": false,
                    "type": "integer"
                },
                {
                    "name": "budget_id",
                    "in": "query",
                    "description": "Identifier for the budget the order goes against",
                    "required": false,
                    "type": "integer"
                },
                {
                    "name": "status",
                    "in": "query",
                    "description": "Current status for the order. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'",
                    "required": false,
                    "type": "string"
                },
                {
                    "$ref": "../parameters.json#/match"
                },
                {
                    "$ref": "../parameters.json#/order_by"
                },
                {
                    "$ref": "../parameters.json#/page"
                },
                {
                    "$ref": "../parameters.json#/per_page"
                }
            ],
            "responses": {
                "200": {
                    "description": "A list of orders",
                    "schema": {
                        "type": "array",
                        "items": {
                            "$ref": "../definitions.json#/order"
                        }
                    }
                },
                "401": {
                    "description": "Authentication required",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "403": {
                    "description": "Access forbidden",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "404": {
                    "description": "Order not found",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "500": {
                    "description": "Internal server error",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "503": {
                    "description": "Under maintenance",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                }
            },
            "x-koha-authorization": {
                "permissions": {
                    "acquisition": [ "order_manage", "order_manage_all" ]
                }
            },
            "x-koha-embed": [
                "basket",
                "fund",
                "invoice",
                "subscription",
                "items",
                "biblio"
            ]
        },
        "post": {
            "x-mojo-to": "Acquisitions::Orders#add",
            "operationId": "addOrder",
            "tags": [
                "acquisitions",
                "orders"
            ],
            "parameters": [
                {
                    "name": "body",
                    "in": "body",
                    "description": "A JSON object representing an order",
                    "required": true,
                    "schema": {
                        "$ref": "../definitions.json#/order"
                    }
                }
            ],
            "produces": [
                "application/json"
            ],
            "responses": {
                "201": {
                    "description": "Order added",
                    "schema": {
                        "$ref": "../definitions.json#/order"
                    }
                },
                "400": {
                    "description": "Bad request",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "401": {
                    "description": "Authentication required",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "403": {
                    "description": "Access forbidden",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "409": {
                    "description": "Conflict in creating the resource",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "500": {
                    "description": "Internal server error",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "503": {
                    "description": "Under maintenance",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                }
            },
            "x-koha-authorization": {
                "permissions": {
                    "acquisition": "order_manage"
                }
            }
        }
    },
    "/acquisitions/orders/{order_id}": {
        "get": {
            "x-mojo-to": "Acquisitions::Orders#get",
            "operationId": "getOrder",
            "tags": [
                "acquisitions",
                "orders"
            ],
            "parameters": [
                {
                    "$ref": "../parameters.json#/order_id_pp"
                }
            ],
            "produces": [
                "application/json"
            ],
            "responses": {
                "200": {
                    "description": "An order",
                    "schema": {
                        "$ref": "../definitions.json#/order"
                    }
                },
                "401": {
                    "description": "Authentication required",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "403": {
                    "description": "Access forbidden",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "404": {
                    "description": "Order not found",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "500": {
                    "description": "Internal server error",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "503": {
                    "description": "Under maintenance",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                }
            },
            "x-koha-authorization": {
                "permissions": {
                    "acquisition": "order_manage"
                }
            },
            "x-koha-embed": [
                "basket",
                "fund",
                "invoice",
                "subscription",
                "items",
                "biblio"
            ]
        },
        "put": {
            "x-mojo-to": "Acquisitions::Orders#update",
            "operationId": "updateOrder",
            "tags": [
                "acquisitions",
                "orders"
            ],
            "parameters": [
                {
                    "$ref": "../parameters.json#/order_id_pp"
                },
                {
                    "name": "body",
                    "in": "body",
                    "description": "A JSON object representing an order",
                    "required": true,
                    "schema": {
                        "$ref": "../definitions.json#/order"
                    }
                }
            ],
            "produces": [
                "application/json"
            ],
            "responses": {
                "200": {
                    "description": "An order",
                    "schema": {
                        "$ref": "../definitions.json#/order"
                    }
                },
                "401": {
                    "description": "Authentication required",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "403": {
                    "description": "Access forbidden",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "404": {
                    "description": "Order not found",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "500": {
                    "description": "Internal server error",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "503": {
                    "description": "Under maintenance",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                }
            },
            "x-koha-authorization": {
                "permissions": {
                    "acquisition": "order_manage"
                }
            }
        },
        "delete": {
            "x-mojo-to": "Acquisitions::Orders#delete",
            "operationId": "deleteOrder",
            "tags": [
                "acquisitions",
                "orders"
            ],
            "parameters": [
                {
                    "$ref": "../parameters.json#/order_id_pp"
                }
            ],
            "produces": [
                "application/json"
            ],
            "responses": {
                "204": {
                    "description": "Order deleted",
                    "schema": {
                        "type": "string"
                    }
                },
                "401": {
                    "description": "Authentication required",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "403": {
                    "description": "Access forbidden",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "404": {
                    "description": "Order not found",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "500": {
                    "description": "Internal server error",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                },
                "503": {
                    "description": "Under maintenance",
                    "schema": {
                        "$ref": "../definitions.json#/error"
                    }
                }
            },
            "x-koha-authorization": {
                "permissions": {
                    "acquisition": "order_manage"
                }
            }
        }
    }
}

Return to bug 18731

Line 0 Link Here

(-)a/api/v1/swagger/definitions/basket.json (+99 lines)
		1	{
		2	"type": "object",
		3	"properties": {
		4	"basket_id": {
		5	"type": "integer",
		6	"description": "Internal identifier for the basket"
		7	},
		8	"name": {
		9	"type": "string",
		10	"description": "Basket name"
		11	},
		12	"internal_note": {
		13	"type": [
		14	"string",
		15	"null"
		16	],
		17	"description": "Internal note"
		18	},
		19	"vendor_note": {
		20	"type": [
		21	"string",
		22	"null"
		23	],
		24	"description": "Vendor note"
		25	},
		26	"contract_id": {
		27	"type": "integer",
		28	"description": "Internal identifier of the linked contract"
		29	},
		30	"creation_date": {
		31	"type": [
		32	"string",
		33	"null"
		34	],
		35	"format": "date",
		36	"description": "The date the basket was created"
		37	},
		38	"close_date": {
		39	"type": [
		40	"string",
		41	"null"
		42	],
		43	"format": "date",
		44	"description": "The date the basket was closed"
		45	},
		46	"vendor_id": {
		47	"type": "integer",
		48	"description": "Internal identifier for the vendor"
		49	},
		50	"authorised_by": {
		51	"type": [
		52	"integer",
		53	"null"
		54	],
		55	"description": "Internal patron identifier of the basket creator"
		56	},
		57	"basket_group_id": {
		58	"type": [
		59	"integer",
		60	"null"
		61	],
		62	"description": "links this basket to its group (aqbasketgroups.id)"
		63	},
		64	"delivery_library": {
65	"type": [
66	"string",
67	"null"
68	],
69	"description": "basket delivery place"
70	},
71	"billing_library": {
72	"type": [
73	"string",
74	"null"
75	],
76	"description": "basket billing place"
77	},
78	"library_id": {
79	"type": [
80	"integer",
81	"null"
82	],
83	"description": "Library the basket belongs to"
84	},
85	"standing": {
86	"type": "boolean",
87	"description": "If the orders in this basket are standing"
88	},
89	"create_items": {
90	"type": "string",
91	"enum": [
92	"ordering",
93	"receiving",
94	"cataloguing"
95	],
96	"description": "When items should be created for orders in this basket (Options: 'ordering', 'receiving', 'cataloguing'. Null means system wide config)"
97	}
98	}
99	}

Line 0 Link Here

(-)a/api/v1/swagger/definitions/invoice.json (+57 lines)
	1	{
	2	"type": "object",
	3	"properties": {
	4	"invoice_id": {
	5	"type": "integer",
	6	"description": "Internal identifier for the incoide. Generated on POST"
	7	},
	8	"invoice_number": {
	9	"type": "string",
	10	"description": "Invoice number assigned by the vendor"
	11	},
	12	"vendor_id": {
	13	"type": "integer",
	14	"description": "Internal identifier for the vendor"
	15	},
	16	"shipping_date": {
	17	"type": [
	18	"string",
	19	"null"
	20	],
	21	"format": "date",
	22	"description": "Date of shipping"
	23	},
	24	"invoice_date": {
	25	"type": [
	26	"string",
	27	"null"
	28	],
	29	"format": "date",
	30	"description": "Date of billing"
	31	},
	32	"closed": {
	33	"type": "boolean",
	34	"description": "If the invoice is closed"
	35	},
	36	"close_date": {
	37	"type": "string",
	38	"format": "date",
	39	"description": "Invoice close date (only when the invoice is closed)"
	40	},
	41	"shipping_cost": {
	42	"type": [
	43	"integer",
	44	"null"
	45	],
	46	"description": "Shipping cost"
	47	},
	48	"shipping_cost_budget_id": {
	49	"type": [
	50	"integer",
	51	"null"
	52	],
	53	"description": "Shipping cost linking to budget"
	54	}
	55	},
	56	"additionalProperties": false
	57	}

Line 0 Link Here

(-)a/api/v1/swagger/definitions/order.json (+328 lines)
		1	{
		2	"type": "object",
		3	"properties": {
		4	"order_id": {
		5	"type": "integer",
		6	"description": "Internally assigned order identifier"
		7	},
		8	"biblio_id": {
		9	"type": [
		10	"integer",
		11	"null"
		12	],
		13	"description": "Identifier for the linked bibliographic record"
		14	},
		15	"created_by": {
		16	"type": "integer",
		17	"description": "Interal patron identifier of the order line creator"
		18	},
		19	"entry_date": {
		20	"type": [
		21	"string",
		22	"null"
		23	],
		24	"format": "date",
		25	"description": "Date the bib was added to the basket"
		26	},
		27	"quantity": {
		28	"type": [
		29	"integer",
		30	"null"
		31	],
		32	"description": "Ordered quantity"
		33	},
		34	"currency": {
		35	"type": [
		36	"string",
		37	"null"
		38	],
		39	"description": "Currency used for the purchase"
		40	},
		41	"list_price": {
		42	"type": [
		43	"number",
		44	"null"
		45	],
		46	"description": "Vendor price for the line item"
		47	},
		48	"replacement_price": {
		49	"type": [
		50	"number",
		51	"null"
		52	],
		53	"description": "Replacement cost for this item"
		54	},
		55	"date_received": {
		56	"type": [
		57	"string",
		58	"null"
		59	],
		60	"format": "date",
		61	"description": "Date the order was received"
		62	},
		63	"invoice_id": {
		64	"type": [
65	"integer",
66	"null"
67	],
68	"description": "Id of the order invoice"
69	},
70	"shipping_cost": {
71	"type": [
72	"number",
73	"null"
74	],
75	"description": "Shipping cost"
76	},
77	"unit_price": {
78	"type": [
79	"number",
80	"null"
81	],
82	"description": "The actual cost entered when receiving this line item"
83	},
84	"unit_price_tax_excluded": {
85	"type": [
86	"number",
87	"null"
88	],
89	"description": "Unit price excluding tax (on receiving)"
90	},
91	"unit_price_tax_included": {
92	"type": [
93	"number",
94	"null"
95	],
96	"description": "Unit price including tax (on receiving)"
97	},
98	"quantity_received": {
99	"type": "integer",
100	"description": "Quantity received so far"
101	},
102	"cancellation_date": {
103	"type": [
104	"string",
105	"null"
106	],
107	"format": "date",
108	"description": "Date the line item was deleted"
109	},
110	"cancellation_reason": {
111	"type": [
112	"string",
113	"null"
114	],
115	"description": "Reason of cancellation"
116	},
117	"internal_note": {
118	"type": [
119	"string",
120	"null"
121	],
122	"description": "Notes related to this order line, made for staff"
123	},
124	"vendor_note": {
125	"type": [
126	"string",
127	"null"
128	],
129	"description": "Notes related to this order line, made for vendor"
130	},
131	"basket_id": {
132	"type": [
133	"integer",
134	"null"
135	],
136	"description": "Basket this order is linked to"
137	},
138	"timestamp": {
139	"type": "string",
140	"format": "date-time",
141	"description": "Date and time this order line was last modified"
142	},
143	"rrp": {
144	"type": [
145	"number",
146	"null"
147	],
148	"description": "Retail cost for this item"
149	},
150	"rrp_tax_excluded": {
151	"type": [
152	"number",
153	"null"
154	],
155	"description": "Replacement cost for this item (tax excluded)"
156	},
157	"rrp_tax_included": {
158	"type": [
159	"number",
160	"null"
161	],
162	"description": "Replacement cost for this item (tax included)"
163	},
164	"ecost": {
165	"type": [
166	"number",
167	"null"
168	],
169	"description": "Effective cost"
170	},
171	"ecost_tax_excluded": {
172	"type": [
173	"number",
174	"null"
175	],
176	"description": "Effective cost (tax excluded)"
177	},
178	"ecost_tax_included": {
179	"type": [
180	"number",
181	"null"
182	],
183	"description": "Effective cost (tax included)"
184	},
185	"tax_rate_on_ordering": {
186	"type": [
187	"number",
188	"null"
189	],
190	"description": "Tax rate on ordering (%)"
191	},
192	"tax_rate_on_receiving": {
193	"type": [
194	"number",
195	"null"
196	],
197	"description": "Tax rate on receiving (%)"
198	},
199	"tax_value_on_ordering": {
200	"type": [
201	"number",
202	"null"
203	],
204	"description": "Tax value on ordering"
205	},
206	"tax_value_on_receiving": {
207	"type": [
208	"number",
209	"null"
210	],
211	"description": "Tax value on receiving"
212	},
213	"discount_rate": {
214	"type": [
215	"number",
216	"null"
217	],
218	"description": "Discount rate"
219	},
220	"fund_id": {
221	"type": "integer",
222	"description": "Internal identifier for the fund this order goes against"
223	},
224	"statistics_1": {
225	"type": [
226	"string",
227	"null"
228	],
229	"description": "Statistical field"
230	},
231	"statistics_2": {
232	"type": [
233	"string",
234	"null"
235	],
236	"description": "Statistical field (2)"
237	},
238	"statistics_1_authcat": {
239	"type": [
240	"string",
241	"null"
242	],
243	"description": "Statistical category for this order"
244	},
245	"statistics_2_authcat": {
246	"type": [
247	"string",
248	"null"
249	],
250	"description": "Statistical category for this order (2)"
251	},
252	"uncertain_price": {
253	"type": "boolean",
254	"description": "If this price was uncertain"
255	},
256	"claims_count": {
257	"type": "integer",
258	"description": "Generated claim letters count"
259	},
260	"last_claim_date": {
261	"type": [
262	"string",
263	"null"
264	],
265	"format": "date",
266	"description": "Last date a claim letter was generated"
267	},
268	"subscription_id": {
269	"type": [
270	"integer",
271	"null"
272	],
273	"description": "Subscription ID linking the order to a subscription"
274	},
275	"parent_order_id": {
276	"type": [
277	"integer",
278	"null"
279	],
280	"description": "Order ID of parent order line if exists"
281	},
282	"status": {
283	"type": "string",
284	"enum": [
285	"new",
286	"ordered",
287	"partial",
288	"complete",
289	"cancelled"
290	],
291	"description": "The current order status"
292	},
293	"basket": {
294	"type": [
295	"object",
296	"null"
297	]
298	},
299	"biblio": {
300	"type": [
301	"object",
302	"null"
303	]
304	},
305	"fund": {
306	"type": [
307	"object",
308	"null"
309	]
310	},
311	"invoice": {
312	"type": [
313	"object",
314	"null"
315	]
316	},
317	"items": {
318	"type": "array"
319	},
320	"subscription": {
321	"type": [
322	"object",
323	"null"
324	]
325	}
326	},
327	"additionalProperties": false
328	}

Line 0 Link Here

(-)a/api/v1/swagger/paths/acquisitions_orders.json (-1 / +378 lines)
0	-	1	{
		2	"/acquisitions/orders": {
		3	"get": {
		4	"x-mojo-to": "Acquisitions::Orders#list",
		5	"operationId": "listOrders",
		6	"tags": [
		7	"acquisitions",
		8	"orders"
		9	],
		10	"produces": [
		11	"application/json"
		12	],
		13	"parameters": [
		14	{
		15	"name": "biblio_id",
		16	"in": "query",
		17	"description": "Identifier for a linked bibliographic record",
		18	"required": false,
		19	"type": "integer"
		20	},
		21	{
		22	"name": "basket_id",
		23	"in": "query",
		24	"description": "Identifier for a linked acquisition basket",
		25	"required": false,
		26	"type": "integer"
		27	},
		28	{
		29	"name": "budget_id",
		30	"in": "query",
		31	"description": "Identifier for the budget the order goes against",
		32	"required": false,
		33	"type": "integer"
		34	},
		35	{
		36	"name": "status",
		37	"in": "query",
		38	"description": "Current status for the order. Can be 'new', 'ordered', 'partial', 'complete' or 'cancelled'",
		39	"required": false,
		40	"type": "string"
		41	},
		42	{
		43	"$ref": "../parameters.json#/match"
		44	},
		45	{
		46	"$ref": "../parameters.json#/order_by"
		47	},
		48	{
		49	"$ref": "../parameters.json#/page"
		50	},
		51	{
		52	"$ref": "../parameters.json#/per_page"
		53	}
		54	],
		55	"responses": {
		56	"200": {
		57	"description": "A list of orders",
		58	"schema": {
		59	"type": "array",
		60	"items": {
		61	"$ref": "../definitions.json#/order"
		62	}
		63	}
		64	},
		65	"401": {
66	"description": "Authentication required",
67	"schema": {
68	"$ref": "../definitions.json#/error"
69	}
70	},
71	"403": {
72	"description": "Access forbidden",
73	"schema": {
74	"$ref": "../definitions.json#/error"
75	}
76	},
77	"404": {
78	"description": "Order not found",
79	"schema": {
80	"$ref": "../definitions.json#/error"
81	}
82	},
83	"500": {
84	"description": "Internal server error",
85	"schema": {
86	"$ref": "../definitions.json#/error"
87	}
88	},
89	"503": {
90	"description": "Under maintenance",
91	"schema": {
92	"$ref": "../definitions.json#/error"
93	}
94	}
95	},
96	"x-koha-authorization": {
97	"permissions": {
98	"acquisition": [ "order_manage", "order_manage_all" ]
99	}
100	},
101	"x-koha-embed": [
102	"basket",
103	"fund",
104	"invoice",
105	"subscription",
106	"items",
107	"biblio"
108	]
109	},
110	"post": {
111	"x-mojo-to": "Acquisitions::Orders#add",
112	"operationId": "addOrder",
113	"tags": [
114	"acquisitions",
115	"orders"
116	],
117	"parameters": [
118	{
119	"name": "body",
120	"in": "body",
121	"description": "A JSON object representing an order",
122	"required": true,
123	"schema": {
124	"$ref": "../definitions.json#/order"
125	}
126	}
127	],
128	"produces": [
129	"application/json"
130	],
131	"responses": {
132	"201": {
133	"description": "Order added",
134	"schema": {
135	"$ref": "../definitions.json#/order"
136	}
137	},
138	"400": {
139	"description": "Bad request",
140	"schema": {
141	"$ref": "../definitions.json#/error"
142	}
143	},
144	"401": {
145	"description": "Authentication required",
146	"schema": {
147	"$ref": "../definitions.json#/error"
148	}
149	},
150	"403": {
151	"description": "Access forbidden",
152	"schema": {
153	"$ref": "../definitions.json#/error"
154	}
155	},
156	"409": {
157	"description": "Conflict in creating the resource",
158	"schema": {
159	"$ref": "../definitions.json#/error"
160	}
161	},
162	"500": {
163	"description": "Internal server error",
164	"schema": {
165	"$ref": "../definitions.json#/error"
166	}
167	},
168	"503": {
169	"description": "Under maintenance",
170	"schema": {
171	"$ref": "../definitions.json#/error"
172	}
173	}
174	},
175	"x-koha-authorization": {
176	"permissions": {
177	"acquisition": "order_manage"
178	}
179	}
180	}
181	},
182	"/acquisitions/orders/{order_id}": {
183	"get": {
184	"x-mojo-to": "Acquisitions::Orders#get",
185	"operationId": "getOrder",
186	"tags": [
187	"acquisitions",
188	"orders"
189	],
190	"parameters": [
191	{
192	"$ref": "../parameters.json#/order_id_pp"
193	}
194	],
195	"produces": [
196	"application/json"
197	],
198	"responses": {
199	"200": {
200	"description": "An order",
201	"schema": {
202	"$ref": "../definitions.json#/order"
203	}
204	},
205	"401": {
206	"description": "Authentication required",
207	"schema": {
208	"$ref": "../definitions.json#/error"
209	}
210	},
211	"403": {
212	"description": "Access forbidden",
213	"schema": {
214	"$ref": "../definitions.json#/error"
215	}
216	},
217	"404": {
218	"description": "Order not found",
219	"schema": {
220	"$ref": "../definitions.json#/error"
221	}
222	},
223	"500": {
224	"description": "Internal server error",
225	"schema": {
226	"$ref": "../definitions.json#/error"
227	}
228	},
229	"503": {
230	"description": "Under maintenance",
231	"schema": {
232	"$ref": "../definitions.json#/error"
233	}
234	}
235	},
236	"x-koha-authorization": {
237	"permissions": {
238	"acquisition": "order_manage"
239	}
240	},
241	"x-koha-embed": [
242	"basket",
243	"fund",
244	"invoice",
245	"subscription",
246	"items",
247	"biblio"
248	]
249	},
250	"put": {
251	"x-mojo-to": "Acquisitions::Orders#update",
252	"operationId": "updateOrder",
253	"tags": [
254	"acquisitions",
255	"orders"
256	],
257	"parameters": [
258	{
259	"$ref": "../parameters.json#/order_id_pp"
260	},
261	{
262	"name": "body",
263	"in": "body",
264	"description": "A JSON object representing an order",
265	"required": true,
266	"schema": {
267	"$ref": "../definitions.json#/order"
268	}
269	}
270	],
271	"produces": [
272	"application/json"
273	],
274	"responses": {
275	"200": {
276	"description": "An order",
277	"schema": {
278	"$ref": "../definitions.json#/order"
279	}
280	},
281	"401": {
282	"description": "Authentication required",
283	"schema": {
284	"$ref": "../definitions.json#/error"
285	}
286	},
287	"403": {
288	"description": "Access forbidden",
289	"schema": {
290	"$ref": "../definitions.json#/error"
291	}
292	},
293	"404": {
294	"description": "Order not found",
295	"schema": {
296	"$ref": "../definitions.json#/error"
297	}
298	},
299	"500": {
300	"description": "Internal server error",
301	"schema": {
302	"$ref": "../definitions.json#/error"
303	}
304	},
305	"503": {
306	"description": "Under maintenance",
307	"schema": {
308	"$ref": "../definitions.json#/error"
309	}
310	}
311	},
312	"x-koha-authorization": {
313	"permissions": {
314	"acquisition": "order_manage"
315	}
316	}
317	},
318	"delete": {
319	"x-mojo-to": "Acquisitions::Orders#delete",
320	"operationId": "deleteOrder",
321	"tags": [
322	"acquisitions",
323	"orders"
324	],
325	"parameters": [
326	{
327	"$ref": "../parameters.json#/order_id_pp"
328	}
329	],
330	"produces": [
331	"application/json"
332	],
333	"responses": {
334	"204": {
335	"description": "Order deleted",
336	"schema": {
337	"type": "string"
338	}
339	},
340	"401": {
341	"description": "Authentication required",
342	"schema": {
343	"$ref": "../definitions.json#/error"
344	}
345	},
346	"403": {
347	"description": "Access forbidden",
348	"schema": {
349	"$ref": "../definitions.json#/error"
350	}
351	},
352	"404": {
353	"description": "Order not found",
354	"schema": {
355	"$ref": "../definitions.json#/error"
356	}
357	},
358	"500": {
359	"description": "Internal server error",
360	"schema": {
361	"$ref": "../definitions.json#/error"
362	}
363	},
364	"503": {
365	"description": "Under maintenance",
366	"schema": {
367	"$ref": "../definitions.json#/error"
368	}
369	}
370	},
371	"x-koha-authorization": {
372	"permissions": {
373	"acquisition": "order_manage"
374	}
375	}
376	}
377	}
378	}