Invoices API

REST endpoints for invoices in ServFlo: 22 operations with parameters, request and response fields, permissions and curl examples.

Base URL: https://app.servflo.ai/api. Every call needs Authorization: Bearer sfk_… (Authentication); {organizationId} ($ORGANIZATION_ID in the examples) is your business's id.

Operation	Endpoint	Risk
List invoices	`GET /organizations/{organizationId}/invoices`	`read`
Create a draft invoice	`POST /organizations/{organizationId}/invoices`	`write`
Get an invoice with its lines and payments	`GET /organizations/{organizationId}/invoices/{invoiceId}`	`read`
Update an invoice's status, notes or dates	`PATCH /organizations/{organizationId}/invoices/{invoiceId}`	`sensitive`
Delete an invoice	`DELETE /organizations/{organizationId}/invoices/{invoiceId}`	`sensitive`
Remove or re-apply member pricing on a draft invoice	`POST /organizations/{organizationId}/invoices/{invoiceId}/member-pricing`	`write`
Jobs ready to invoice	`GET /organizations/{organizationId}/invoice-batches/jobs`	`read`
Preview a batch of invoices	`GET /organizations/{organizationId}/invoice-batches/preview`	`read`
Create invoices for many jobs	`POST /organizations/{organizationId}/invoice-batches`	`write`
Send many invoices	`POST /organizations/{organizationId}/invoice-batches/send`	`sensitive`
Send payment reminders for many invoices	`POST /organizations/{organizationId}/invoice-batches/remind`	`sensitive`
Mark many invoices as sent	`POST /organizations/{organizationId}/invoice-batches/mark-sent`	`write`
List progress billings	`GET /organizations/{organizationId}/progress-billings`	`read`
Bill a quote or job in progress invoices	`POST /organizations/{organizationId}/progress-billings`	`write`
Get a progress billing	`GET /organizations/{organizationId}/progress-billings/{progressBillingId}`	`read`
Change a progress billing	`PATCH /organizations/{organizationId}/progress-billings/{progressBillingId}`	`write`
Stop billing in progress invoices	`DELETE /organizations/{organizationId}/progress-billings/{progressBillingId}`	`sensitive`
Create a progress invoice	`POST /organizations/{organizationId}/progress-billings/{progressBillingId}/invoices`	`write`
Create the final invoice	`POST /organizations/{organizationId}/progress-billings/{progressBillingId}/final-invoice`	`write`
Invoice the retainage held	`POST /organizations/{organizationId}/progress-billings/{progressBillingId}/retainage-release`	`write`
Get or create the invoice's customer link	`POST /organizations/{organizationId}/invoices/{invoiceId}/link`	`sensitive`
Replace the invoice's customer link	`POST /organizations/{organizationId}/invoices/{invoiceId}/link/regenerate`	`sensitive`

List invoices

GET /organizations/{organizationId}/invoices

Invoices newest first, filtered by text (INV-n, customer), status or customer, paged with a total. Each item carries amountPaidCents, balanceDueCents and partiallyPaid. Read-only.

Permission: invoices.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices), Member); risk read (OAuth scope servflo.read).


Permission	`invoices.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`invoices_list` (toolset `invoices`, in the default set)

Parameters

Name	In	Type	Required	Description
`query`	query	string	No	Free-text search over the list's names, numbers and contact details. Up to 200 characters.
`status`	query	enum	No	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`customerId`	query	string	No
`businessUnitId`	query	string	No	Only this business unit (GET /business-units), or "none" for records without one. Up to 100 characters.
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string	Invoice id.
`items[].organizationId`	string
`items[].identifier`	string	INV-n, unique per organization.
`items[].customerId`	string
`items[].jobId`	string or null
`items[].status`	enum	DRAFT (not issued), SENT (issued, money due), PAID, OVERDUE (past `dueDate`) or CANCELLED. One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`items[].subtotalCents`	integer	Lines total before tax, in integer cents.
`items[].taxRate`	number	Tax rate in percent.
`items[].taxCents`	integer	Tax, in integer cents.
`items[].totalCents`	integer	Total with tax, in integer cents.
`items[].notes`	string or null
`items[].dueDate`	string or null	YYYY-MM-DD
`items[].paidDate`	string or null	YYYY-MM-DD
`items[].amountPaidCents`	integer	Paid so far, net of refunds, tips excluded, in integer cents.
`items[].membershipId`	string or null	Set on a membership's billing invoice.
`items[].memberPricingRemoved`	boolean
`items[].financingDisabled`	boolean
`items[].progressBillingId`	string or null
`items[].progressRole`	enum or null	Its place in a progress billing. One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`items[].progressMilestoneId`	string or null
`items[].progressBilledCents`	integer	Billed towards the contract on a progress invoice, in integer cents.
`items[].retainageCents`	integer	Retainage held on a progress invoice, in integer cents.
`items[].businessUnitId`	string or null
`items[].customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=INVOICE).
`items[].createdAt`	string (date-time)
`items[].updatedAt`	string (date-time)
`items[].customer`	object
`items[].customer.id`	string
`items[].customer.name`	string
`items[].businessUnit`	object or null	The business unit.
`items[].businessUnit.id`	string
`items[].businessUnit.name`	string
`items[].job`	object or null
`items[].job.id`	string
`items[].job.identifier`	string	JOB-n
`items[].job.signedBy`	string or null	Work accepted by (the job's sign-off).
`items[].job.signedAt`	string (date-time) or null
`items[].balanceDueCents`	integer	Still due, in integer cents.
`items[].partiallyPaid`	boolean
`total`	integer	How many match the filters, across all pages.

Create a draft invoice

POST /organizations/{organizationId}/invoices

Creates a DRAFT invoice (INV-n) for a customer with the given lines; amounts are fixed once created. Tax is 0 for tax-exempt customers, else taxRate. MEMBER PRICING: when the customer has an active membership covering the job's property, the plan's discount is added as separate negative lines (services and materials apart) unless memberPricing: false. Nothing is sent: share it with POST /invoices/{invoiceId}/link and mark it SENT with PATCH. To bill a job's work use POST /jobs/{jobId}/invoice instead.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`invoices_create` (toolset `invoices`, in the default set)

Request body

Field	Type	Required	Description
`customerId`	string	Yes	From GET /customers.
`jobId`	string or null	No	The job this bills, if any.
`taxRate`	number	No	Percent, e.g. 8.25. Ignored for tax-exempt customers. -1000–1000.
`notes`	string or null	No	Printed on the invoice; the customer sees it.
`dueDate`	empty string or string or null	No	Defaults from the customer's payment terms.
`lines`	array of object	Yes	Up to 500 items.
`lines[].description`	string	Yes
`lines[].quantity`	number	Yes	-1000000–1000000.
`lines[].unitPriceCents`	integer	Yes	Money in integer cents; negative for a discount or credit line. -100000000–100000000.
`lines[].kind`	enum or null	No	For member pricing: SERVICE (labour, the default) or MATERIAL get the member discount for their kind; MEMBERSHIP (a plan fee) is never discounted. Discount lines are added by the server. One of `SERVICE`, `MATERIAL`, `MEMBERSHIP`.
`lines[].pricebookItemId`	string or null	No	The pricebook item the line was picked from (GET /pricebook/items): the server snapshots its cost; pricebook edits never change the invoice.
`lines[].memberPriceApplied`	boolean or null	No	Priced at the item's member price: the plan's member discount skips this line. Kept only for items with a member price.
`memberPricing`	boolean	No	Default true: a member customer's discount lines are added. false leaves them off (staff removed member pricing).
`businessUnitId`	string or null	No	Business unit (GET /business-units): its branding shows on the invoice and its accounting class or tracking applies. Omitted: the job's unit; null = none. Up to 100 characters.
`customFields`	object	No	Invoice custom field values (GET /custom-fields?entity=INVOICE); those marked visibleToCustomer print on the invoice, its emails and pages. Required ones are checked here.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"customerId":"customer_id","lines":[{"description":"string","quantity":1,"unitPriceCents":12500}]}'

