Sultan
/
invoiceninja
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated OpenApi spec

This commit is contained in:
David Bomba 2025-10-10 12:12:20 +11:00
parent 2e45fbe9d5
commit c4de17d71c
13 changed files with 730 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

365
openapi/api-docs.yaml
View File

@ -8640,10 +8640,28 @@ paths:
summary: "List credits" summary: "List credits"
description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available" description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available"
operationId: getCredits operationId: getCredits
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$credits = $ninja->credits->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/credits \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of credits" description: "A list of credits"
@ -8729,6 +8747,18 @@ paths:
summary: "Show credit" summary: "Show credit"
description: "Displays an credit by id" description: "Displays an credit by id"
operationId: showCredit operationId: showCredit
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$credit = $ninja->credits->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -8819,6 +8849,18 @@ paths:
summary: "Delete credit" summary: "Delete credit"
description: "Handles the deletion of an credit by id" description: "Handles the deletion of an credit by id"
operationId: deleteCredit operationId: deleteCredit
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->credits->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -9134,6 +9176,8 @@ paths:
- $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-API-TOKEN'
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'
- $ref: '#/components/parameters/index' - $ref: '#/components/parameters/index'
- $ref: '#/components/parameters/per_page_meta'
- $ref: '#/components/parameters/page_meta'
- name: name - name: name
in: query in: query
description: | description: |
@ -9626,6 +9670,9 @@ paths:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
- $ref: "#/components/parameters/updated_at" - $ref: "#/components/parameters/updated_at"
@ -9860,6 +9907,18 @@ paths:
summary: "Show recurring invoice" summary: "Show recurring invoice"
description: "Displays an RecurringInvoice by id" description: "Displays an RecurringInvoice by id"
operationId: showRecurringInvoice operationId: showRecurringInvoice
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$recurringInvoice = $ninja->recurringInvoices->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/recurring_invoices/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -10301,11 +10360,29 @@ paths:
summary: "List tasks" summary: "List tasks"
description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available"
operationId: getTasks operationId: getTasks
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$tasks = $ninja->tasks->all([
'per_page' => 10,
'page' => 1,
'client_id' => 'D2J234DFA'
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index" - $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of tasks" description: "A list of tasks"
@ -10421,6 +10498,18 @@ paths:
summary: "Show task" summary: "Show task"
description: "Displays a task by id" description: "Displays a task by id"
operationId: showTask operationId: showTask
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$task = $ninja->tasks->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -10540,6 +10629,18 @@ paths:
summary: "Delete task" summary: "Delete task"
description: "Handles the deletion of a task by id" description: "Handles the deletion of a task by id"
operationId: deleteTask operationId: deleteTask
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->tasks->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -10581,6 +10682,18 @@ paths:
summary: "Edit task" summary: "Edit task"
description: "Displays a task by id" description: "Displays a task by id"
operationId: editTask operationId: editTask
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$task = $ninja->tasks->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA/edit \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -10626,6 +10739,18 @@ paths:
summary: "Blank task" summary: "Blank task"
description: "Returns a blank task with default values" description: "Returns a blank task with default values"
operationId: getTasksCreate operationId: getTasksCreate
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$task = $ninja->tasks->model();
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks/create \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -10859,8 +10984,12 @@ paths:
--header 'Accept: application/json' --header 'Accept: application/json'
operationId: getQuotes operationId: getQuotes
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
@ -11708,6 +11837,9 @@ paths:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
@ -12725,11 +12857,28 @@ paths:
summary: "List projects" summary: "List projects"
description: "Lists projects" description: "Lists projects"
operationId: getProjects operationId: getProjects
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$projects = $ninja->projects->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index" - $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of projects" description: "A list of projects"
@ -12845,6 +12994,18 @@ paths:
summary: "Show project" summary: "Show project"
description: "Displays a project by id" description: "Displays a project by id"
operationId: showProject operationId: showProject
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$project = $ninja->projects->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -12964,6 +13125,18 @@ paths:
summary: "Delete project" summary: "Delete project"
description: "Handles the deletion of a project by id" description: "Handles the deletion of a project by id"
operationId: deleteProject operationId: deleteProject
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->projects->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13005,6 +13178,18 @@ paths:
summary: "Edit project" summary: "Edit project"
description: "Displays a project by id" description: "Displays a project by id"
operationId: editProject operationId: editProject
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$project = $ninja->projects->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA/edit \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13050,6 +13235,18 @@ paths:
summary: "Blank project" summary: "Blank project"
description: "Returns a blank object with default values" description: "Returns a blank object with default values"
operationId: getProjectsCreate operationId: getProjectsCreate
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$project = $ninja->projects->model();
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects/create \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13197,11 +13394,28 @@ paths:
summary: "List vendors" summary: "List vendors"
description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available"
operationId: getVendors operationId: getVendors
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendors = $ninja->vendors->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index" - $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of vendors" description: "A list of vendors"
@ -13341,6 +13555,18 @@ paths:
summary: "Show vendor" summary: "Show vendor"
description: "Displays a vendor by id" description: "Displays a vendor by id"
operationId: showVendor operationId: showVendor
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendor = $ninja->vendors->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13462,6 +13688,18 @@ paths:
summary: "Delete vendor" summary: "Delete vendor"
description: "Handles the deletion of a vendor by id" description: "Handles the deletion of a vendor by id"
operationId: deleteVendor operationId: deleteVendor
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->vendors->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13503,6 +13741,18 @@ paths:
summary: "Edit vendor" summary: "Edit vendor"
description: "Displays a vendor by id" description: "Displays a vendor by id"
operationId: editVendor operationId: editVendor
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendor = $ninja->vendors->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA/edit \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13548,6 +13798,18 @@ paths:
summary: "Blank vendor" summary: "Blank vendor"
description: "Returns a blank vendor with default values" description: "Returns a blank vendor with default values"
operationId: getVendorsCreate operationId: getVendorsCreate
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendor = $ninja->vendors->model();
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors/create \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13695,10 +13957,28 @@ paths:
summary: "List payments" summary: "List payments"
description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available"
operationId: getPayments operationId: getPayments
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$payments = $ninja->payments->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/payments \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
@ -13846,6 +14126,18 @@ paths:
summary: "Show payment" summary: "Show payment"
description: "Displays an Payment by id" description: "Displays an Payment by id"
operationId: showPayment operationId: showPayment
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$payment = $ninja->payments->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -13934,6 +14226,18 @@ paths:
summary: "Delete payment" summary: "Delete payment"
description: "Handles the deletion of an Payment by id" description: "Handles the deletion of an Payment by id"
operationId: deletePayment operationId: deletePayment
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->payments->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -14323,6 +14627,8 @@ paths:
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'
- $ref: '#/components/parameters/client_include' - $ref: '#/components/parameters/client_include'
- $ref: '#/components/parameters/index' - $ref: '#/components/parameters/index'
- $ref: '#/components/parameters/per_page_meta'
- $ref: '#/components/parameters/page_meta'
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
- $ref: "#/components/parameters/updated_at" - $ref: "#/components/parameters/updated_at"
@ -15349,6 +15655,18 @@ paths:
Emails are suppressed by PostMark, when they receive a Hard bounce / Spam Complaint. This endpoint allows you to remove the suppression and send emails to the user again. Emails are suppressed by PostMark, when they receive a Hard bounce / Spam Complaint. This endpoint allows you to remove the suppression and send emails to the user again.
operationId: reactivateEmail operationId: reactivateEmail
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->clients->reactivateEmail("bounce_id_123");
- lang: curl
label: curl
source: |
curl -X POST https://demo.invoiceninja.com/api/v1/reactivate_email/bounce_id_123 \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-API-TOKEN'
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'
@ -15397,6 +15715,32 @@ paths:
Updates the clients tax data - if their address has changed Updates the clients tax data - if their address has changed
operationId: updateClientTaxData operationId: updateClientTaxData
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->clients->updateTaxData("D2J234DFA", [
'address1' => '123 New Street',
'city' => 'New York',
'state' => 'NY',
'postal_code' => '10001',
'country_id' => '1'
]);
- lang: curl
label: curl
source: |
curl -X POST https://demo.invoiceninja.com/api/v1/clients/D2J234DFA/updateTaxData \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "Content-Type: application/json" \
-H "X-Requested-With: XMLHttpRequest" \
-d '{
"address1": "123 New Street",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_id": "1"
}'
parameters: parameters:
- $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-API-TOKEN'
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'
@ -15441,10 +15785,28 @@ paths:
summary: "List purchase orders" summary: "List purchase orders"
description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available"
operationId: getPurchaseOrders operationId: getPurchaseOrders
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$purchaseOrders = $ninja->purchaseOrders->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/purchase_orders \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of purchase orders" description: "A list of purchase orders"
@ -16053,6 +16415,9 @@ paths:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"

40
openapi/paths/clients.yaml
View File

@ -62,6 +62,8 @@
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'
- $ref: '#/components/parameters/client_include' - $ref: '#/components/parameters/client_include'
- $ref: '#/components/parameters/index' - $ref: '#/components/parameters/index'
- $ref: '#/components/parameters/per_page_meta'
- $ref: '#/components/parameters/page_meta'
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
- $ref: "#/components/parameters/updated_at" - $ref: "#/components/parameters/updated_at"
@ -1088,6 +1090,18 @@
Emails are suppressed by PostMark, when they receive a Hard bounce / Spam Complaint. This endpoint allows you to remove the suppression and send emails to the user again. Emails are suppressed by PostMark, when they receive a Hard bounce / Spam Complaint. This endpoint allows you to remove the suppression and send emails to the user again.
operationId: reactivateEmail operationId: reactivateEmail
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->clients->reactivateEmail("bounce_id_123");
- lang: curl
label: curl
source: |
curl -X POST https://demo.invoiceninja.com/api/v1/reactivate_email/bounce_id_123 \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-API-TOKEN'
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'
@ -1136,6 +1150,32 @@
Updates the clients tax data - if their address has changed Updates the clients tax data - if their address has changed
operationId: updateClientTaxData operationId: updateClientTaxData
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->clients->updateTaxData("D2J234DFA", [
'address1' => '123 New Street',
'city' => 'New York',
'state' => 'NY',
'postal_code' => '10001',
'country_id' => '1'
]);
- lang: curl
label: curl
source: |
curl -X POST https://demo.invoiceninja.com/api/v1/clients/D2J234DFA/updateTaxData \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "Content-Type: application/json" \
-H "X-Requested-With: XMLHttpRequest" \
-d '{
"address1": "123 New Street",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country_id": "1"
}'
parameters: parameters:
- $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-API-TOKEN'
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'

