Update a line item on an invoice

​

Updates one line item and recalculates the invoice total. Every field is optional, and anything you leave out keeps its current value.

Only invoices that have not been paid for work here. An invoice that is paid, partially paid, or has a payment in progress is closed to changes and returns 403.

Path Parameters
  • invoice_id
    Type: integer
    required

    Id of the invoice the line item belongs to.

  • id
    Type: integer
    required

    Id of the line item.

Body
required
application/json

The fields to change, wrapped in an invoice_item key. All of them are optional.

  • invoice_item
    Type: object
    required
Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for patch/public-api/v1/invoices/{invoice_id}/invoice_items/{id}
curl https://app.hellobonsai.com/public-api/v1/invoices/1/invoice_items/1 \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "invoice_item": {
    "name": "Consulting",
    "description": "Discovery workshops",
    "amount": "3",
    "rate": "100",
    "unit_type": "flat"
  }
}'

{
  "data": {
    "id": 4471,
    "name": "Design",
    "description": "Homepage and pricing page",
    "amount": "2.0",
    "rate": "100.0",
    "unit_type": "per_hour",
    "total": "200.0"
  },
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e"
  }
}

The line item was updated and the invoice total recalculated.