Response

201: the answer's fields

Field	Type	Description
`id`	string	Invoice id.
`organizationId`	string
`identifier`	string	INV-n, unique per organization.
`customerId`	string
`jobId`	string or null
`status`	enum	DRAFT (not issued), SENT (issued, money due), PAID, OVERDUE (past `dueDate`) or CANCELLED. One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`subtotalCents`	integer	Lines total before tax, in integer cents.
`taxRate`	number	Tax rate in percent.
`taxCents`	integer	Tax, in integer cents.
`totalCents`	integer	Total with tax, in integer cents.
`notes`	string or null
`dueDate`	string or null	YYYY-MM-DD
`paidDate`	string or null	YYYY-MM-DD
`amountPaidCents`	integer	Paid so far, net of refunds, tips excluded, in integer cents.
`membershipId`	string or null	Set on a membership's billing invoice.
`memberPricingRemoved`	boolean
`financingDisabled`	boolean
`progressBillingId`	string or null
`progressRole`	enum or null	Its place in a progress billing. One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`progressMilestoneId`	string or null
`progressBilledCents`	integer	Billed towards the contract on a progress invoice, in integer cents.
`retainageCents`	integer	Retainage held on a progress invoice, in integer cents.
`businessUnitId`	string or null
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=INVOICE).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`customer`	object
`customer.id`	string
`customer.name`	string
`businessUnit`	object or null	The business unit.
`businessUnit.id`	string
`businessUnit.name`	string
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.signedBy`	string or null	Work accepted by (the job's sign-off).
`job.signedAt`	string (date-time) or null
`balanceDueCents`	integer	Still due, in integer cents.
`partiallyPaid`	boolean

Get an invoice with its lines and payments

GET /organizations/{organizationId}/invoices/{invoiceId}

Includes payments (with refunds), amountPaidCents (net of refunds, tips excluded), balanceDueCents, tipsCents, partiallyPaid and publicToken (the /i/{token} link, null until made). Read-only.

Permission: invoices.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices), Member); risk read (OAuth scope servflo.read).


Permission	`invoices.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`invoices_get` (toolset `invoices`, in the default set)

Parameters