42
openapi/paths/credits.yaml
View File

@ -5,10 +5,28 @@
summary: "List credits" summary: "List credits"
description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available" description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available"
operationId: getCredits operationId: getCredits
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$credits = $ninja->credits->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/credits \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of credits" description: "A list of credits"
@ -94,6 +112,18 @@
summary: "Show credit" summary: "Show credit"
description: "Displays an credit by id" description: "Displays an credit by id"
operationId: showCredit operationId: showCredit
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$credit = $ninja->credits->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -184,6 +214,18 @@
summary: "Delete credit" summary: "Delete credit"
description: "Handles the deletion of an credit by id" description: "Handles the deletion of an credit by id"
operationId: deleteCredit operationId: deleteCredit
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->credits->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/credits/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"

3
openapi/paths/invoices.yaml
View File

@ -30,6 +30,9 @@
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"

2
openapi/paths/locations.yaml
View File

@ -45,6 +45,8 @@
- $ref: '#/components/parameters/X-API-TOKEN' - $ref: '#/components/parameters/X-API-TOKEN'
- $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/X-Requested-With'
- $ref: '#/components/parameters/index' - $ref: '#/components/parameters/index'
- $ref: '#/components/parameters/per_page_meta'
- $ref: '#/components/parameters/page_meta'
- name: name - name: name
in: query in: query
description: | description: |

