- Getting Started with HYEGRO API
- User Guide
- Developer Guide
- HYEGRO Developer Docs
- HYEGRO CRM API v1.0
- Users
- Leads
- Contacts
- Accounts
- Products & Inventory
- Deals
- Quotations
- Orders
- Invoices
- Cases
- Activities & Tasks
- Search
- METADATA API
- Files & Attachments
Update Invoice
PUT
https://backend.test-hyegro.com/invoices/{invoice_id}/
Request
Path Params
invoice_id
integer
Invoice Id
Query Params
schema
Schema
Any of
Body Params application/json
sales_order_id
Sales Order Id
Any of
billing_details
Billing Details
Any of
notes
Notes
Any of
due_date
Due Date
Any of
total_amount
Total Amount
Any of
subtotal
Subtotal
Any of
payment_status
Payment Status
Any of
client_name
Client Name
Any of
client_address_line1
Client Address Line1
Any of
client_address_line2
Client Address Line2
Any of
client_city
Client City
Any of
client_state
Client State
Any of
client_zip
Client Zip
Any of
client_country
Client Country
Any of
invoice_date
Invoice Date
Any of
status
Status
Any of
tax_slab_1
Tax Slab 1
Any of
tax_slab_amount_1
Tax Slab Amount 1
Any of
tax_slab_2
Tax Slab 2
Any of
tax_slab_amount_2
Tax Slab Amount 2
Any of
tax_slab_3
Tax Slab 3
Any of
tax_slab_amount_3
Tax Slab Amount 3
Any of
tax_slab_4
Tax Slab 4
Any of
tax_slab_amount_4
Tax Slab Amount 4
Any of
tax_slab_5
Tax Slab 5
Any of
tax_slab_amount_5
Tax Slab Amount 5
Any of
order_number
Order Number
Any of
created_by
Created By
Any of
updated_by
Updated By
Any of
created_by_name
Created By Name
Any of
updated_by_name
Updated By Name
Any of
account_name
Account Name
Any of
account_id
Account Id
Any of
created_at
Created At
Any of
updated_at
Updated At
Any of
Example
{
"sales_order_id": 0,
"billing_details": "string",
"notes": "string",
"due_date": "2019-08-24",
"total_amount": 0,
"subtotal": 0,
"payment_status": "string",
"client_name": "string",
"client_address_line1": "string",
"client_address_line2": "string",
"client_city": "string",
"client_state": "string",
"client_zip": "string",
"client_country": "string",
"invoice_date": "2019-08-24",
"status": "string",
"tax_slab_1": 0,
"tax_slab_amount_1": 0,
"tax_slab_2": 0,
"tax_slab_amount_2": 0,
"tax_slab_3": 0,
"tax_slab_amount_3": 0,
"tax_slab_4": 0,
"tax_slab_amount_4": 0,
"tax_slab_5": 0,
"tax_slab_amount_5": 0,
"order_number": "string",
"created_by": 0,
"updated_by": 0,
"created_by_name": "string",
"updated_by_name": "string",
"account_name": "string",
"account_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}Responses
🟢200OK
application/json
Body
sales_order_id
Sales Order Id
Any of
billing_details
Billing Details
Any of
notes
Notes
Any of
due_date
Due Date
Any of
total_amount
Total Amount
Any of
subtotal
Subtotal
Any of
payment_status
Payment Status
Any of
client_name
Client Name
Any of
client_address_line1
Client Address Line1
Any of
client_address_line2
Client Address Line2
Any of
client_city
Client City
Any of
client_state
Client State
Any of
client_zip
Client Zip
Any of
client_country
Client Country
Any of
invoice_date
Invoice Date
Any of
status
Status
Any of
tax_slab_1
Tax Slab 1
Any of
tax_slab_amount_1
Tax Slab Amount 1
Any of
tax_slab_2
Tax Slab 2
Any of
tax_slab_amount_2
Tax Slab Amount 2
Any of
tax_slab_3
Tax Slab 3
Any of
tax_slab_amount_3
Tax Slab Amount 3
Any of
tax_slab_4
Tax Slab 4
Any of
tax_slab_amount_4
Tax Slab Amount 4
Any of
tax_slab_5
Tax Slab 5
Any of
tax_slab_amount_5
Tax Slab Amount 5
Any of
order_number
Order Number
Any of
created_by
Created By
Any of
updated_by
Updated By
Any of
created_by_name
Created By Name
Any of
updated_by_name
Updated By Name
Any of
account_name
Account Name
Any of
account_id
Account Id
Any of
created_at
string <date-time>
Created At
updated_at
string <date-time>
Updated At
id
integer
Id
items
array[object (InvoiceItem) {13}]
Items
description
Description
quantity
Quantity
rate
Rate
tax
Tax
amount
Amount
product_id
Product Id
product_name
Product Name
unit_price
Unit Price
total_price
Total Price
discount_percentage
Discount Percentage
discounted_price
Discounted Price
id
integer
Id
invoice_id
integer
Invoice Id
Example
{
"sales_order_id": 0,
"billing_details": "string",
"notes": "string",
"due_date": "2019-08-24",
"total_amount": "string",
"subtotal": "string",
"payment_status": "string",
"client_name": "string",
"client_address_line1": "string",
"client_address_line2": "string",
"client_city": "string",
"client_state": "string",
"client_zip": "string",
"client_country": "string",
"invoice_date": "2019-08-24",
"status": "string",
"tax_slab_1": "string",
"tax_slab_amount_1": "string",
"tax_slab_2": "string",
"tax_slab_amount_2": "string",
"tax_slab_3": "string",
"tax_slab_amount_3": "string",
"tax_slab_4": "string",
"tax_slab_amount_4": "string",
"tax_slab_5": "string",
"tax_slab_amount_5": "string",
"order_number": "string",
"created_by": 0,
"updated_by": 0,
"created_by_name": "string",
"updated_by_name": "string",
"account_name": "string",
"account_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"id": 0,
"items": []
}🟠422Parameter Error
Modified at 2025-04-14 16:23:20