Quoting & Billing¶
Cost estimation, quotes, and billing.
Quotes¶
Endpoints related to quotes.
- GET /quote/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
400 Bad Request – There is no matching bureau-material combination Either the model requested does not exist or you do not have permission to use The model response does not contain few or all of these fields: Size, Volume, Surface Area
500 Internal Server Error – The bureau requested does not exist
404 Not Found – The material requested is not available with the bureau requested
- GET /quote/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
400 Bad Request – There is no matching bureau-material combination Either the model requested does not exist or you do not have permission to use The model response does not contain few or all of these fields: Size, Volume, Surface Area
500 Internal Server Error – The bureau requested does not exist
404 Not Found – The material requested is not available with the bureau requested
Costs & Billing¶
Endpoints related to costs & billing.
- GET /payment/¶
For restricted buyer this will List all of the payments in the system for their account. For normal internal bureau user
For restricted buyer this will List all of the payments in the system for their account. For normal internal bureau user this will display all payment records for that bureau. Use payment[‘purchaser’] for the ‘owning’ user, who is doing the purchasing.
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
404 Not Found – The requested record cannot be found.
403 Forbidden – You are not authorized to complete the request.
400 Bad Request – Invalid payload. Shopping-Cart-Items missing pricing final_price data
- POST /payment/¶
- Status Codes:
201 Created – Resource created successfully
404 Not Found – The requested record cannot be found.
403 Forbidden – You are not authorized to complete the request.
400 Bad Request – Invalid payload. Shopping-Cart-Items missing pricing final_price data
- Response Headers:
Location – URI of the created resource
- GET /payment/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
404 Not Found – The requested record cannot be found.
403 Forbidden – You are not authorized to complete the request.
400 Bad Request – Invalid payload. Shopping-Cart-Items missing pricing final_price data
- PUT /payment/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
404 Not Found – The requested record cannot be found.
403 Forbidden – You are not authorized to complete the request.
400 Bad Request – Invalid payload. Shopping-Cart-Items missing pricing final_price data
- GET /cost-report/¶
- Query Parameters:
limit (integer) – Maximum number of resources to return
offset (integer) – Number of resources to skip
sort (string) – Sort order (prefix with ‘-’ for descending)
- Status Codes:
200 OK – Successful response with list of resources
400 Bad Request – start and/or end date cannot be a future date. Cost must be a positive value A cost report must be unique, and cannot intersect other reports date range Must provide a valid material
- POST /cost-report/¶
- Status Codes:
201 Created – Resource created successfully
400 Bad Request – start and/or end date cannot be a future date. Cost must be a positive value A cost report must be unique, and cannot intersect other reports date range Must provide a valid material
- Response Headers:
Location – URI of the created resource
- GET /cost-report/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
200 OK – Successful response
400 Bad Request – start and/or end date cannot be a future date. Cost must be a positive value A cost report must be unique, and cannot intersect other reports date range Must provide a valid material
- PUT /cost-report/{uuid}/¶
- Parameters:
uuid (string) – The UUID of the resource
- Status Codes:
204 No Content – Resource updated successfully
400 Bad Request – start and/or end date cannot be a future date. Cost must be a positive value A cost report must be unique, and cannot intersect other reports date range Must provide a valid material