Update an Invoice

put

https://api.vcita.biz/v3/payments/invoices/{uid}

Overview

Update an existing invoice Available for Staff Tokens.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uid

string

required

Unique identifier of the Invoice

Body Params

matter_uid

string

required

Matter UID. The identify number of the client that the invoice for issued for

issue_date

date

required

The date the invoice was issued. Issue_date >=Today()

due_date

date

required

Invoice due date. Expected date for payment. Must be >= issue_date

currency

string

required

Three-letter ISO currency code (e.g., "USD", "ILS")

status

string

enum

Invoice statuses (Draft, Issued, Cancelled). Draft: refers to the initial editable stage of the invoice. Issued: Invoice was issued. (in Strict mode: Invoice is immune and cannot be edited. Cancelled: Cancelled invoices: In strict mode: Can be performed only from "Draft" state. In Flex mode: Issued to Cancelled is allowed. Required field: "DRAFT" or "ISSUED" or "CANCELLED" (default: "ISSUED")

Allowed:

unique_number

string

Invoice unique, sequential number. Two types of numbering:

Unique sequence of numbers (1,2,3….)
A yearly repeated numbering including a year's prefix (2025-0001, 2025-0002…). Within each year start - rounding the count (2026-0001, 2026-0002,…). Optional, auto-generated if not provided

invoice_title

string

Invoice title. A document title to appear on top of the PDF. Optional. Default: "INVOICE"

billing_address

string

Full business billing address, including street, city, state, country, and zipcode

purchase_order

string

Purchase order number

allow_online_payment

boolean

Enable online payment for this specific invoice (allow the client to pay directly from the client portal)

allow_partial_payment

boolean

Enable partial payment for this specific invoice (allow the client to pay a portion of the invoice amount rather than its full due price)

enable_late_fee

boolean

Enable late fee on invoice for this specific invoice. (late fee will be added to the invoice automatically when the invoice will become overdue. Not applicable in strict mode where an invoice is a legal binding document and cannot be edited)

note

string

Invoice notes/comments appears in the invoice document

terms_and_conditions

string

Payment terms and conditions. appears in the invoice document

additional_recipients

array of strings

CC email recipients (array of email strings). comma separated

additional_recipients

line_item_groups

array of objects

length ≥ 1

Array of invoice line item groups. Line item groups allows to group invoice line items per need, while each line item group will have at least a single line item set in it. Optional, used when add_item_header feature flag is enabled

line_item_groups

name

string

required

Section name

line_item_group_index

number

required

Section order/index

line_items

array of objects

required

length ≥ 1

Array of line items within this section

line_items*

name

string

required

Line item name/title

quantity

number

required

Line item quantity

unit_amount

number

required

Unit price/amount

description

string

Line item description

entity_uid

string

UID of related entity (service/product/package)

entity_type

string

enum

Type of related entity. If custom item → NULL

Allowed:

uid

string

Line item UID (for updates)

tax_uids

array of strings

Array of tax UIDs to apply. Pulled from the taxes set in the business Taxes settings. 0-3 taxes per line item are allowed

tax_uids

discount

object

Line item discount. Can be a percentage or a fixed amount to be reduced from the line item amount

line_item_index

number

Line item position/index

display_line_item_groups_total

boolean

Display the total price of the items that are nested under a line items group

display_line_item_total

boolean

Display nested under a group line item price

estimate_uid

string

The unique identifier of the estimate from which invoice was created

line_items

array of objects

required

length ≥ 1

Array of invoice line items. Line items that are not part of the line item groups. Required if line_item_groups not provided, at least one line item required

line_items*

name

string

required

Line item name/title

quantity

number

required

Line item quantity

unit_amount

number

required

Unit price/amount

description

string

Line item description

entity_uid

string

UID of related entity (service/product/package)

entity_type

string

enum

Type of related entity. If custom item → NULL

Allowed:

uid

string

Line item UID (for updates)

tax_uids

array of strings

Array of tax UIDs to apply. Pulled from the taxes set in the business Taxes settings. 0-3 taxes per line item are allowed

tax_uids

discount

object

Line item discount. Can be a percentage or a fixed amount to be reduced from the line item amount

line_item_index

number

Line item position/index

notify_recipient

boolean

Send email notification to client. Used only during creation/update to determine if email should be sent. Not saved on invoice.

200