> ## Documentation Index
> Fetch the complete documentation index at: https://help.gorelo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Deletes or voids an invoice, depending on its current status.

> Mirrors the app's own delete/void action on the invoice list - one endpoint, the outcome
depends on the invoice's current status:
<list type="table"><item><term>Draft</term><description>Deleted - the response's `StatusId` is 6
(Deleted), and the invoice is gone from `GET /v1/invoices` entirely.</description></item><item><term>Approved</term><description>Voided instead - the response's `StatusId` is
4 (Void), and the invoice stays visible on `GET /v1/invoices`.</description></item><item><term>Any other status</term><description>Refused with 409 - only a Draft or
Approved invoice can be removed this way.</description></item></list>

A delete or void also sends the status change to the connected accounting system, as the
app's own delete/void does.


Deleting an invoice that's already deleted, or already void, is treated as success. An
invoice that doesn't exist, or belongs to another service provider, is a 404 - the two are
never distinguished.




## OpenAPI

````yaml /api-reference/openapi.json delete /v1/invoices/{invoiceId}
openapi: 3.0.4
info:
  title: Public API
  description: Gorelo Public API documentation.
  version: 1.0.0
servers:
  - url: https://api.usw.gorelo.io
    description: US
  - url: https://api.aue.gorelo.io
    description: Australia
security:
  - ApiKeyAuth: []
tags:
  - name: Attachments
    description: "Uploading a file, for anything that can carry one. One endpoint rather than one per record\r\ntype, because the upload itself is identical - only the record it is checked against differs."
  - name: Alerts
    description: Alerts management operations
  - name: Assets
    description: Assets management operations
  - name: Billing
    description: Billing management operations
  - name: Tickets
    description: Tickets management operations
  - name: Clients
    description: Clients management operations
  - name: Contacts
    description: Contacts management operations
  - name: Deletions
    description: Deletions management operations
  - name: Documents
    description: Documents management operations
  - name: Forms
    description: Forms management operations
  - name: Organization
    description: Organization management operations
  - name: Projects
    description: Projects management operations
paths:
  /v1/invoices/{invoiceId}:
    delete:
      tags:
        - Billing
      summary: Deletes or voids an invoice, depending on its current status.
      description: "Mirrors the app's own delete/void action on the invoice list - one endpoint, the outcome\r\ndepends on the invoice's current status:\r\n<list type=\"table\"><item><term>Draft</term><description>Deleted - the response's `StatusId` is 6\r\n(Deleted), and the invoice is gone from `GET /v1/invoices` entirely.</description></item><item><term>Approved</term><description>Voided instead - the response's `StatusId` is\r\n4 (Void), and the invoice stays visible on `GET /v1/invoices`.</description></item><item><term>Any other status</term><description>Refused with 409 - only a Draft or\r\nApproved invoice can be removed this way.</description></item></list>\n\r\nA delete or void also sends the status change to the connected accounting system, as the\r\napp's own delete/void does.\r\n\n\r\nDeleting an invoice that's already deleted, or already void, is treated as success. An\r\ninvoice that doesn't exist, or belongs to another service provider, is a 404 - the two are\r\nnever distinguished.\r\n"
      operationId: delete_v1_invoices_invoiceId
      parameters:
        - name: invoiceId
          in: path
          description: Invoice identifier.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/DeleteInvoiceResultBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteInvoiceResultBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/DeleteInvoiceResultBaseResponse'
        '401':
          description: Unauthorized
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '404':
          description: Not Found
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '409':
          description: Conflict
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ObjectBaseResponse'
components:
  schemas:
    DeleteInvoiceResultBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          $ref: '#/components/schemas/DeleteInvoiceResult'
        DataContext:
          type: object
          additionalProperties: false
          nullable: true
          example: null
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    ObjectBaseResponse:
      type: object
      properties:
        StatusCode:
          $ref: '#/components/schemas/HttpStatusCode'
        IsSuccess:
          type: boolean
        Data:
          nullable: true
        DataContext:
          $ref: '#/components/schemas/ErrorDataContext'
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      additionalProperties: false
    HttpStatusCode:
      enum:
        - 100
        - 101
        - 102
        - 103
        - 200
        - 201
        - 202
        - 203
        - 204
        - 205
        - 206
        - 207
        - 208
        - 226
        - 300
        - 301
        - 302
        - 303
        - 304
        - 305
        - 306
        - 307
        - 308
        - 400
        - 401
        - 402
        - 403
        - 404
        - 405
        - 406
        - 407
        - 408
        - 409
        - 410
        - 411
        - 412
        - 413
        - 414
        - 415
        - 416
        - 417
        - 421
        - 422
        - 423
        - 424
        - 426
        - 428
        - 429
        - 431
        - 451
        - 500
        - 501
        - 502
        - 503
        - 504
        - 505
        - 506
        - 507
        - 508
        - 510
        - 511
      type: integer
      format: int32
    DeleteInvoiceResult:
      type: object
      properties:
        Id:
          type: string
          description: Identifier of the invoice.
          format: uuid
        StatusId:
          type: integer
          description: "The invoice's status after the call: 6 (Deleted) when a Draft invoice was deleted, or 4\r\n(Void) when an Approved invoice was voided. Deleted (6) appears only here - a deleted\r\ninvoice is never returned by `GET /v1/invoices`, so the list's status set stays 1-5."
          format: int32
      additionalProperties: false
      description: The outcome of deleting an invoice.
    Error:
      type: object
      properties:
        Code:
          pattern: ^[0-9]{6}$
          type: string
          description: 6-digit MMTTNN error code. See the Public API error-code registry.
          example: '070101'
        Message:
          type: string
        PropertyName:
          type: string
          nullable: true
        ActionHint:
          type: string
          nullable: true
        DocUrl:
          type: string
          nullable: true
      additionalProperties: false
    ErrorDataContext:
      type: object
      properties:
        TraceId:
          type: string
          description: Request correlation id. Quote this when reporting a problem.
          nullable: true
      additionalProperties: false
      description: "The `DataContext` of an error response: carries the correlation id for the failed\r\nrequest."
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      description: >-
        Your Gorelo API key. See [Generate API key](/generate-api-key). If your
        data is hosted in Australia, click the base URL at the top of this page
        and select `https://api.aue.gorelo.io`.
      name: X-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.