42
openapi/paths/payments.yaml
View File

@ -5,10 +5,28 @@
summary: "List payments" summary: "List payments"
description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available"
operationId: getPayments operationId: getPayments
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$payments = $ninja->payments->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/payments \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
@ -156,6 +174,18 @@
summary: "Show payment" summary: "Show payment"
description: "Displays an Payment by id" description: "Displays an Payment by id"
operationId: showPayment operationId: showPayment
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$payment = $ninja->payments->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -244,6 +274,18 @@
summary: "Delete payment" summary: "Delete payment"
description: "Handles the deletion of an Payment by id" description: "Handles the deletion of an Payment by id"
operationId: deletePayment operationId: deletePayment
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->payments->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/payments/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"

3
openapi/paths/products.yaml
View File

@ -32,6 +32,9 @@
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"

65
openapi/paths/projects.yaml
View File

@ -5,11 +5,28 @@
summary: "List projects" summary: "List projects"
description: "Lists projects" description: "Lists projects"
operationId: getProjects operationId: getProjects
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$projects = $ninja->projects->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index" - $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of projects" description: "A list of projects"
@ -125,6 +142,18 @@
summary: "Show project" summary: "Show project"
description: "Displays a project by id" description: "Displays a project by id"
operationId: showProject operationId: showProject
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$project = $ninja->projects->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -244,6 +273,18 @@
summary: "Delete project" summary: "Delete project"
description: "Handles the deletion of a project by id" description: "Handles the deletion of a project by id"
operationId: deleteProject operationId: deleteProject
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->projects->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/projects/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -285,6 +326,18 @@
summary: "Edit project" summary: "Edit project"
description: "Displays a project by id" description: "Displays a project by id"
operationId: editProject operationId: editProject
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$project = $ninja->projects->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects/D2J234DFA/edit \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -330,6 +383,18 @@
summary: "Blank project" summary: "Blank project"
description: "Returns a blank object with default values" description: "Returns a blank object with default values"
operationId: getProjectsCreate operationId: getProjectsCreate
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$project = $ninja->projects->model();
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/projects/create \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"

18
openapi/paths/purchase_orders.yaml
View File