Name	In	Type	Required	Description
`invoiceId`	path	string	Yes

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices/{invoiceId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`id`	string	Invoice id.
`organizationId`	string
`identifier`	string	INV-n, unique per organization.
`customerId`	string
`jobId`	string or null
`status`	enum	DRAFT (not issued), SENT (issued, money due), PAID, OVERDUE (past `dueDate`) or CANCELLED. One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`subtotalCents`	integer	Lines total before tax, in integer cents.
`taxRate`	number	Tax rate in percent.
`taxCents`	integer	Tax, in integer cents.
`totalCents`	integer	Total with tax, in integer cents.
`notes`	string or null
`dueDate`	string or null	YYYY-MM-DD
`paidDate`	string or null	YYYY-MM-DD
`amountPaidCents`	integer	Paid so far, net of refunds, tips excluded, in integer cents.
`membershipId`	string or null	Set on a membership's billing invoice.
`memberPricingRemoved`	boolean
`financingDisabled`	boolean
`progressBillingId`	string or null
`progressRole`	enum or null	Its place in a progress billing. One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`progressMilestoneId`	string or null
`progressBilledCents`	integer	Billed towards the contract on a progress invoice, in integer cents.
`retainageCents`	integer	Retainage held on a progress invoice, in integer cents.
`businessUnitId`	string or null
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=INVOICE).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`customer`	object
`customer.id`	string
`customer.name`	string
`customer.email`	string or null
`customer.phone`	string or null
`customer.address`	string or null
`customer.city`	string or null
`customer.state`	string or null
`customer.zip`	string or null
`businessUnit`	object or null	The business unit.
`businessUnit.id`	string
`businessUnit.name`	string
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.signedBy`	string or null	Work accepted by (the job's sign-off).
`job.signedAt`	string (date-time) or null
`balanceDueCents`	integer	Still due, in integer cents.
`partiallyPaid`	boolean
`lines`	array of object
`lines[].id`	string
`lines[].invoiceId`	string
`lines[].description`	string
`lines[].quantity`	number
`lines[].unitPriceCents`	integer	Unit price, in integer cents.
`lines[].totalCents`	integer	Line total, in integer cents.
`lines[].sortOrder`	integer
`lines[].kind`	enum or null	SERVICE or MATERIAL (member discount by kind), MEMBER_DISCOUNT (the automatic member pricing line) or MEMBERSHIP (a plan fee). One of `SERVICE`, `MATERIAL`, `MEMBER_DISCOUNT`, `MEMBERSHIP`.
`lines[].pricebookItemId`	string or null
`lines[].costCents`	integer or null	Our unit cost in cents (costing.read only).
`lines[].memberPriceApplied`	boolean
`quotes`	array of object	Quotes invoiced here (Q-n).
`quotes[].id`	string
`quotes[].identifier`	string	Q-n
`quotes[].status`	enum	DRAFT → SENT (customer can answer at /q/{publicToken}) → APPROVED / CHANGES_REQUESTED / DECLINED; APPROVED → CONVERTED (job or invoice made). SENT past `validUntil` becomes EXPIRED. One of `DRAFT`, `SENT`, `APPROVED`, `CHANGES_REQUESTED`, `DECLINED`, `CONVERTED`, `EXPIRED`, `ARCHIVED`.
`payments`	array of object	Payments on the invoice, with their refunds.
`payments[].id`	string
`payments[].identifier`	string	PAY-n
`payments[].amountCents`	integer
`payments[].tipCents`	integer
`payments[].refundedCents`	integer
`payments[].method`	enum	One of `CASH`, `CHECK`, `CARD`, `BANK_TRANSFER`, `OTHER`.
`payments[].paidOn`	string	YYYY-MM-DD
`payments[].status`	enum	One of `SUCCEEDED`, `PENDING`, `FAILED`, `REFUNDED`, `PARTIALLY_REFUNDED`.
`tipsCents`	integer	Tips collected, net of refunds, in integer cents.
`memberPricing`	object
`memberPricing.applied`	boolean	Member discount lines are on the document.
`memberPricing.removed`	boolean	Staff removed the member pricing from this document.
`memberPricing.membership`	object or null	The customer's active membership that would apply; null when not a member.
`memberPricing.membership.membershipId`	string
`memberPricing.membership.identifier`	string	MEM-n
`memberPricing.membership.planName`	string
`memberPricing.membership.serviceDiscountPercent`	number
`memberPricing.membership.materialDiscountPercent`	number
`memberPricing.membership.priority`	boolean
`publicToken`	string or null	The customer link token (/i/{token}); null until one is made.

Update an invoice's status, notes or dates

PATCH /organizations/{organizationId}/invoices/{invoiceId}

Amounts are fixed once created. MONEY: setting status: PAID while a balance is due records that balance as a payment (method OTHER, dated paidDate or today) so payments and status agree; prefer POST /invoices/{invoiceId}/payments to record the real method. An invoice paid in full cannot be set back to DRAFT/SENT/OVERDUE (refund a payment instead, 409), and one holding payments cannot be CANCELLED (409). paidDate is only for paid invoices. Marking SENT does not email anything.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk sensitive (OAuth scope servflo.sensitive).


Permission	`invoices.write`
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`invoices_update` (toolset `invoices`, in the default set)
Approval	Over MCP, this tool asks for your OK first (in the AI app when it supports it, otherwise in ServFlo). See Approvals.

Parameters

Name	In	Type	Required	Description
`invoiceId`	path	string	Yes

Request body

Field	Type	Required	Description
`status`	enum	No	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`notes`	string or null	No
`dueDate`	empty string or string or null	No
`paidDate`	empty string or string or null	No
`businessUnitId`	string or null	No	Move the invoice to another business unit (GET /business-units), or null for none. Up to 100 characters.
`financingDisabled`	boolean	No	Exposes to customers: true hides Affirm and Klarna on this invoice's pay page even when the business offers financing.
`today`	string	No	The business's today (YYYY-MM-DD), for the paid date and reopened-overdue checks.
`customFields`	object	No	Custom field values by key (definitions: GET /custom-fields?entity=INVOICE); merged into the saved values on an update, null clears one. Checked against each field's type and options; unknown keys are refused.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices/{invoiceId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status":"DRAFT","notes":"string","dueDate":"2026-11-03"}'

Response

200: the answer's fields

Field	Type	Description
`id`	string	Invoice id.
`organizationId`	string
`identifier`	string	INV-n, unique per organization.
`customerId`	string
`jobId`	string or null
`status`	enum	DRAFT (not issued), SENT (issued, money due), PAID, OVERDUE (past `dueDate`) or CANCELLED. One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`subtotalCents`	integer	Lines total before tax, in integer cents.
`taxRate`	number	Tax rate in percent.
`taxCents`	integer	Tax, in integer cents.
`totalCents`	integer	Total with tax, in integer cents.
`notes`	string or null
`dueDate`	string or null	YYYY-MM-DD
`paidDate`	string or null	YYYY-MM-DD
`amountPaidCents`	integer	Paid so far, net of refunds, tips excluded, in integer cents.
`membershipId`	string or null	Set on a membership's billing invoice.
`memberPricingRemoved`	boolean
`financingDisabled`	boolean
`progressBillingId`	string or null
`progressRole`	enum or null	Its place in a progress billing. One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`progressMilestoneId`	string or null
`progressBilledCents`	integer	Billed towards the contract on a progress invoice, in integer cents.
`retainageCents`	integer	Retainage held on a progress invoice, in integer cents.
`businessUnitId`	string or null
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=INVOICE).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`customer`	object
`customer.id`	string
`customer.name`	string
`businessUnit`	object or null	The business unit.
`businessUnit.id`	string
`businessUnit.name`	string
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.signedBy`	string or null	Work accepted by (the job's sign-off).
`job.signedAt`	string (date-time) or null
`balanceDueCents`	integer	Still due, in integer cents.
`partiallyPaid`	boolean

Delete an invoice

DELETE /organizations/{organizationId}/invoices/{invoiceId}

Destructive: deletes the invoice and its lines. Refused (409) while the invoice holds any payment; cancel it instead.


Permission	`invoices.delete` (Owner, Admin)
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`invoices_delete` (toolset `invoices`)
Approval	Over MCP, this tool always waits for your approval in ServFlo. See Approvals.

Parameters

Name	In	Type	Required	Description
`invoiceId`	path	string	Yes

Example

curl -X DELETE "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices/{invoiceId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`ok`	true

Remove or re-apply member pricing on a draft invoice

POST /organizations/{organizationId}/invoices/{invoiceId}/member-pricing

Member pricing: applied: false removes the automatic member discount lines and recomputes the totals; applied: true adds them back from the customer's active membership (409 when there is none). Only for DRAFT invoices without payments (amounts are fixed once issued; 409 otherwise). Read the state from GET /invoices/{invoiceId} (memberPricing).

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`invoices_setMemberPricing` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`invoiceId`	path	string	Yes

Request body

Field	Type	Required	Description
`applied`	boolean	Yes	true: apply the member discount; false: remove it.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices/{invoiceId}/member-pricing" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"applied":true}'

Response

200: the answer's fields

Field	Type	Description
`id`	string	Invoice id.
`organizationId`	string
`identifier`	string	INV-n, unique per organization.
`customerId`	string
`jobId`	string or null
`status`	enum	DRAFT (not issued), SENT (issued, money due), PAID, OVERDUE (past `dueDate`) or CANCELLED. One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`subtotalCents`	integer	Lines total before tax, in integer cents.
`taxRate`	number	Tax rate in percent.
`taxCents`	integer	Tax, in integer cents.
`totalCents`	integer	Total with tax, in integer cents.
`notes`	string or null
`dueDate`	string or null	YYYY-MM-DD
`paidDate`	string or null	YYYY-MM-DD
`amountPaidCents`	integer	Paid so far, net of refunds, tips excluded, in integer cents.
`membershipId`	string or null	Set on a membership's billing invoice.
`memberPricingRemoved`	boolean
`financingDisabled`	boolean
`progressBillingId`	string or null
`progressRole`	enum or null	Its place in a progress billing. One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`progressMilestoneId`	string or null
`progressBilledCents`	integer	Billed towards the contract on a progress invoice, in integer cents.
`retainageCents`	integer	Retainage held on a progress invoice, in integer cents.
`businessUnitId`	string or null
`customFields`	any	Custom field values by key (definitions: GET /custom-fields?entity=INVOICE).
`createdAt`	string (date-time)
`updatedAt`	string (date-time)
`customer`	object
`customer.id`	string
`customer.name`	string
`customer.email`	string or null
`customer.phone`	string or null
`customer.address`	string or null
`customer.city`	string or null
`customer.state`	string or null
`customer.zip`	string or null
`businessUnit`	object or null	The business unit.
`businessUnit.id`	string
`businessUnit.name`	string
`job`	object or null
`job.id`	string
`job.identifier`	string	JOB-n
`job.signedBy`	string or null	Work accepted by (the job's sign-off).
`job.signedAt`	string (date-time) or null
`balanceDueCents`	integer	Still due, in integer cents.
`partiallyPaid`	boolean
`lines`	array of object
`lines[].id`	string
`lines[].invoiceId`	string
`lines[].description`	string
`lines[].quantity`	number
`lines[].unitPriceCents`	integer	Unit price, in integer cents.
`lines[].totalCents`	integer	Line total, in integer cents.
`lines[].sortOrder`	integer
`lines[].kind`	enum or null	SERVICE or MATERIAL (member discount by kind), MEMBER_DISCOUNT (the automatic member pricing line) or MEMBERSHIP (a plan fee). One of `SERVICE`, `MATERIAL`, `MEMBER_DISCOUNT`, `MEMBERSHIP`.
`lines[].pricebookItemId`	string or null
`lines[].costCents`	integer or null	Our unit cost in cents (costing.read only).
`lines[].memberPriceApplied`	boolean
`quotes`	array of object	Quotes invoiced here (Q-n).
`quotes[].id`	string
`quotes[].identifier`	string	Q-n
`quotes[].status`	enum	DRAFT → SENT (customer can answer at /q/{publicToken}) → APPROVED / CHANGES_REQUESTED / DECLINED; APPROVED → CONVERTED (job or invoice made). SENT past `validUntil` becomes EXPIRED. One of `DRAFT`, `SENT`, `APPROVED`, `CHANGES_REQUESTED`, `DECLINED`, `CONVERTED`, `EXPIRED`, `ARCHIVED`.
`payments`	array of object	Payments on the invoice, with their refunds.
`payments[].id`	string
`payments[].identifier`	string	PAY-n
`payments[].amountCents`	integer
`payments[].tipCents`	integer
`payments[].refundedCents`	integer
`payments[].method`	enum	One of `CASH`, `CHECK`, `CARD`, `BANK_TRANSFER`, `OTHER`.
`payments[].paidOn`	string	YYYY-MM-DD
`payments[].status`	enum	One of `SUCCEEDED`, `PENDING`, `FAILED`, `REFUNDED`, `PARTIALLY_REFUNDED`.
`tipsCents`	integer	Tips collected, net of refunds, in integer cents.
`memberPricing`	object
`memberPricing.applied`	boolean	Member discount lines are on the document.
`memberPricing.removed`	boolean	Staff removed the member pricing from this document.
`memberPricing.membership`	object or null	The customer's active membership that would apply; null when not a member.
`memberPricing.membership.membershipId`	string
`memberPricing.membership.identifier`	string	MEM-n
`memberPricing.membership.planName`	string
`memberPricing.membership.serviceDiscountPercent`	number
`memberPricing.membership.materialDiscountPercent`	number
`memberPricing.membership.priority`	boolean
`publicToken`	string or null	The customer link token (/i/{token}); null until one is made.

Jobs ready to invoice

GET /organizations/{organizationId}/invoice-batches/jobs

Batch invoicing, step 1: jobs not on any live invoice and not billed in progress invoices, oldest first. By default only COMPLETED jobs (ready to invoice); readyOnly: false adds scheduled and in-progress ones. Filter by the job's date (from/to, YYYY-MM-DD), customer, service type, technician (lead or crew) or text. Each row carries its subtotal before member discount and tax, and warnings. Read-only. Next: GET /invoice-batches/preview, then POST /invoice-batches.

Permission: invoices.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices), Member); risk read (OAuth scope servflo.read).


