tags:
  - name: login
    description: |
      Attempts to authenticate with the API using a email/password combination.
    externalDocs:
      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: |

      ## 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.
  - name: payments
    description: |
      Endpoint definitions for interacting with payments.
  - name: quotes
    description: |
      Endpoint definitions for interacting with quotes.
  - name: credits
    description: |
      Endpoint definitions for interacting with credits.
  - name: projects
    description: |
      Endpoint definitions for interacting with projects.
  - name: tasks
    description: |
      Endpoint definitions for interacting with tasks.
  - name: vendors
    description: |
      Endpoint definitions for interacting with vendors.
  - name: Purchase Orders
    description: |
      Endpoint definitions for interacting with purchase orders.
  - name: expenses
    description: |
      Endpoint definitions for interacting with expenses.
  - name: recurring_expenses
    description: |
      Endpoint definitions for interacting with recurring_expenses.
  - name: bank_transactions
    description: |
      Endpoint definitions for interacting with bank transactions.
  - name: reports
    description: |
      Endpoint definitions for interacting with reports.
externalDocs:
  description: "https://invoiceninja.github.io"
  url: "https://invoiceninja.github.io"
security:
  - ApiKeyAuth: []