Estimates
List Estimates
GET /api/estimates
Response:
- id - Estimate ID
- ref - Reference
- uri = URI of public page
- title - Title
- po_number - PO number
- description - Description
- footer - Footer
- client_id - Client ID
- project_id - Project ID
- date - Date
- date_approved - Date approved
- currency - Currency
- discount_rate - Discount rate (%)
- tax_rate - Tax rate (%)
- payments - Partial payments
- discount - Discount
- tax - Tax
- subtotal - Sub-total
- total - Total amount
- approved - Approved?
- public - Public?
- sent - Sent?
- last_sent - Date last sent
- draft - Draft?
- archived - Archived?
- date_created - Date created
- user_id - Creator user ID
- items - Estimate line items
- id - Item ID
- item_name - Item name
- description - Description
- unit_cost - Unit
- quantity - Quantity
- amount - Price
- item_order - Item order
- date_created - Date created
- user_id - Creator user ID
Get Estimate
GET /api/estimate/id/:id
Response:
- id - Estimate ID
- ref - Reference
- uri = URI of public page
- title - Title
- po_number - PO number
- description - Description
- footer - Footer
- client_id - Client ID
- project_id - Project ID
- date - Date
- date_approved - Date approved
- currency - Currency
- discount_rate - Discount rate (%)
- tax_rate - Tax rate (%)
- payments - Partial payments
- discount - Discount
- tax - Tax
- subtotal - Sub-total
- total - Total amount
- approved - Approved?
- public - Public?
- sent - Sent?
- last_sent - Date last sent
- draft - Draft?
- archived - Archived?
- date_created - Date created
- user_id - Creator user ID
- items - Estimate line items
- id - Item ID
- item_name - Item name
- description - Description
- unit_cost - Unit
- quantity - Quantity
- amount - Price
- item_order - Item order
- date_created - Date created
- user_id - Creator user ID
Create Estimates
POST /api/estimates
Parameters:
- ref - Reference
- title - Title
- po_number - PO number
- description - Description
- footer - Footer
- client_id - Client ID
- project_id - Project ID
- date - Date (yyyymmdd)
- date_approved - Date approved (yyyymmdd)
- currency - Currency
- discount_rate - Discount rate (%)
- tax_rate - Tax rate (%)
- approved - Approved?
- public - Public?
- sent - Sent?
- draft - Draft?
- archived - Archived?
- user_id - Creator user ID
- items - Estimate line items
- item_name - Item name
- description - Description
- unit_cost - Unit
- quantity - Quantity
- amount - Amount
- item_order - Item order
- user_id - Creator user ID
Response:
- id - Estimate ID
Update Estimate
POST /api/estimate/id/:id
Parameters:
- ref - Reference
- title - Title
- po_number - PO number
- description - Description
- footer - Footer
- client_id - Client ID
- project_id - Project ID
- date - Date (yyyymmdd)
- date_approved - Date approved (yyyymmdd)
- currency - Currency
- discount_rate - Discount rate (%)
- tax_rate - Tax rate (%)
- approved - Approved?
- public - Public?
- sent - Sent?
- draft - Draft?
- archived - Archived?
- user_id - Creator user ID
- items - Estimate line items
- item_name - Item name
- description - Description
- unit_cost - Unit
- quantity - Quantity
- amount - Amount
- item_order - Item order
- user_id - Creator user ID
Response:
- message - Updated successfully
Delete Estimate
DELETE /api/estimate/id/:id
Response:
- message - Deleted successfully
Send Estimate
POST /api/estimate_send/id/:id
Parameters:
- message - Message body
Response:
- message - Sent successfully