Permission	`invoices.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`invoices_billableJobs` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`from`	query	string	No	A calendar date in the business's own calendar, YYYY-MM-DD.
`to`	query	string	No	A calendar date in the business's own calendar, YYYY-MM-DD.
`customerId`	query	string	No
`serviceTypeId`	query	string	No
`technicianId`	query	string	No
`readyOnly`	query	enum	No	Default true: completed jobs only. One of `true`, `false`.
`query`	query	string	No	Free-text search over the list's names, numbers and contact details. Up to 200 characters.
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoice-batches/jobs" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string
`items[].identifier`	string	JOB-n
`items[].status`	string
`items[].scheduledDate`	string
`items[].customerId`	string
`items[].customerName`	string
`items[].serviceTypeName`	string or null
`items[].technicianId`	string or null
`items[].technicianName`	string or null
`items[].subtotalCents`	integer	Service price plus materials, before member discount and tax.
`items[].taxRate`	number
`items[].ready`	boolean	Completed: ready to invoice.
`items[].warnings`	array of string
`total`	integer

Preview a batch of invoices

GET /organizations/{organizationId}/invoice-batches/preview

Batch invoicing, step 2: the invoices POST /invoice-batches would create for these jobs (one per job, or with perCustomer one per customer and tax rate combining their jobs): lines, member discount, tax, total and deposits that would move onto each; plus the jobs it would skip and why. Creates nothing.

Permission: invoices.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices), Member); risk read (OAuth scope servflo.read).


Permission	`invoices.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`invoices_batchPreview` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`jobIds`	query	string	Yes	Job ids, comma separated (from GET /invoice-batches/jobs). Up to 8000 characters.
`perCustomer`	query	enum	No	true: one invoice per customer combining their jobs. One of `true`, `false`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoice-batches/preview?jobIds=string" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`invoices`	array of object
`invoices[].customerId`	string
`invoices[].customerName`	string
`invoices[].jobIds`	array of string
`invoices[].jobIdentifiers`	array of string
`invoices[].lineCount`	integer
`invoices[].taxRate`	number
`invoices[].subtotalCents`	integer
`invoices[].taxCents`	integer
`invoices[].totalCents`	integer
`invoices[].depositsCents`	integer	Deposits on the jobs' quotes that move onto the invoice.
`skipped`	array of object
`skipped[].jobId`	string
`skipped[].identifier`	string or null
`skipped[].reason`	string
`totalCents`	integer

Create invoices for many jobs

POST /organizations/{organizationId}/invoice-batches

Batch invoicing, step 3: creates DRAFT invoices (INV-n) for the given jobs, one per job or (perCustomer) one per customer and tax rate, priced as POST /jobs/{jobId}/invoice would (member pricing, the job property's tax, deposits on the job's quote moved on). Answers one row per job: CREATED with the invoice, SKIPPED (already invoiced, progress-billed, cancelled, not found) or FAILED with the reason; one failing never stops the others. Safe to re-run: an invoiced job is skipped, under a lock per job. Nothing is sent: then POST /invoice-batches/send. Emits invoice.created per invoice and invoice_batch.completed.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`invoices_batchCreate` (toolset `invoices`)

Request body

Field	Type	Required	Description
`jobIds`	array of string	Yes	From GET /invoice-batches/jobs. Up to 200 items.
`perCustomer`	boolean	No	One invoice per customer combining their jobs.
`dueDate`	empty string or string or null	No	Defaults from each customer's payment terms.
`batchKey`	string	No	Your key for this batch (e.g. a UUID). Running a batch again with the same key never invoices a job twice nor sends a message twice; omit it and one is made. Up to 100 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoice-batches" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jobIds":["job_id"]}'

Response

200: the answer's fields

Field	Type	Description
`batchKey`	string
`requested`	integer
`succeeded`	integer
`skipped`	integer
`failed`	integer
`invoiceIds`	array of string
`results`	array of object
`results[].jobId`	string
`results[].identifier`	string or null
`results[].outcome`	enum	One of `CREATED`, `SENT`, `QUEUED`, `MARKED`, `SKIPPED`, `FAILED`.
`results[].invoiceId`	string or null
`results[].invoiceIdentifier`	string or null
`results[].reason`	string or null

Send many invoices

POST /organizations/{organizationId}/invoice-batches/send

Customer-facing: emails or texts each invoice to its billing contact with the business's invoice template and link, exactly as the Send dialog would (POST /messages/send); a draft is issued (SENT). channel EMAIL, SMS, or EMAIL_OR_SMS (email, else text). Consent applies: no text without OK-to-text or after STOP, opted-out emails are skipped, quiet hours hold texts. One row per invoice: SENT, QUEUED (held for quiet hours) or SKIPPED/FAILED with the reason (paid, cancelled, no address, no consent). Re-running with the same batchKey never sends twice. In test mode messages are logged, not sent.


Permission	`messages.send` (Owner, Admin, Dispatcher)
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`invoices_batchSend` (toolset `invoices`)
Approval	Over MCP, this tool always waits for your approval in ServFlo. See Approvals.

Request body

Field	Type	Required	Description
`invoiceIds`	array of string	Yes	Invoice ids from GET /invoices, at most 200. Up to 200 items.
`channel`	enum	No	One of `EMAIL`, `SMS`, `EMAIL_OR_SMS`. Default `EMAIL`.
`batchKey`	string	No	Your key for this batch (e.g. a UUID). Running a batch again with the same key never invoices a job twice nor sends a message twice; omit it and one is made. Up to 100 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoice-batches/send" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"invoiceIds":["invoice_id"]}'

Response

200: the answer's fields

Field	Type	Description
`batchKey`	string
`requested`	integer
`succeeded`	integer
`skipped`	integer
`failed`	integer
`results`	array of object
`results[].invoiceId`	string
`results[].identifier`	string or null
`results[].outcome`	enum	One of `CREATED`, `SENT`, `QUEUED`, `MARKED`, `SKIPPED`, `FAILED`.
`results[].reason`	string or null
`results[].channel`	enum or null	One of `EMAIL`, `SMS`.
`results[].messageId`	string or null

Send payment reminders for many invoices

POST /organizations/{organizationId}/invoice-batches/remind

