> ## Documentation Index > Fetch the complete documentation index at: https://docs.salesbricks.com/llms.txt > Use this file to discover all available pages before exploring further. # Regenerate an invoice > Recalculates the invoice from the current order and subscription data, regenerates the stored PDF, and creates a new invoice version. Use this after upstream changes (for example order or billing updates) that should be reflected on an already-generated invoice. The existing stored PDF is replaced, and it may have already been sent to the customer. By default the regeneration is silent; pass `send_invoice: true` to also email the regenerated invoice to the buyer's invoice recipients (reissue). Voided invoices and invoices that have not been generated yet cannot be regenerated. The request blocks until the new PDF is stored, so a `200` means the regeneration is complete and any requested email has been sent. ## OpenAPI ````yaml https://api.salesbricks.com/api/v2/openapi.yaml post /invoices/{invoice_id}/regenerate openapi: 3.0.3 info: title: Salesbricks REST API version: 2.0.0 description: API reference for external integrations servers: - url: https://api.salesbricks.com/api/v2 description: Production - url: https://api.staging.salesbricks.com/api/v2 description: Staging security: - ApiKeyAuth: [] tags: - name: Subscriptions description: >- Operations related to subscription management, including creation, updates, and retrieving subscription details. Subscriptions can be upgraded to add / remove add-ons by using the POST /subscriptions/{subscription_id}/upgrade endpoint and can be recasted for replacing the current agreement using the POST /subscriptions/{subscription_id}/recast endpoint - name: Customers description: >- Operations related to customer management, including creation, updates, and managing customer person objects. - name: Invoices description: Operations related to subscription's invoicing details. - name: Plans description: >- Operations related to listing and getting plan details including bricks in the plan. - name: Payment Methods description: Operations related to subscription's payment method. paths: /invoices/{invoice_id}/regenerate: post: tags: - Invoices summary: Regenerate an invoice description: >- Recalculates the invoice from the current order and subscription data, regenerates the stored PDF, and creates a new invoice version. Use this after upstream changes (for example order or billing updates) that should be reflected on an already-generated invoice. The existing stored PDF is replaced, and it may have already been sent to the customer. By default the regeneration is silent; pass `send_invoice: true` to also email the regenerated invoice to the buyer's invoice recipients (reissue). Voided invoices and invoices that have not been generated yet cannot be regenerated. The request blocks until the new PDF is stored, so a `200` means the regeneration is complete and any requested email has been sent. operationId: regenerateInvoice parameters: - in: path name: invoice_id schema: type: string pattern: ^([a-zA-Z\d\-]+)$ required: true requestBody: content: application/json: schema: $ref: '#/components/schemas/RegenerateInvoiceRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/RegenerateInvoiceRequest' multipart/form-data: schema: $ref: '#/components/schemas/RegenerateInvoiceRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: NotFoundResponse: value: error: code: ERR_NOT_FOUND message: >- Not found — the resource you are looking for does not exist. summary: Not Found Response description: '' '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: '' '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: '' components: schemas: RegenerateInvoiceRequest: type: object properties: send_invoice: type: boolean default: false description: >- If true, emails the regenerated invoice to the buyer's invoice recipients (reissue). Defaults to false: the invoice is regenerated silently and no emails are sent. Invoice: type: object properties: invoice_id: type: string format: uuid description: >- Unique identifier for the invoice. If the id is null, this is an estimate subscription_id: type: string format: uuid description: >- ID of the subscription this invoice belongs to. Null for standalone (one-off) invoices. customer_id: type: string format: uuid description: ID of the customer who will pay this invoice customer_name: type: string description: Name of the customer who will pay this invoice invoice_number: type: string description: >- Short form identifier for the invoice. If the invoice_number is null, this is an estimate time_zone: type: string description: Invoice timezone due_at: type: string format: date-time description: The date on which this invoice is expected to be paid by. bill_at: type: string format: date-time description: >- The date on which this invoice will be issued and potentially charged. issued_at: type: string format: date-time description: The date on which this invoice was issued. status: type: string description: > Current status of the invoice. One of: - `MUTED` — Invoice will not be sent. Muted invoices come from migration cut-overs or from muting invoices in the product settings. - `SCHEDULED` — Scheduled to be issued on a future date. - `OUTSTANDING` — Issued and awaiting payment. - `DUE` — Payment is due. - `PAST_DUE` — Payment is past its due date. - `PAID` — Fully paid. - `PARTIALLY_PAID` — Partially paid, with a remaining balance. - `ADJUSTED` — Adjusted after issuance. - `CREDITED` — Settled by applying credit. - `UNPAID` — Unpaid. - `PAUSED` — Collection is paused. - `VOIDED` — Voided and no longer collectible. fully_paid_at: type: string format: date-time description: The date on which this invoice was fully paid. grand_total: type: integer description: >- Total amount due for this invoice. Invoices that have not been generated yet (e.g. `SCHEDULED`) report the total expected at the time they were created. That figure does NOT include usage metered since — a usage invoice whose meters have not been priced reports 0. Pass `?calculate_expected_usage=true` to re-price against the order and include estimated usage instead; it is slower, so it is off by default on list endpoints. remaining_amount: type: integer description: Remaining amount for this invoice. currency: type: string description: The currency in which the invoice is denominated (e.g., USD, EUR). is_renewal_estimate: type: boolean description: >- This is an estimate for a renewal that has not yet closed, but is expected to. payments: type: array items: $ref: '#/components/schemas/Payment' description: All payments made against this invoice, newest first. attachments: type: array items: {} description: >- Current attachments for this invoice as a flat array. Each item includes 'target' field indicating invoice or subscription level. Sorted by unified order. line_items: type: array items: $ref: '#/components/schemas/InvoiceLineItemOutput' description: Line item breakdown for this invoice metadata: description: Optional metadata stored against the invoice. required: - bill_at - currency - customer_id - due_at - fully_paid_at - grand_total - invoice_id - invoice_number - is_renewal_estimate - issued_at - remaining_amount - status - subscription_id ErrorResponse: type: object description: >- Standardizes API error responses with a consistent structure containing error code and message. properties: error: $ref: '#/components/schemas/Error' required: - error Payment: type: object properties: payment_id: type: string format: uuid readOnly: true description: Unique identifier for the payment invoice_number: type: string nullable: true readOnly: true description: >- The invoice number this payment was made against, snapshotted from the invoice version current when the payment was recorded — it does not change when the invoice is later regenerated, so it may differ from the invoice's top-level `invoice_number`. Falls back to the invoice's current number when no version is linked. Join payments to invoices by ID, not by number. invoice_version_id: type: string format: uuid readOnly: true nullable: true description: >- Identifier of the invoice version this payment was made against — the version current when the payment was recorded. Null only when the invoice has no versions (it was never generated). paid_amount: type: integer readOnly: true nullable: true description: The amount paid paid_at: type: string format: date-time readOnly: true nullable: true description: the date at which this payment was paid currency: type: string readOnly: true description: The currency in which the payment is denominated (e.g., USD, EUR) error: type: string readOnly: true nullable: true description: Any errors that occured during this payment processing required: - currency - error - invoice_number - invoice_version_id - paid_amount - paid_at - payment_id InvoiceLineItemOutput: type: object properties: brick_name: type: string description: Name of the brick brick_id: type: string nullable: true description: Unique identifier of the brick quantity: type: integer description: Quantity of units tax: type: integer description: Tax amount in minor currency units grand_total: type: integer description: Grand total in minor currency units starts_at: type: string format: date-time nullable: true description: Start of the period this line item covers ends_at: type: string format: date-time nullable: true description: End of the period this line item covers required: - brick_id - brick_name - ends_at - grand_total - quantity - starts_at - tax Error: type: object description: >- Represents individual error details with a standardized code and descriptive message. properties: code: enum: - ERR_NOT_FOUND - ERR_BAD_REQUEST - ERR_SERVER_ERROR type: string x-spec-enum-id: dc5a5d6feae1b697 description: >- Error code indicating the type of error: NOT_FOUND for missing resources, BAD_REQUEST for invalid input, SERVER_ERROR for internal server issues * `ERR_NOT_FOUND` - ERR_NOT_FOUND * `ERR_BAD_REQUEST` - ERR_BAD_REQUEST * `ERR_SERVER_ERROR` - ERR_SERVER_ERROR message: type: string error_id: type: string format: uuid description: >- Correlation handle for SERVER_ERROR responses — quote this when contacting support; it joins to the structured server log line for the failure. Not present on 4xx responses. required: - code - message securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-SALESBRICKS-KEY description: API key for authentication ```` ## Related topics - [One-Off Invoices](/documentation/one-off-invoices.md) - [Retrieve an invoice](/api-reference/invoices/retrieve-an-invoice.md) - [invoice.start](/api-reference/webhooks/invoice/start.md)