mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-06-23 20:00:33 -04:00
78 lines
2.8 KiB
YAML
78 lines
2.8 KiB
YAML
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
|
|
|
|
- STATUS_DRAFT = 1
|
|
- Draft invoices are not visible in the client portal, are not active and they do not impact the client balance
|
|
- STATUS_SENT = 2
|
|
- Send invoices are visible in the client portal, are active and impact the client balance
|
|
- STATUS_PARTIAL = 3
|
|
- An invoice which has been partially paid
|
|
- STATUS_PAID = 4
|
|
- An invoice which has been fully paid
|
|
- STATUS_CANCELLED = 5
|
|
- 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
|
|
- STATUS_REVERSED = 6
|
|
- When a invoice has been reversed, the previous payments relationships are unlinked and cannot be restored
|
|
- STATUS_OVERDUE = -1
|
|
- An invoice which is still payable past its due date
|
|
- STATUS_UNPAID = -2
|
|
- An invoice which is not yet due, but also, not paid
|
|
|
|
- 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: []
|