Customer-facing: a payment reminder (the business's overdue template) for each SENT or OVERDUE invoice with a balance due; drafts, paid and cancelled invoices are skipped with the reason. Same channels, consent rules, per-row answer and batchKey replay safety as POST /invoice-batches/send.


Permission	`messages.send` (Owner, Admin, Dispatcher)
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`invoices_batchRemind` (toolset `invoices`)
Approval	Over MCP, this tool always waits for your approval in ServFlo. See Approvals.

Request body

Field	Type	Required	Description
`invoiceIds`	array of string	Yes	Invoice ids from GET /invoices, at most 200. Up to 200 items.
`channel`	enum	No	One of `EMAIL`, `SMS`, `EMAIL_OR_SMS`. Default `EMAIL`.
`batchKey`	string	No	Your key for this batch (e.g. a UUID). Running a batch again with the same key never invoices a job twice nor sends a message twice; omit it and one is made. Up to 100 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoice-batches/remind" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"invoiceIds":["invoice_id"]}'

Response

200: the answer's fields

Field	Type	Description
`batchKey`	string
`requested`	integer
`succeeded`	integer
`skipped`	integer
`failed`	integer
`results`	array of object
`results[].invoiceId`	string
`results[].identifier`	string or null
`results[].outcome`	enum	One of `CREATED`, `SENT`, `QUEUED`, `MARKED`, `SKIPPED`, `FAILED`.
`results[].reason`	string or null
`results[].channel`	enum or null	One of `EMAIL`, `SMS`.
`results[].messageId`	string or null

Mark many invoices as sent

POST /organizations/{organizationId}/invoice-batches/mark-sent

Issues each DRAFT invoice (status SENT, invoice.sent emitted) without contacting the customer, e.g. after mailing or handing them over. Invoices already issued are skipped. One row per invoice.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`invoices_batchMarkSent` (toolset `invoices`)

Request body

Field	Type	Required	Description
`invoiceIds`	array of string	Yes	Invoice ids from GET /invoices, at most 200. Up to 200 items.
`batchKey`	string	No	Your key for this batch (e.g. a UUID). Running a batch again with the same key never invoices a job twice nor sends a message twice; omit it and one is made. Up to 100 characters.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoice-batches/mark-sent" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"invoiceIds":["invoice_id"]}'

Response

200: the answer's fields

Field	Type	Description
`batchKey`	string
`requested`	integer
`succeeded`	integer
`skipped`	integer
`failed`	integer
`results`	array of object
`results[].invoiceId`	string
`results[].identifier`	string or null
`results[].outcome`	enum	One of `CREATED`, `SENT`, `QUEUED`, `MARKED`, `SKIPPED`, `FAILED`.
`results[].reason`	string or null
`results[].channel`	enum or null	One of `EMAIL`, `SMS`.
`results[].messageId`	string or null

List progress billings

GET /organizations/{organizationId}/progress-billings

Quotes and jobs billed in progress invoices, newest first, with contract, billed to date, remaining and retainage. Filter by customer, quote, job or status (ACTIVE / COMPLETED). Read-only.

Permission: invoices.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices), Member); risk read (OAuth scope servflo.read).


Permission	`invoices.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`progressBilling_list` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`customerId`	query	string	No
`quoteId`	query	string	No	The progress billing of this quote, if any.
`jobId`	query	string	No	The progress billing of this job, if any.
`status`	query	enum	No	One of `ACTIVE`, `COMPLETED`.
`limit`	query	integer	No	Page size, 1–200. Default `50`.
`offset`	query	integer	No	Rows to skip; the answer's `total` counts every match. Default `0`.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`items`	array of object
`items[].id`	string
`items[].customerId`	string
`items[].customer`	object
`items[].customer.id`	string
`items[].customer.name`	string
`items[].quoteId`	string or null
`items[].quote`	object or null
`items[].quote.id`	string
`items[].quote.identifier`	string
`items[].quote.title`	string
`items[].jobId`	string or null
`items[].job`	object or null
`items[].job.id`	string
`items[].job.identifier`	string
`items[].title`	string
`items[].method`	enum	One of `MILESTONES`, `PERCENT_COMPLETE`.
`items[].contractCents`	integer	The contract before tax.
`items[].taxRate`	number
`items[].retainagePercent`	number
`items[].status`	enum	One of `ACTIVE`, `COMPLETED`.
`items[].createdAt`	string (date-time)
`items[].lines`	array of object
`items[].lines[].id`	string
`items[].lines[].description`	string
`items[].lines[].quantity`	number
`items[].lines[].unitPriceCents`	integer
`items[].lines[].contractCents`	integer
`items[].lines[].billedCents`	integer
`items[].lines[].percentComplete`	number
`items[].milestones`	array of object
`items[].milestones[].id`	string
`items[].milestones[].name`	string
`items[].milestones[].percent`	number
`items[].milestones[].amountCents`	integer
`items[].milestones[].invoiceId`	string or null
`items[].milestones[].invoiceIdentifier`	string or null
`items[].invoices`	array of object
`items[].invoices[].id`	string
`items[].invoices[].identifier`	string
`items[].invoices[].status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`items[].invoices[].role`	enum or null	One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`items[].invoices[].milestoneId`	string or null
`items[].invoices[].billedCents`	integer
`items[].invoices[].retainageCents`	integer	Held (positive) or released (negative).
`items[].invoices[].totalCents`	integer
`items[].invoices[].amountPaidCents`	integer
`items[].invoices[].balanceDueCents`	integer
`items[].invoices[].dueDate`	string or null
`items[].invoices[].createdAt`	string (date-time)
`items[].summary`	object
`items[].summary.contractCents`	integer
`items[].summary.billedCents`	integer	Contract work billed to date, before retainage and tax.
`items[].summary.remainingCents`	integer
`items[].summary.percentBilled`	number
`items[].summary.retainageHeldCents`	integer
`items[].summary.retainageReleasedCents`	integer
`items[].summary.retainageOutstandingCents`	integer
`items[].summary.invoicedTotalCents`	integer	Invoice totals (after retainage, with tax).
`items[].summary.paidCents`	integer
`items[].summary.hasFinal`	boolean
`items[].summary.complete`	boolean
`items[].summary.finalProblem`	string or null	Why a final invoice cannot be made now, or null.
`items[].summary.releaseProblem`	string or null	Why the retainage cannot be released now, or null.
`total`	integer

Bill a quote or job in progress invoices

POST /organizations/{organizationId}/progress-billings

Freezes the contract from an APPROVED (or converted) quote not yet invoiced (its chosen lines and tax) or from a job not yet invoiced (service and materials, member-priced; a job sold through a quote uses the quote). method MILESTONES (milestones adding to 100%) or PERCENT_COMPLETE (bill each line as it progresses). retainagePercent (0–50) is held back on each invoice until the retainage release. Afterwards the quote/job can no longer be invoiced in one go (409): bill it through POST /progress-billings/{id}/invoices. Deposits on the quote move onto the first invoice. Creates no invoice. Emits progress_billing.created.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`progressBilling_create` (toolset `invoices`)

Request body

Field	Type	Required	Description
`quoteId`	string	No	An approved quote (GET /quotes). Give this or jobId.
`jobId`	string	No	A job (GET /jobs). Give this or quoteId.
`title`	string or null	No	Up to 200 characters.
`method`	enum	Yes	One of `MILESTONES`, `PERCENT_COMPLETE`.
`retainagePercent`	number	No	Default 0 (none). 0–50.
`milestones`	array of object	No	MILESTONES only: names and percents adding up to 100, e.g. Deposit 30, Rough-in 40, Completion 30. Up to 20 items.
`milestones[].name`	string	Yes	Up to 200 characters.
`milestones[].percent`	number	Yes	Percent of the contract, e.g. 30. At most 100.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"method":"MILESTONES"}'

Response

201: the answer's fields

