Mark Invoice Paid

PUT /api/v1/invoices/{invoice_id}/paid

Mark an invoice as paid.

Operation ID: mark_invoice_paid_api_v1_invoices__invoice_id__paid_put · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

invoice_id string · uuid required

Responses

200 Successful Response

Schema: InvoiceResponse

id string required

Invoice UUID.

business_id string required

Business UUID.

created_at string · date-time required

Creation timestamp.

updated_at string · date-time required

Last update timestamp.

status string required

Status: draft, open, partially_paid, manual_paid, stripe_paid, void.

currency string

Currency for the invoice (USD, CAD, AUD, EUR, or GBP).

stripe_invoice_id string

Stripe invoice ID if synced.

total integer

Total amount in cents.

total_paid integer

Running total of payments received in cents.

balance_due integer

Remaining balance in cents (total - total_paid).

description string

Invoice description/notes.

customer_id string required

Customer UUID.

customer_name string

Customer name (resolved).

customer_email string

Customer email (resolved).

due_date string

Due date (YYYY-MM-DD).

line_items array · LineItemResponse

Invoice line items.

pdf_url string

URL to download invoice PDF.

number string

Invoice number (assigned on finalize).

delivered boolean

Whether invoice was delivered.

delivered_on string · date-time

Delivery timestamp.

hosted_invoice_url string

URL for customer payment portal.

paid_on string · date-time

Payment timestamp.

journal_entries array · object

Associated accounting journal entries.

payments array · InvoicePaymentResponse

Payment records linking bank transactions to this invoice.

recurring_template_id string

ID of recurring template if invoice was generated from one, or if one was created.

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object