@ -5,10 +5,28 @@
summary: "List purchase orders" summary: "List purchase orders"
description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available"
operationId: getPurchaseOrders operationId: getPurchaseOrders
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$purchaseOrders = $ninja->purchaseOrders->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/purchase_orders \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of purchase orders" description: "A list of purchase orders"

4
openapi/paths/quotes.yaml
View File

@ -29,8 +29,12 @@
--header 'Accept: application/json' --header 'Accept: application/json'
operationId: getQuotes operationId: getQuotes
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/status" - $ref: "#/components/parameters/status"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"

15
openapi/paths/recurring_invoices.yaml
View File

@ -29,6 +29,9 @@
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
- $ref: "#/components/parameters/client_id" - $ref: "#/components/parameters/client_id"
- $ref: "#/components/parameters/created_at" - $ref: "#/components/parameters/created_at"
- $ref: "#/components/parameters/updated_at" - $ref: "#/components/parameters/updated_at"
@ -263,6 +266,18 @@
summary: "Show recurring invoice" summary: "Show recurring invoice"
description: "Displays an RecurringInvoice by id" description: "Displays an RecurringInvoice by id"
operationId: showRecurringInvoice operationId: showRecurringInvoice
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$recurringInvoice = $ninja->recurringInvoices->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/recurring_invoices/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"

66
openapi/paths/tasks.yaml
View File

@ -5,11 +5,29 @@
summary: "List tasks" summary: "List tasks"
description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available"
operationId: getTasks operationId: getTasks
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$tasks = $ninja->tasks->all([
'per_page' => 10,
'page' => 1,
'client_id' => 'D2J234DFA'
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index" - $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of tasks" description: "A list of tasks"
@ -125,6 +143,18 @@
summary: "Show task" summary: "Show task"
description: "Displays a task by id" description: "Displays a task by id"
operationId: showTask operationId: showTask
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$task = $ninja->tasks->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -244,6 +274,18 @@
summary: "Delete task" summary: "Delete task"
description: "Handles the deletion of a task by id" description: "Handles the deletion of a task by id"
operationId: deleteTask operationId: deleteTask
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->tasks->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -285,6 +327,18 @@
summary: "Edit task" summary: "Edit task"
description: "Displays a task by id" description: "Displays a task by id"
operationId: editTask operationId: editTask
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$task = $ninja->tasks->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks/D2J234DFA/edit \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -330,6 +384,18 @@
summary: "Blank task" summary: "Blank task"
description: "Returns a blank task with default values" description: "Returns a blank task with default values"
operationId: getTasksCreate operationId: getTasksCreate
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$task = $ninja->tasks->model();
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/tasks/create \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"

65
openapi/paths/vendors.yaml
View File

@ -5,11 +5,28 @@
summary: "List vendors" summary: "List vendors"
description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available"
operationId: getVendors operationId: getVendors
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendors = $ninja->vendors->all([
'per_page' => 10,
'page' => 1
]);
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include" - $ref: "#/components/parameters/include"
- $ref: "#/components/parameters/index" - $ref: "#/components/parameters/index"
- $ref: "#/components/parameters/per_page_meta"
- $ref: "#/components/parameters/page_meta"
responses: responses:
200: 200:
description: "A list of vendors" description: "A list of vendors"
@ -149,6 +166,18 @@
summary: "Show vendor" summary: "Show vendor"
description: "Displays a vendor by id" description: "Displays a vendor by id"
operationId: showVendor operationId: showVendor
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendor = $ninja->vendors->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -270,6 +299,18 @@
summary: "Delete vendor" summary: "Delete vendor"
description: "Handles the deletion of a vendor by id" description: "Handles the deletion of a vendor by id"
operationId: deleteVendor operationId: deleteVendor
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$ninja->vendors->delete("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X DELETE https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -311,6 +352,18 @@
summary: "Edit vendor" summary: "Edit vendor"
description: "Displays a vendor by id" description: "Displays a vendor by id"
operationId: editVendor operationId: editVendor
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendor = $ninja->vendors->show("D2J234DFA");
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors/D2J234DFA/edit \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"
@ -356,6 +409,18 @@
summary: "Blank vendor" summary: "Blank vendor"
description: "Returns a blank vendor with default values" description: "Returns a blank vendor with default values"
operationId: getVendorsCreate operationId: getVendorsCreate
x-codeSamples:
- lang: php
label: php
source: |
$ninja = new InvoiceNinja("YOUR-TOKEN");
$vendor = $ninja->vendors->model();
- lang: curl
label: curl
source: |
curl -X GET https://demo.invoiceninja.com/api/v1/vendors/create \
-H "X-API-TOKEN: YOUR-TOKEN" \
-H "X-Requested-With: XMLHttpRequest"
parameters: parameters:
- $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/X-Requested-With"