Field	Type	Description
`id`	string
`customerId`	string
`customer`	object
`customer.id`	string
`customer.name`	string
`quoteId`	string or null
`quote`	object or null
`quote.id`	string
`quote.identifier`	string
`quote.title`	string
`jobId`	string or null
`job`	object or null
`job.id`	string
`job.identifier`	string
`title`	string
`method`	enum	One of `MILESTONES`, `PERCENT_COMPLETE`.
`contractCents`	integer	The contract before tax.
`taxRate`	number
`retainagePercent`	number
`status`	enum	One of `ACTIVE`, `COMPLETED`.
`createdAt`	string (date-time)
`lines`	array of object
`lines[].id`	string
`lines[].description`	string
`lines[].quantity`	number
`lines[].unitPriceCents`	integer
`lines[].contractCents`	integer
`lines[].billedCents`	integer
`lines[].percentComplete`	number
`milestones`	array of object
`milestones[].id`	string
`milestones[].name`	string
`milestones[].percent`	number
`milestones[].amountCents`	integer
`milestones[].invoiceId`	string or null
`milestones[].invoiceIdentifier`	string or null
`invoices`	array of object
`invoices[].id`	string
`invoices[].identifier`	string
`invoices[].status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`invoices[].role`	enum or null	One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`invoices[].milestoneId`	string or null
`invoices[].billedCents`	integer
`invoices[].retainageCents`	integer	Held (positive) or released (negative).
`invoices[].totalCents`	integer
`invoices[].amountPaidCents`	integer
`invoices[].balanceDueCents`	integer
`invoices[].dueDate`	string or null
`invoices[].createdAt`	string (date-time)
`summary`	object
`summary.contractCents`	integer
`summary.billedCents`	integer	Contract work billed to date, before retainage and tax.
`summary.remainingCents`	integer
`summary.percentBilled`	number
`summary.retainageHeldCents`	integer
`summary.retainageReleasedCents`	integer
`summary.retainageOutstandingCents`	integer
`summary.invoicedTotalCents`	integer	Invoice totals (after retainage, with tax).
`summary.paidCents`	integer
`summary.hasFinal`	boolean
`summary.complete`	boolean
`summary.finalProblem`	string or null	Why a final invoice cannot be made now, or null.
`summary.releaseProblem`	string or null	Why the retainage cannot be released now, or null.

Get a progress billing

GET /organizations/{organizationId}/progress-billings/{progressBillingId}

The contract (lines, milestones, retainage), its invoices and the summary: billed to date, remaining, retainage held and released, and whether a final or retainage-release invoice can be made (with the reason when not). Read-only.

Permission: invoices.read (Owner, Admin, Dispatcher, Technician (own jobs' invoices), Member); risk read (OAuth scope servflo.read).


Permission	`invoices.read`
Risk	`read`, OAuth scope `servflo.read`. Read: reads only.
MCP tool	`progressBilling_get` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`progressBillingId`	path	string	Yes	A progress billing id, from GET /progress-billings.

Example

curl "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings/{progressBillingId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`id`	string
`customerId`	string
`customer`	object
`customer.id`	string
`customer.name`	string
`quoteId`	string or null
`quote`	object or null
`quote.id`	string
`quote.identifier`	string
`quote.title`	string
`jobId`	string or null
`job`	object or null
`job.id`	string
`job.identifier`	string
`title`	string
`method`	enum	One of `MILESTONES`, `PERCENT_COMPLETE`.
`contractCents`	integer	The contract before tax.
`taxRate`	number
`retainagePercent`	number
`status`	enum	One of `ACTIVE`, `COMPLETED`.
`createdAt`	string (date-time)
`lines`	array of object
`lines[].id`	string
`lines[].description`	string
`lines[].quantity`	number
`lines[].unitPriceCents`	integer
`lines[].contractCents`	integer
`lines[].billedCents`	integer
`lines[].percentComplete`	number
`milestones`	array of object
`milestones[].id`	string
`milestones[].name`	string
`milestones[].percent`	number
`milestones[].amountCents`	integer
`milestones[].invoiceId`	string or null
`milestones[].invoiceIdentifier`	string or null
`invoices`	array of object
`invoices[].id`	string
`invoices[].identifier`	string
`invoices[].status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`invoices[].role`	enum or null	One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`invoices[].milestoneId`	string or null
`invoices[].billedCents`	integer
`invoices[].retainageCents`	integer	Held (positive) or released (negative).
`invoices[].totalCents`	integer
`invoices[].amountPaidCents`	integer
`invoices[].balanceDueCents`	integer
`invoices[].dueDate`	string or null
`invoices[].createdAt`	string (date-time)
`summary`	object
`summary.contractCents`	integer
`summary.billedCents`	integer	Contract work billed to date, before retainage and tax.
`summary.remainingCents`	integer
`summary.percentBilled`	number
`summary.retainageHeldCents`	integer
`summary.retainageReleasedCents`	integer
`summary.retainageOutstandingCents`	integer
`summary.invoicedTotalCents`	integer	Invoice totals (after retainage, with tax).
`summary.paidCents`	integer
`summary.hasFinal`	boolean
`summary.complete`	boolean
`summary.finalProblem`	string or null	Why a final invoice cannot be made now, or null.
`summary.releaseProblem`	string or null	Why the retainage cannot be released now, or null.

Change a progress billing

PATCH /organizations/{organizationId}/progress-billings/{progressBillingId}

The title any time; the method, retainage and milestones only while nothing has been invoiced (409 otherwise; cancelled invoices do not count). The contract itself never changes.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`progressBilling_update` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`progressBillingId`	path	string	Yes	A progress billing id, from GET /progress-billings.

Request body

Field	Type	Required	Description
`title`	string or null	No	Up to 200 characters.
`method`	enum	No	One of `MILESTONES`, `PERCENT_COMPLETE`.
`retainagePercent`	number	No	0–50.
`milestones`	array of object	No	MILESTONES only: names and percents adding up to 100, e.g. Deposit 30, Rough-in 40, Completion 30. Up to 20 items.
`milestones[].name`	string	Yes	Up to 200 characters.
`milestones[].percent`	number	Yes	Percent of the contract, e.g. 30. At most 100.

Example

curl -X PATCH "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings/{progressBillingId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","method":"MILESTONES","retainagePercent":1}'

Response

200: the answer's fields

