Add in invoice statuses

invoiceninja · Sep 9, 2024 · d0683c9 · d0683c9
1 parent 626a785
commit d0683c9
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 3 deletions.
diff --git a/api-docs.yaml b/api-docs.yaml
@@ -21989,14 +21989,51 @@ tags:
       description: "Find out more"
       url: "https://invoiceninja.github.io"
   - name: clients
+    x-tag-expanded: true
     description: |
       Endpoint definitions for interacting with clients.
   - name: products
     description: |
       Endpoint definitions for interacting with products.
   - name: invoices
     description: |
-      Endpoint definitions for interacting with invoices.
+
+      ## Invoice Statuses
+      <ul>
+        <li>
+          <p>STATUS_DRAFT = 1</p>
+          <p>Draft invoices are not visible in the client portal, are not active and they do not impact the client balance</p>
+        </li>
+        <li>
+          <p>STATUS_SENT = 2</p>
+          <p>Send invoices are visible in the client portal, are active and impact the client balance</p>
+        </li>
+        <li>
+          <p>STATUS_PARTIAL = 3</p>
+          <p>An invoice which has been partially paid</p>
+        </li>
+        <li>
+          <p>STATUS_PAID = 4</p>
+          <p>An invoice which has been fully paid</p>
+        </li>
+        <li>
+          <p>STATUS_CANCELLED = 5</p>
+          <p>When a invoice is cancelled the invoice balance is set to zero and the status updated to Cancelled, the client balance is also adjusted down. If payments have been applied to the invoice these will remain linked to the invoice.</p>
+        </li>
+        <li>
+          <p>STATUS_REVERSED = 6</p>
+          <p>When a invoice has been reversed, the previous payments relationships are unlinked and cannot be restored.</p>
+        </li>
+        <li>
+          <p>STATUS_OVERDUE = -1</p>
+          <p>An invoice which is still payable past its due date</p>
+        </li>
+        <li>
+          <p>STATUS_UNPAID = -2</p>
+          <p>An invoice which is not yet due, but also, not paid.</p>
+        </li>
+      </ul>
+
   - name: Recurring Invoices
     description: |
       Endpoint definitions for interacting with recurring_invoices.

diff --git a/index.html b/index.html
@@ -65,7 +65,8 @@
     <rapi-doc 
     id="thedoc" 
     spec-url="api-docs.yaml" 
-    render-style="focused" 
+    render-style="read" 
+    on-nav-tag-click="show-description" 
     load-fonts="true" 
     show-header="false"
     theme="darkbluenav" 
@@ -79,7 +80,6 @@
     nav-bg-color="#3f4d67"
     nav-item-spacing="default" 
     nav-active-item-marker="left-bar" 
-    on-nav-tag-click="expand-collapse" 
     show-info="true"
     info-description-headings-in-navbar="true" 
     show-curl-before-try="false"