Field	Type	Description
`id`	string
`customerId`	string
`customer`	object
`customer.id`	string
`customer.name`	string
`quoteId`	string or null
`quote`	object or null
`quote.id`	string
`quote.identifier`	string
`quote.title`	string
`jobId`	string or null
`job`	object or null
`job.id`	string
`job.identifier`	string
`title`	string
`method`	enum	One of `MILESTONES`, `PERCENT_COMPLETE`.
`contractCents`	integer	The contract before tax.
`taxRate`	number
`retainagePercent`	number
`status`	enum	One of `ACTIVE`, `COMPLETED`.
`createdAt`	string (date-time)
`lines`	array of object
`lines[].id`	string
`lines[].description`	string
`lines[].quantity`	number
`lines[].unitPriceCents`	integer
`lines[].contractCents`	integer
`lines[].billedCents`	integer
`lines[].percentComplete`	number
`milestones`	array of object
`milestones[].id`	string
`milestones[].name`	string
`milestones[].percent`	number
`milestones[].amountCents`	integer
`milestones[].invoiceId`	string or null
`milestones[].invoiceIdentifier`	string or null
`invoices`	array of object
`invoices[].id`	string
`invoices[].identifier`	string
`invoices[].status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`invoices[].role`	enum or null	One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`invoices[].milestoneId`	string or null
`invoices[].billedCents`	integer
`invoices[].retainageCents`	integer	Held (positive) or released (negative).
`invoices[].totalCents`	integer
`invoices[].amountPaidCents`	integer
`invoices[].balanceDueCents`	integer
`invoices[].dueDate`	string or null
`invoices[].createdAt`	string (date-time)
`summary`	object
`summary.contractCents`	integer
`summary.billedCents`	integer	Contract work billed to date, before retainage and tax.
`summary.remainingCents`	integer
`summary.percentBilled`	number
`summary.retainageHeldCents`	integer
`summary.retainageReleasedCents`	integer
`summary.retainageOutstandingCents`	integer
`summary.invoicedTotalCents`	integer	Invoice totals (after retainage, with tax).
`summary.paidCents`	integer
`summary.hasFinal`	boolean
`summary.complete`	boolean
`summary.finalProblem`	string or null	Why a final invoice cannot be made now, or null.
`summary.releaseProblem`	string or null	Why the retainage cannot be released now, or null.

Stop billing in progress invoices

DELETE /organizations/{organizationId}/progress-billings/{progressBillingId}

Destructive: removes a progress billing that has no live invoices (409 otherwise: cancel them first), so the quote or job can be invoiced normally again.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk sensitive (OAuth scope servflo.sensitive).


Permission	`invoices.write`
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`progressBilling_delete` (toolset `invoices`)
Approval	Over MCP, this tool always waits for your approval in ServFlo. See Approvals.

Parameters

Name	In	Type	Required	Description
`progressBillingId`	path	string	Yes	A progress billing id, from GET /progress-billings.

Example

curl -X DELETE "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings/{progressBillingId}" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`ok`	true

Create a progress invoice

POST /organizations/{organizationId}/progress-billings/{progressBillingId}/invoices

Creates a DRAFT progress invoice for part of the contract. Give exactly one of: milestoneId (MILESTONES: that milestone's share; 409 when already invoiced), percentOfContract or amountCents (MILESTONES: an extra partial invoice), or lines (PERCENT_COMPLETE: each line's new cumulative percent complete; the difference is billed; percents cannot go down). Never bills beyond the contract (409 with what is left). Retainage at the plan's percent is held back as a negative line; tax at the contract's rate. The first invoice receives the quote's deposits (it must be at least that much). Nothing is sent. Emits invoice.created and progress_billing.invoiced.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`progressBilling_invoice` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`progressBillingId`	path	string	Yes	A progress billing id, from GET /progress-billings.

Request body

Field	Type	Required	Description
`milestoneId`	string	No	From the progress billing's `milestones`.
`percentOfContract`	number	No	At most 100.
`amountCents`	integer	No	1–100000000.
`lines`	array of object	No	Up to 500 items.
`lines[].lineId`	string	Yes	From the progress billing's `lines`.
`lines[].percentComplete`	number	Yes	0–100.
`dueDate`	empty string or string or null	No	Defaults from the customer's payment terms.
`notes`	string or null	No	Printed on the invoice.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings/{progressBillingId}/invoices" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"milestoneId":"milestone_id","percentOfContract":1,"amountCents":12500}'

Response

201: the answer's fields

Field	Type	Description
`invoice`	object
`invoice.id`	string
`invoice.identifier`	string
`invoice.status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`invoice.totalCents`	integer
`progressBilling`	object
`progressBilling.id`	string
`progressBilling.customerId`	string
`progressBilling.customer`	object
`progressBilling.customer.id`	string
`progressBilling.customer.name`	string
`progressBilling.quoteId`	string or null
`progressBilling.quote`	object or null
`progressBilling.quote.id`	string
`progressBilling.quote.identifier`	string
`progressBilling.quote.title`	string
`progressBilling.jobId`	string or null
`progressBilling.job`	object or null
`progressBilling.job.id`	string
`progressBilling.job.identifier`	string
`progressBilling.title`	string
`progressBilling.method`	enum	One of `MILESTONES`, `PERCENT_COMPLETE`.
`progressBilling.contractCents`	integer	The contract before tax.
`progressBilling.taxRate`	number
`progressBilling.retainagePercent`	number
`progressBilling.status`	enum	One of `ACTIVE`, `COMPLETED`.
`progressBilling.createdAt`	string (date-time)
`progressBilling.lines`	array of object
`progressBilling.lines[].id`	string
`progressBilling.lines[].description`	string
`progressBilling.lines[].quantity`	number
`progressBilling.lines[].unitPriceCents`	integer
`progressBilling.lines[].contractCents`	integer
`progressBilling.lines[].billedCents`	integer
`progressBilling.lines[].percentComplete`	number
`progressBilling.milestones`	array of object
`progressBilling.milestones[].id`	string
`progressBilling.milestones[].name`	string
`progressBilling.milestones[].percent`	number
`progressBilling.milestones[].amountCents`	integer
`progressBilling.milestones[].invoiceId`	string or null
`progressBilling.milestones[].invoiceIdentifier`	string or null
`progressBilling.invoices`	array of object
`progressBilling.invoices[].id`	string
`progressBilling.invoices[].identifier`	string
`progressBilling.invoices[].status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`progressBilling.invoices[].role`	enum or null	One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`progressBilling.invoices[].milestoneId`	string or null
`progressBilling.invoices[].billedCents`	integer
`progressBilling.invoices[].retainageCents`	integer	Held (positive) or released (negative).
`progressBilling.invoices[].totalCents`	integer
`progressBilling.invoices[].amountPaidCents`	integer
`progressBilling.invoices[].balanceDueCents`	integer
`progressBilling.invoices[].dueDate`	string or null
`progressBilling.invoices[].createdAt`	string (date-time)
`progressBilling.summary`	object
`progressBilling.summary.contractCents`	integer
`progressBilling.summary.billedCents`	integer	Contract work billed to date, before retainage and tax.
`progressBilling.summary.remainingCents`	integer
`progressBilling.summary.percentBilled`	number
`progressBilling.summary.retainageHeldCents`	integer
`progressBilling.summary.retainageReleasedCents`	integer
`progressBilling.summary.retainageOutstandingCents`	integer
`progressBilling.summary.invoicedTotalCents`	integer	Invoice totals (after retainage, with tax).
`progressBilling.summary.paidCents`	integer
`progressBilling.summary.hasFinal`	boolean
`progressBilling.summary.complete`	boolean
`progressBilling.summary.finalProblem`	string or null	Why a final invoice cannot be made now, or null.
`progressBilling.summary.releaseProblem`	string or null	Why the retainage cannot be released now, or null.

Create the final invoice

POST /organizations/{organizationId}/progress-billings/{progressBillingId}/final-invoice

Creates the DRAFT final invoice: every contract line in full, less a credit line per earlier progress invoice, so it bills exactly what is left. Retainage is held on that remainder, unless releaseRetainage: true releases every earlier retainage on it instead. 409 when nothing is left or a final exists. Emits progress_billing.invoiced (and .completed when nothing remains).

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`progressBilling_finalInvoice` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`progressBillingId`	path	string	Yes	A progress billing id, from GET /progress-billings.

Request body

Field	Type	Required	Description
`releaseRetainage`	boolean	No	Release the retainage held so far on this invoice.
`dueDate`	empty string or string or null	No	Defaults from the customer's payment terms.
`notes`	string or null	No	Printed on the invoice.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings/{progressBillingId}/final-invoice" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"releaseRetainage":true,"dueDate":"2026-11-03","notes":"string"}'

Response

201: the answer's fields

Field	Type	Description
`invoice`	object
`invoice.id`	string
`invoice.identifier`	string
`invoice.status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`invoice.totalCents`	integer
`progressBilling`	object
`progressBilling.id`	string
`progressBilling.customerId`	string
`progressBilling.customer`	object
`progressBilling.customer.id`	string
`progressBilling.customer.name`	string
`progressBilling.quoteId`	string or null
`progressBilling.quote`	object or null
`progressBilling.quote.id`	string
`progressBilling.quote.identifier`	string
`progressBilling.quote.title`	string
`progressBilling.jobId`	string or null
`progressBilling.job`	object or null
`progressBilling.job.id`	string
`progressBilling.job.identifier`	string
`progressBilling.title`	string
`progressBilling.method`	enum	One of `MILESTONES`, `PERCENT_COMPLETE`.
`progressBilling.contractCents`	integer	The contract before tax.
`progressBilling.taxRate`	number
`progressBilling.retainagePercent`	number
`progressBilling.status`	enum	One of `ACTIVE`, `COMPLETED`.
`progressBilling.createdAt`	string (date-time)
`progressBilling.lines`	array of object
`progressBilling.lines[].id`	string
`progressBilling.lines[].description`	string
`progressBilling.lines[].quantity`	number
`progressBilling.lines[].unitPriceCents`	integer
`progressBilling.lines[].contractCents`	integer
`progressBilling.lines[].billedCents`	integer
`progressBilling.lines[].percentComplete`	number
`progressBilling.milestones`	array of object
`progressBilling.milestones[].id`	string
`progressBilling.milestones[].name`	string
`progressBilling.milestones[].percent`	number
`progressBilling.milestones[].amountCents`	integer
`progressBilling.milestones[].invoiceId`	string or null
`progressBilling.milestones[].invoiceIdentifier`	string or null
`progressBilling.invoices`	array of object
`progressBilling.invoices[].id`	string
`progressBilling.invoices[].identifier`	string
`progressBilling.invoices[].status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`progressBilling.invoices[].role`	enum or null	One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`progressBilling.invoices[].milestoneId`	string or null
`progressBilling.invoices[].billedCents`	integer
`progressBilling.invoices[].retainageCents`	integer	Held (positive) or released (negative).
`progressBilling.invoices[].totalCents`	integer
`progressBilling.invoices[].amountPaidCents`	integer
`progressBilling.invoices[].balanceDueCents`	integer
`progressBilling.invoices[].dueDate`	string or null
`progressBilling.invoices[].createdAt`	string (date-time)
`progressBilling.summary`	object
`progressBilling.summary.contractCents`	integer
`progressBilling.summary.billedCents`	integer	Contract work billed to date, before retainage and tax.
`progressBilling.summary.remainingCents`	integer
`progressBilling.summary.percentBilled`	number
`progressBilling.summary.retainageHeldCents`	integer
`progressBilling.summary.retainageReleasedCents`	integer
`progressBilling.summary.retainageOutstandingCents`	integer
`progressBilling.summary.invoicedTotalCents`	integer	Invoice totals (after retainage, with tax).
`progressBilling.summary.paidCents`	integer
`progressBilling.summary.hasFinal`	boolean
`progressBilling.summary.complete`	boolean
`progressBilling.summary.finalProblem`	string or null	Why a final invoice cannot be made now, or null.
`progressBilling.summary.releaseProblem`	string or null	Why the retainage cannot be released now, or null.

Invoice the retainage held

POST /organizations/{organizationId}/progress-billings/{progressBillingId}/retainage-release

Creates a DRAFT retainage-release invoice for all retainage held and not yet released. Only once the whole contract is billed (after the final invoice; 409 otherwise). Emits progress_billing.invoiced and progress_billing.completed.

Permission: invoices.write (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk write (OAuth scope servflo.write).


Permission	`invoices.write`
Risk	`write`, OAuth scope `servflo.write`. Write: creates or changes records inside the business; nothing leaves it.
MCP tool	`progressBilling_releaseRetainage` (toolset `invoices`)

Parameters

Name	In	Type	Required	Description
`progressBillingId`	path	string	Yes	A progress billing id, from GET /progress-billings.

Request body

Field	Type	Required	Description
`dueDate`	empty string or string or null	No	Defaults from the customer's payment terms.
`notes`	string or null	No	Printed on the invoice.

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/progress-billings/{progressBillingId}/retainage-release" \
  -H "Authorization: Bearer $SERVFLO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"dueDate":"2026-11-03","notes":"string"}'

Response

201: the answer's fields

Field	Type	Description
`invoice`	object
`invoice.id`	string
`invoice.identifier`	string
`invoice.status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`invoice.totalCents`	integer
`progressBilling`	object
`progressBilling.id`	string
`progressBilling.customerId`	string
`progressBilling.customer`	object
`progressBilling.customer.id`	string
`progressBilling.customer.name`	string
`progressBilling.quoteId`	string or null
`progressBilling.quote`	object or null
`progressBilling.quote.id`	string
`progressBilling.quote.identifier`	string
`progressBilling.quote.title`	string
`progressBilling.jobId`	string or null
`progressBilling.job`	object or null
`progressBilling.job.id`	string
`progressBilling.job.identifier`	string
`progressBilling.title`	string
`progressBilling.method`	enum	One of `MILESTONES`, `PERCENT_COMPLETE`.
`progressBilling.contractCents`	integer	The contract before tax.
`progressBilling.taxRate`	number
`progressBilling.retainagePercent`	number
`progressBilling.status`	enum	One of `ACTIVE`, `COMPLETED`.
`progressBilling.createdAt`	string (date-time)
`progressBilling.lines`	array of object
`progressBilling.lines[].id`	string
`progressBilling.lines[].description`	string
`progressBilling.lines[].quantity`	number
`progressBilling.lines[].unitPriceCents`	integer
`progressBilling.lines[].contractCents`	integer
`progressBilling.lines[].billedCents`	integer
`progressBilling.lines[].percentComplete`	number
`progressBilling.milestones`	array of object
`progressBilling.milestones[].id`	string
`progressBilling.milestones[].name`	string
`progressBilling.milestones[].percent`	number
`progressBilling.milestones[].amountCents`	integer
`progressBilling.milestones[].invoiceId`	string or null
`progressBilling.milestones[].invoiceIdentifier`	string or null
`progressBilling.invoices`	array of object
`progressBilling.invoices[].id`	string
`progressBilling.invoices[].identifier`	string
`progressBilling.invoices[].status`	enum	One of `DRAFT`, `SENT`, `PAID`, `OVERDUE`, `CANCELLED`.
`progressBilling.invoices[].role`	enum or null	One of `PROGRESS`, `FINAL`, `RETAINAGE_RELEASE`.
`progressBilling.invoices[].milestoneId`	string or null
`progressBilling.invoices[].billedCents`	integer
`progressBilling.invoices[].retainageCents`	integer	Held (positive) or released (negative).
`progressBilling.invoices[].totalCents`	integer
`progressBilling.invoices[].amountPaidCents`	integer
`progressBilling.invoices[].balanceDueCents`	integer
`progressBilling.invoices[].dueDate`	string or null
`progressBilling.invoices[].createdAt`	string (date-time)
`progressBilling.summary`	object
`progressBilling.summary.contractCents`	integer
`progressBilling.summary.billedCents`	integer	Contract work billed to date, before retainage and tax.
`progressBilling.summary.remainingCents`	integer
`progressBilling.summary.percentBilled`	number
`progressBilling.summary.retainageHeldCents`	integer
`progressBilling.summary.retainageReleasedCents`	integer
`progressBilling.summary.retainageOutstandingCents`	integer
`progressBilling.summary.invoicedTotalCents`	integer	Invoice totals (after retainage, with tax).
`progressBilling.summary.paidCents`	integer
`progressBilling.summary.hasFinal`	boolean
`progressBilling.summary.complete`	boolean
`progressBilling.summary.finalProblem`	string or null	Why a final invoice cannot be made now, or null.
`progressBilling.summary.releaseProblem`	string or null	Why the retainage cannot be released now, or null.

Get or create the invoice's customer link

POST /organizations/{organizationId}/invoices/{invoiceId}/link

Exposes to the customer: returns the token for /i/{token}, the customer's page for this one invoice (no sign-in; anyone with the link can read it). Made on first call and then reused, so calling it again is safe. Drafts and cancelled invoices are not shown on that page until issued. Nothing is emailed.

Permission: invoices.send (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk sensitive (OAuth scope servflo.sensitive).


Permission	`invoices.send`
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`invoiceLinks_ensure` (toolset `invoices`)
Approval	Over MCP, this tool asks for your OK first (in the AI app when it supports it, otherwise in ServFlo). See Approvals.

Parameters

Name	In	Type	Required	Description
`invoiceId`	path	string	Yes

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices/{invoiceId}/link" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`token`	string	Open the invoice at /i/{token} on the web app.
`createdAt`	string (date-time)

Replace the invoice's customer link

POST /organizations/{organizationId}/invoices/{invoiceId}/link/regenerate

Destructive: issues a new token; the previous /i/{token} link stops working at once.

Permission: invoices.send (Owner, Admin, Dispatcher, Technician (own jobs' invoices)); risk sensitive (OAuth scope servflo.sensitive).


Permission	`invoices.send`
Risk	`sensitive`, OAuth scope `servflo.sensitive`. Sensitive: moves money, deletes, sends or shows something to a customer, or grants or revokes access.
MCP tool	`invoiceLinks_regenerate` (toolset `invoices`)
Approval	Over MCP, this tool asks for your OK first (in the AI app when it supports it, otherwise in ServFlo). See Approvals.

Parameters

Name	In	Type	Required	Description
`invoiceId`	path	string	Yes

Example

curl -X POST "https://app.servflo.ai/api/organizations/$ORGANIZATION_ID/invoices/{invoiceId}/link/regenerate" \
  -H "Authorization: Bearer $SERVFLO_API_KEY"

Response

200: the answer's fields

Field	Type	Description
`token`	string	Open the invoice at /i/{token} on the web app.
`createdAt`	string (date-time)

On this page