diff --git a/app/Jobs/Company/CreateCompany.php b/app/Jobs/Company/CreateCompany.php
index 7189ba8e5e..9e1c52f199 100644
--- a/app/Jobs/Company/CreateCompany.php
+++ b/app/Jobs/Company/CreateCompany.php
@@ -84,6 +84,7 @@ class CreateCompany
'724' => $company = $this->spanishSetup($company),
'36' => $company = $this->australiaSetup($company),
'710' => $company = $this->southAfticaSetup($company),
+ '554' => $company = $this->newZealandSetup($company),
default => $company->save(),
};
@@ -131,6 +132,22 @@ class CreateCompany
}
+ private function newZealandSetup($company): Company
+ {
+
+ $company->enabled_tax_rates = 1;
+
+ $settings = $company->settings;
+ $settings->currency_id = '15';
+ $settings->timezone_id = '113';
+
+ $company->settings = $settings;
+
+ $company->save();
+
+ return $company;
+ }
+
private function spanishSetup(Company $company): Company
{
try {
diff --git a/app/Models/Company.php b/app/Models/Company.php
index 38f1292017..53130080e7 100644
--- a/app/Models/Company.php
+++ b/app/Models/Company.php
@@ -120,6 +120,8 @@ use Laracasts\Presenter\PresentableTrait;
* @property bool $inbound_mailbox_allow_unknown
* @property string|null $inbound_mailbox_whitelist
* @property string|null $inbound_mailbox_blacklist
+ * @property string|null $e_invoice_certificate_passphrase
+ * @property string|null $e_invoice_certificate
* @property int $deleted_at
* @property string|null $smtp_username
* @property string|null $smtp_password
diff --git a/app/Repositories/ExpenseRepository.php b/app/Repositories/ExpenseRepository.php
index 54feb00958..b42b2b3710 100644
--- a/app/Repositories/ExpenseRepository.php
+++ b/app/Repositories/ExpenseRepository.php
@@ -121,7 +121,8 @@ class ExpenseRepository extends BaseRepository
$exchange_rate = new CurrencyApi();
$expense->exchange_rate = $exchange_rate->exchangeRate($expense_currency, $company_currency, Carbon::parse($expense->date));
-
+ $expense->invoice_currency_id = $company_currency;
+
return $expense;
}
diff --git a/app/Services/Company/CompanyService.php b/app/Services/Company/CompanyService.php
index 7ad29590c9..d8464347b0 100644
--- a/app/Services/Company/CompanyService.php
+++ b/app/Services/Company/CompanyService.php
@@ -56,7 +56,10 @@ class CompanyService
case '724': // Spain
$taxes[] = ['name' => 'IVA', 'rate' => 21];
break;
-
+ case '554': // New Zealand
+ $taxes[] = ['name' => 'GST', 'rate' => 15];
+ break;
+
default:
return;
}
diff --git a/app/Utils/Traits/Pdf/PDF.php b/app/Utils/Traits/Pdf/PDF.php
index dd8d2dab6c..9a5a84ba56 100644
--- a/app/Utils/Traits/Pdf/PDF.php
+++ b/app/Utils/Traits/Pdf/PDF.php
@@ -19,7 +19,7 @@ class PDF extends FPDI
public function Footer()
{
- $this->SetXY(0, -6);
+ $this->SetXY(config('ninja.pdf_page_numbering_x_alignment'), config('ninja.pdf_page_numbering_y_alignment'));
$this->SetFont('Arial', 'I', 9);
diff --git a/config/ninja.php b/config/ninja.php
index fe305e1d42..4a7ea01279 100644
--- a/config/ninja.php
+++ b/config/ninja.php
@@ -255,4 +255,7 @@ return [
'storecove_api_key' => env('STORECOVE_API_KEY', false),
'qvalia_api_key' => env('QVALIA_API_KEY', false),
'qvalia_partner_number' => env('QVALIA_PARTNER_NUMBER', false),
+ 'pdf_page_numbering_x_alignment' => env('PDF_PAGE_NUMBER_X', 0),
+ 'pdf_page_numbering_y_alignment' => env('PDF_PAGE_NUMBER_Y', -6),
+
];
diff --git a/lang/fr_CA/texts.php b/lang/fr_CA/texts.php
index e3954c8b71..58c055f141 100644
--- a/lang/fr_CA/texts.php
+++ b/lang/fr_CA/texts.php
@@ -2361,7 +2361,7 @@ Lorsque les montant apparaîtront sur votre relevé, veuillez revenir sur cette
'currency_gold_troy_ounce' => 'Once troy d\'or',
'currency_nicaraguan_córdoba' => 'Cordoba nicaraguayen',
'currency_malagasy_ariary' => 'Ariary malgache',
- "currency_tongan_paanga" => "Pa'anga tongien",
+ "currency_tongan_pa_anga" => "Pa'anga tongien",
'review_app_help' => 'Nous espérons que votre utilisation de cette application vous est agréable.
Un commentaire de votre part serait grandement apprécié!',
'writing_a_review' => 'rédiger un commentaire',
@@ -5353,7 +5353,8 @@ Développe automatiquement la section des notes dans le tableau de produits pour
'inbound_mailbox_allow_unknown' => 'Autoriser tous les envois',
'inbound_mailbox_allow_unknown_help' => 'Autoriser n\'importe qui à envoyer un courriel de dépenses pour traitement.',
'quick_actions' => 'Actions rapides',
- 'end_all_sessions_help' => 'Déconnecte tous les utilisateurs et oblige tous les utilisateurs actifs à se réauthentifier.'
+ 'end_all_sessions_help' => 'Déconnecte tous les utilisateurs et oblige tous les utilisateurs actifs à se réauthentifier.',
+ 'updated_records' => 'Enregistrements mis à jour',
);
return $lang;
diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml
index e17f3b3db2..f3082f4221 100644
--- a/openapi/api-docs.yaml
+++ b/openapi/api-docs.yaml
@@ -3,53 +3,46 @@ info:
title: 'Invoice Ninja API Reference.'
description: |
---
+ ![Invoice Ninja](https://invoicing.co/images/new_logo.png)
## Introduction
Welcome to the Invoice Ninja API documentation, your comprehensive guide to integrating Invoice Ninja's powerful features into your applications. Whether you're building a custom client, automating workflows, or integrating with other systems, our API provides the tools you need to streamline your invoicing and billing processes.
-
- ## What is Invoice Ninja?
+ ### What is Invoice Ninja?
Invoice Ninja is a robust source-available platform designed to simplify invoicing, billing, and payment management for freelancers, small businesses, and enterprises alike. With a user-friendly interface, customizable templates, and a suite of powerful features, Invoice Ninja empowers businesses to create professional invoices, track expenses, manage clients, and get paid faster.
-
- ## Why use the Invoice Ninja API?
+ ### Why use the Invoice Ninja API?
The Invoice Ninja API allows developers to extend the functionality of Invoice Ninja by programmatically accessing and manipulating data within their Invoice Ninja accounts. With the API, you can automate repetitive tasks, integrate with third-party services, and build custom solutions tailored to your specific business needs.
-
- ## Getting Started
+ ### Getting Started
To get started with the Invoice Ninja API, you'll need an active Invoice Ninja account (or your own self hosted installation) and API credentials. If you haven't already done so, sign up for an account at Invoice Ninja and generate your API keys from the settings section.
Once you have your API credentials, you can start exploring the API endpoints, authentication methods, request and response formats, and more using the documentation provided here.
-
- ## Explore the Documentation
+ ### Explore the Documentation
This documentation is organized into sections to help you navigate and understand the various aspects of the Invoice Ninja API:
- Authentication: Learn how to authenticate your requests to the API using API tokens.
- Endpoints: Explore the available API endpoints for managing invoices, clients, payments, expenses, and more.
- Request and Response Formats: Understand the structure of API requests and responses, including parameters, headers, and payloads.
- Error Handling: Learn about error codes, status messages, and best practices for handling errors gracefully.
- Code Examples: Find code examples and tutorials to help you get started with integrating the Invoice Ninja API into your applications.
-
- ## Need Help?
+ - Authentication: Learn how to authenticate your requests to the API using API tokens.
+ - Endpoints: Explore the available API endpoints for managing invoices, clients, payments, expenses, and more.
+ - Request and Response Formats: Understand the structure of API requests and responses, including parameters, headers, and payloads.
+ - Error Handling: Learn about error codes, status messages, and best practices for handling errors gracefully.
+ - Code Examples: Find code examples and tutorials to help you get started with integrating the Invoice Ninja API into your applications.
+ ### Need Help?
If you have any questions, encounter any issues, or need assistance with using the Invoice Ninja API, don't hesitate to reach out to our support team or join our community forums. We're here to help you succeed with Invoice Ninja and make the most of our API.
Let's start building together!
-
- ## Endpoints
+ ### Endpoints
Production: https://invoicing.co
Demo: https://demo.invoiceninja.com
- ## Client Libraries
+ ### Client Libraries
PHP SDK can be found [here](https://github.com/invoiceninja/sdk-php)
-
- ## Authentication:
+ ### Authentication:
Invoice Ninja uses API tokens to authenticate requests. You can view and manage your API keys in Settings > Account Management > Integrations > API tokens
API requests must be made over HTTPS. Calls made to HTTP will fail.
-
- ## Errors:
+ ### Errors:
Invoice Ninja uses standard HTTP response codes to indicate the success or failure of a request. below is a table of standard status codes and responses
@@ -67,10 +60,9 @@ info:
| 422 | Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors. |
| 429 | Too Many Requests: The user has sent too many requests in a given amount of time ("rate limiting"). |
| 500 | Internal Server Error: A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
+ ### Pagination
- ## Pagination
-
- When using index routes to retrieve lists of data, by default we limit the number of records returned to 20. You can using standard pagination to paginate results, ie:
+ When using index routes to retrieve lists of data, by default we limit the number of records returned to 20. You can using standard pagination to paginate results, ie: ?per_page=50
termsOfService: 'https://invoiceninja.github.io/docs/legal/terms_of_service/#page-content'
contact:
email: contact@invoiceninja.com
@@ -79,7 +71,7 @@ info:
license:
name: 'Elastic License'
url: 'https://www.elastic.co/licensing/elastic-license'
- version: 5.9.2
+ version: 5.10.31
servers:
- url: 'https://demo.invoiceninja.com'
description: |
@@ -8630,21 +8622,20 @@ paths:
default:
$ref: "#/components/responses/default"
- /api/v1/vendors:
+ /api/v1/credits:
get:
tags:
- - 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"
- operationId: getVendors
+ - 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"
+ operationId: getCredits
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- - $ref: "#/components/parameters/index"
responses:
200:
- description: "A list of vendors"
+ description: "A list of credits"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -8660,7 +8651,7 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/Vendor'
+ $ref: '#/components/schemas/Credit'
meta:
type: object
$ref: '#/components/schemas/Meta'
@@ -8678,17 +8669,17 @@ paths:
$ref: "#/components/responses/default"
post:
tags:
- - vendors
- summary: "Create vendor"
- description: "Adds a vendor to a company"
- operationId: storeVendor
+ - credits
+ summary: "Create credit"
+ description: "Adds an credit to the system"
+ operationId: storeCredit
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
responses:
200:
- description: "Returns the saved clivendorent object"
+ description: "Returns the saved credit object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -8699,11 +8690,12 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Vendor"
+ $ref: "#/components/schemas/Credit"
401:
$ref: "#/components/responses/401"
403:
$ref: "#/components/responses/403"
+
422:
$ref: '#/components/responses/422'
429:
@@ -8712,20 +8704,21 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- "/api/v1/vendors/{id}":
+
+ "/api/v1/credits/{id}":
get:
tags:
- - vendors
- summary: "Show vendor"
- description: "Displays a vendor by id"
- operationId: showVendor
+ - credits
+ summary: "Show credit"
+ description: "Displays an credit by id"
+ operationId: showCredit
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The vendor Hashed ID"
+ description: "The Credit Hashed ID"
required: true
schema:
type: string
@@ -8733,7 +8726,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the vendor object"
+ description: "Returns the credit object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -8744,11 +8737,12 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Vendor"
+ $ref: "#/components/schemas/Credit"
401:
$ref: "#/components/responses/401"
403:
$ref: "#/components/responses/403"
+
422:
$ref: '#/components/responses/422'
429:
@@ -8759,17 +8753,17 @@ paths:
$ref: "#/components/responses/default"
put:
tags:
- - vendors
- summary: "Update vendor"
- description: "Handles the updating of a vendor by id"
- operationId: updateVendor
+ - Credits
+ summary: "Update credit"
+ description: "Handles the updating of an Credit by id"
+ operationId: updateCredit
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Vendor Hashed ID"
+ description: "The Credit Hashed ID"
required: true
schema:
type: string
@@ -8777,7 +8771,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the vendor object"
+ description: "Returns the Credit object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -8788,11 +8782,12 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Vendor"
+ $ref: "#/components/schemas/Credit"
401:
$ref: "#/components/responses/401"
403:
$ref: "#/components/responses/403"
+
422:
$ref: '#/components/responses/422'
429:
@@ -8803,17 +8798,17 @@ paths:
$ref: "#/components/responses/default"
delete:
tags:
- - vendors
- summary: "Delete vendor"
- description: "Handles the deletion of a vendor by id"
- operationId: deleteVendor
+ - credits
+ summary: "Delete credit"
+ description: "Handles the deletion of an credit by id"
+ operationId: deleteCredit
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Vendor Hashed ID"
+ description: "The Credit Hashed ID"
required: true
schema:
type: string
@@ -8833,6 +8828,7 @@ paths:
$ref: "#/components/responses/401"
403:
$ref: "#/components/responses/403"
+
422:
$ref: '#/components/responses/422'
429:
@@ -8841,20 +8837,20 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- "/api/v1/vendors/{id}/edit":
+ "/api/v1/credits/{id}/edit":
get:
tags:
- - vendors
- summary: "Edit vendor"
- description: "Displays a vendor by id"
- operationId: editVendor
+ - credits
+ summary: "Edit credit"
+ description: "Displays an credit by id"
+ operationId: editCredit
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Vendor Hashed ID"
+ description: "The Invoice Hashed ID"
required: true
schema:
type: string
@@ -8862,7 +8858,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the vendor object"
+ description: "Returns the credit object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -8873,11 +8869,12 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Vendor"
+ $ref: "#/components/schemas/Invoice"
401:
$ref: "#/components/responses/401"
403:
$ref: "#/components/responses/403"
+
422:
$ref: '#/components/responses/422'
429:
@@ -8886,20 +8883,20 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- /api/v1/vendors/create:
+ /api/v1/credits/create:
get:
tags:
- - vendors
- summary: "Blank vendor"
- description: "Returns a blank vendor with default values"
- operationId: getVendorsCreate
+ - credits
+ summary: "Blank credit"
+ description: "Returns a blank object with default values"
+ operationId: getCreditsCreate
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
responses:
200:
- description: "A blank vendor object"
+ description: "A blank credit object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -8910,11 +8907,12 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Vendor"
+ $ref: "#/components/schemas/Credit"
401:
$ref: "#/components/responses/401"
403:
$ref: "#/components/responses/403"
+
422:
$ref: '#/components/responses/422'
429:
@@ -8923,13 +8921,13 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- /api/v1/vendors/bulk:
+ /api/v1/credits/bulk:
post:
tags:
- - vendors
- summary: "Bulk vendor actions"
+ - credits
+ summary: "Bulk credit actions"
description: ""
- operationId: bulkVendors
+ operationId: bulkCredits
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
@@ -8943,11 +8941,11 @@ paths:
type: array
items:
description: "Array of hashed IDs to be bulk 'actioned"
- type: integer
- example: "[0,1,2,3]"
+ type: string
+ example: '[D2J234DFA,D2J234DFA,D2J234DFA]'
responses:
200:
- description: "The Vendor User response"
+ description: "The Bulk Action response"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -8955,14 +8953,11 @@ paths:
$ref: "#/components/headers/X-RateLimit-Remaining"
X-RateLimit-Limit:
$ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Vendor"
401:
$ref: "#/components/responses/401"
403:
$ref: "#/components/responses/403"
+
422:
$ref: '#/components/responses/422'
429:
@@ -8971,20 +8966,62 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- "/api/v1/vendors/{id}/upload":
+ "/api/v1/credit/{invitation_key}/download":
+ get:
+ tags:
+ - quotes
+ summary: "Download quote PDF"
+ description: "Downloads a specific quote"
+ operationId: downloadCredit
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: invitation_key
+ in: path
+ description: "The Credit Invitation Key"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns the credit pdf"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ "/api/v1/credits/{id}/upload":
post:
tags:
- - vendors
- summary: "Uploads a vendor document"
- description: "Handles the uploading of a document to a vendor"
- operationId: uploadVendor
+ - credits
+ summary: "Upload a credit document"
+ description: "Handles the uploading of a document to a credit"
+ operationId: uploadCredits
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Vendor Hashed ID"
+ description: "The Credit Hashed ID"
required: true
schema:
type: string
@@ -9009,7 +9046,7 @@ paths:
format: binary
responses:
200:
- description: "Returns the Vendor object"
+ description: "Returns the Credit object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -9020,7 +9057,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Vendor"
+ $ref: "#/components/schemas/Credit"
401:
$ref: "#/components/responses/401"
403:
@@ -9033,557 +9070,6 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- /api/v1/products:
- get:
- tags:
- - products
- summary: "List products"
- x-code-samples:
- - lang: curl
- label: Curl
- source: |
- curl -X GET 'https://invoicing.co/api/v1/products?filter=search&per_page=20&page=1&include=documents' \
- -H "X-API-TOKEN:company-token-test" \
- -H "X-Requested-With: XMLHttpRequest";
- - lang: go
- label: PHP
- source: |
- $ninja = new InvoiceNinja("your_token");
- $products = $ninja->products->all([
- 'filter' => 'search',
- 'per_page' => 20,
- 'page' => 1,
- 'include' => 'documents'
- ]);
- description: |
- Lists products within your company.
-
- You can search and filter the result set using query parameters. These can be chained together allowing fine grained lists to be generated.
-
- operationId: getProducts
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - $ref: "#/components/parameters/status"
- - $ref: "#/components/parameters/client_id"
- - $ref: "#/components/parameters/created_at"
- - $ref: "#/components/parameters/updated_at"
- - $ref: "#/components/parameters/is_deleted"
- - $ref: "#/components/parameters/filter_deleted_clients"
- - $ref: "#/components/parameters/vendor_id"
- - name: filter
- in: query
- description: Filter by product name
- required: false
- schema:
- type: string
- example: bob
- - name: product_key
- in: query
- description: Filter by product key
- required: false
- schema:
- type: string
- example: bob
- - name: sort
- in: query
- description: Returns the list sorted by column in ascending or descending order.
- required: false
- schema:
- type: string
- example: id|desc product_key|desc
- responses:
- 200:
- description: "A list of products"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Product'
- meta:
- type: object
- $ref: '#/components/schemas/Meta'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- post:
- tags:
- - products
- summary: "Create Product"
- x-code-samples:
- - lang: curl
- label: Curl
- source: |
- curl -X POST 'https://invoicing.co/api/v1/products' \
- -H "X-API-TOKEN:company-token-test" \
- -H "Content-Type:application/json" \
- -d '{"product_key":"sku_1","notes":"product description","cost":1,"price":10}' \
- -H "X-Requested-With: XMLHttpRequest";
- - lang: go
- label: PHP
- source: |
- $ninja = new InvoiceNinja("your_token");
- $products = $ninja->products->create([
- 'product_key' => "sku_1",
- 'notes' => "product description",
- 'cost' => 1,
- 'price' => 10
- ]);
- description: "Adds a product to a company"
- operationId: storeProduct
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- requestBody:
- description: Product object that needs to be added to the company
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ProductRequest'
- responses:
- 200:
- description: "Returns the saved product object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Product"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- "/api/v1/products/{id}":
- get:
- tags:
- - products
- summary: "Show product"
- x-code-samples:
- - lang: curl
- label: Curl
- source: |
- curl -X GET 'https://invoicing.co/api/v1/products/{id}' \
- -H "X-API-TOKEN:company-token-test" \
- -H "X-Requested-With: XMLHttpRequest";
- - lang: php
- label: PHP
- source: |
- $ninja = new InvoiceNinja("your_token");
- $product = $ninja->products->get("{id}");
- description: "Displays a product by id"
- operationId: showProduct
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Product Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns the product object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Product"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- put:
- tags:
- - products
- summary: "Update product"
- x-code-samples:
- - lang: curl
- label: Curl
- source: |
- curl -X PUT 'https://invoicing.co/api/v1/products/{id}' \
- -H "X-API-TOKEN:company-token-test" \
- -H "Content-Type: application/json" \
- -d '{
- "product_key": "Updated Product",
- "price": 150.0,
- "notes": "An updated description of the product"
- }'
- - lang: go
- label: PHP
- source: |
- $ninja = new InvoiceNinja("your_token");
- $product = $ninja->products->update("id", [
- "name" => "Updated Product",
- "price" => 150.0,
- "description" => "An updated description of the product"
- ]);
- description: "Handles the updating of a product by id"
- operationId: updateProduct
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Product Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- requestBody:
- description: Product object that needs to be added to the company
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ProductRequest'
- responses:
- 200:
- description: "Returns the Product object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Product"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- delete:
- tags:
- - products
- summary: "Delete product"
- x-code-samples:
- - lang: curl
- label: Curl
- source: |
- curl -X DELETE 'https://invoicing.co/api/v1/products/{id}' \
- -H "X-API-TOKEN:company-token-test" \
- -H "X-Requested-With: XMLHttpRequest";
- - lang: go
- label: PHP
- source: |
- $ninja = new InvoiceNinja("your_token");
- $ninja->products->bulk("delete", "id");
- description: "Handles the deletion of a product by id"
- operationId: deleteProduct
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Product Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns a HTTP status"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- "/api/v1/products/{id}/edit":
- get:
- tags:
- - products
- summary: "Edit product"
- x-code-samples:
- - lang: curl
- label: Curl
- source: |
- curl -X GET 'https://invoicing.co/api/v1/products/{id}/edit' \
- -H "X-API-TOKEN:company-token-test" \
- -H "X-Requested-With: XMLHttpRequest";
- - lang: php
- label: PHP
- source: |
- $ninja = new InvoiceNinja("your_token");
- $product = $ninja->products->get("{id}");
- description: "Displays an Product by id"
- operationId: editProduct
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Product Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns the Product object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Product"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- "/api/v1/products/create":
- get:
- tags:
- - products
- summary: "Blank product"
- description: "Returns a blank product object with default values"
- operationId: getProductsCreate
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- responses:
- 200:
- description: "A blank Product object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Product"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
-
- /api/v1/products/bulk:
- post:
- tags:
- - products
- summary: "Bulk product actions"
- x-code-samples:
- - lang: curl
- label: Curl
- source: |
- curl -X GET 'https://invoicing.co/api/v1/products/bulk' \
- -H "Content-Type:application/json" \
- -d '{"action":"archive","ids":["id","id2"]}' \
- -H "X-API-TOKEN:company-token-test" \
- -H "X-Requested-With: XMLHttpRequest";
- - lang: php
- label: PHP
- source: |
- $ninja = new InvoiceNinja("your_token");
- $product = $ninja->products->bulk("action", ["id","id2"]);
- description: "Archive / Restore / Delete / Set tax id in bulk"
- operationId: bulkProducts
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/index"
- requestBody:
- description: 'Bulk action array'
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ProductBulkAction'
- responses:
- 200:
- description: "The Product response"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Product"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
-
- "/api/v1/products/{id}/upload":
- post:
- tags:
- - products
- summary: "Add product document"
- description: "Handles the uploading of a document to a product"
- operationId: uploadProduct
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/client_include"
- - name: id
- in: path
- description: "The Product Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- requestBody:
- required: true
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- _method:
- type: string
- example: POST
- documents:
- type: array
- items:
- format: binary
- responses:
- 200:
- description: "Returns the Product object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Product"
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
-
/api/v1/recurring_invoices:
get:
tags:
@@ -10146,1215 +9632,13 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- /api/v1/clients:
+ /api/v1/tasks:
get:
tags:
- - clients
- summary: 'List clients'
- x-code-samples:
- - lang: go
- label: php
- source: |
- $ninja = new InvoiceNinja("your_token");
- $invoices = $ninja->clients->all();
- x-custom-element:
- type: markdown
- value: |
- ### Custom Response Description
- This is a custom description for the response returned by the `/example` endpoint.
- description: |
- When retrieving a list of clients you can also chain query parameters in order to filter the dataset that is returned. For example, you can send a request to the following URL to retrieve clients that have a balance greater than 1000:\
-
- ```
- /api/v1/clients?balance=gt:1000
- ```
-
- You can also sort the results by adding a sort parameter. The following example will sort the results by the client name in descending order:\
-
- ```
- /api/v1/clients?sort=name|desc
- ```
-
- You can also combine multiple filters together. The following example will return clients that have a balance greater than 1000 and are not deleted and have a name that starts with "Bob":\
-
- ```
- /api/v1/clients?balance=gt:1000&name=Bob*
- ```
-
- If you wish to retrieve child relations, you can also combine the query parameter `?include=` with a comma separated list of relationships:\
-
- ```
- /api/v1/clients?include=activities,ledger,system_logs'
- ```
-
- The per_page and page variables allow pagination of the list of clients. The following example will return the second page of clients with 15 clients per page:\
-
- ```
- /api/v1/clients?per_page=15&page=2
- ```
-
- The default per_page value is 20.
-
- operationId: getClients
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- - $ref: '#/components/parameters/index'
- - $ref: "#/components/parameters/status"
- - $ref: "#/components/parameters/created_at"
- - $ref: "#/components/parameters/updated_at"
- - $ref: "#/components/parameters/is_deleted"
- - $ref: "#/components/parameters/filter_deleted_clients"
- - $ref: "#/components/parameters/vendor_id"
- - name: name
- in: query
- description: Filter by client name
- required: false
- schema:
- type: string
- example: bob
- - name: balance
- in: query
- description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq
- required: false
- schema:
- type: string
- example: lt:10
- - name: between_balance
- in: query
- description: Filter between client balances, format uses two values separated by a colon
- required: false
- schema:
- type: string
- example: 10:100
- - name: email
- in: query
- description: Filter by client email
- required: false
- schema:
- type: string
- example: bob@gmail.com
- - name: id_number
- in: query
- description: Filter by client id_number
- required: false
- schema:
- type: string
- example: a1039883
- - name: number
- in: query
- description: Filter by client number
- required: false
- schema:
- type: string
- example: a1039883
- - name: filter
- in: query
- description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4
- required: false
- schema:
- type: string
- example: a1039883
- - name: sort
- in: query
- description: Returns the list sorted by column in ascending or descending order.
- required: false
- schema:
- type: string
- example: id|desc name|desc balance|asc
-
- responses:
- 200:
- description: 'A list of clients'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Client'
- example:
- $ref: '#/components/schemas/Client'
- meta:
- type: object
- $ref: '#/components/schemas/Meta'
- example:
- $ref: '#/components/schemas/Meta'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- post:
- tags:
- - clients
- summary: 'Create client'
- description: |
- Adds a client to a company
-
- When creating (or updating) a client you must include the child contacts with all mutating requests. Client contacts cannot be modified in isolation.
-
- operationId: storeClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- requestBody:
- description: Client object that needs to be added to the company
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientRequest'
- responses:
- 200:
- description: 'Returns the saved client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- '/api/v1/clients/{id}':
- get:
- tags:
- - clients
- summary: 'Show client'
- description: 'Displays a client by id'
- operationId: showClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- - name: id
- in: path
- description: 'The Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: 'Returns the client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- put:
- tags:
- - clients
- summary: 'Update client'
- description: 'Handles the updating of a client by id'
- operationId: updateClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- - name: id
- in: path
- description: 'The Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- requestBody:
- description: Client object that needs to be updated
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ClientRequest'
- responses:
- 200:
- description: 'Returns the client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- delete:
- tags:
- - clients
- summary: 'Delete client'
- description: 'Handles the deletion of a client by id'
- operationId: deleteClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- - name: id
- in: path
- description: 'The Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: 'Returns a HTTP status'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- '/api/v1/clients/{id}/edit':
- get:
- tags:
- - clients
- summary: 'Edit Client'
- description: 'Displays a client by id, essentially an alias of the show route'
- operationId: editClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/include'
- - name: id
- in: path
- description: 'The Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: 'Returns the client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- /api/v1/clients/create:
- get:
- tags:
- - clients
- summary: 'Blank Client'
- description: 'Returns a blank object with default values'
- operationId: getClientsCreate
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- responses:
- 200:
- description: 'A blank client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- /api/v1/clients/bulk:
- post:
- tags:
- - clients
- summary: 'Bulk client actions'
- description: 'Archive / Restore / Delete in bulk'
- operationId: bulkClients
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/index'
- requestBody:
- description: 'Bulk action array'
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/GenericBulkAction'
-
- responses:
- 200:
- description: 'The Client listresponse'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- '/api/v1/clients/{id}/upload':
- post:
- tags:
- - clients
- summary: 'Add client document'
- description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST'
- operationId: uploadClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- - name: id
- in: path
- description: 'The Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- requestBody:
- required: true
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- _method:
- type: string
- example: POST
- documents:
- type: array
- items:
- format: binary
- responses:
- 200:
- description: 'Returns the client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- '/api/v1/clients/{id}/purge':
- post:
- tags:
- - clients
- summary: 'Purge client'
- description: |
- Handles purging a clients.
-
- Please note this is a destructive action.
-
- This action will remove all data associated with the client and cannot be undone.
- operationId: purgeClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/X-API-PASSWORD'
- - $ref: '#/components/parameters/client_include'
- - name: id
- in: path
- description: 'The Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: 'Returns the client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- '/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge':
- post:
- tags:
- - clients
- summary: 'Merge client'
- description: |
- Handles merging 2 clients
-
- The id parameter is the client that will be the primary client after the merge has completed.
-
- The mergeable_client_hashed_id is the client that will be merged into the primary client, this clients records will be updated and associated with the primary client.
- operationId: mergeClient
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/client_include'
- - $ref: '#/components/parameters/X-API-PASSWORD'
- - name: id
- in: path
- description: 'The Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- - name: mergeable_client_hashed_id
- in: path
- description: 'The Mergeable Client Hashed ID'
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: 'Returns the client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- default:
- $ref: '#/components/responses/default'
- /api/v1/client_statement:
- post:
- tags:
- - clients
- summary: 'Client statement PDF'
- description: 'Return a PDF of the client statement'
- operationId: clientStatement
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/include'
- requestBody:
- description: 'Statement Options'
- required: true
- content:
- application/json:
- schema:
- properties:
- start_date:
- description: 'The start date of the statement period - format Y-m-d'
- type: string
- end_date:
- description: 'The start date of the statement period - format Y-m-d'
- type: string
- client_id:
- description: 'The hashed ID of the client'
- type: string
- show_payments_table:
- description: 'Flag which determines if the payments table is shown'
- type: boolean
- show_credits_table:
- description: 'Flag which determines if the credits table is shown'
- type: boolean
- show_aging_table:
- description: 'Flag which determines if the aging table is shown'
- type: boolean
- type: object
- responses:
- 200:
- description: 'Returns the client object'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Client'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- /api/v1/reactivate_email/{bounce_id}:
- post:
- tags:
- - clients
- summary: 'Removes email suppression of a user in the system'
- description: '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
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/include'
- - name: bounce_id
- in: path
- description: 'The postmark Bounce ID reference'
- required: true
- schema:
- type: string
- format: string
- example: 123243
- responses:
- 200:
- description: 'Success'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- 400:
- description: 'Postmark exception - generated if the suppression cannot be removed for any reason'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- /api/v1/clients/{client}/updateTaxData:
- post:
- tags:
- - clients
- summary: 'Update tax data'
- description: 'Updates the clients tax data - if their address has changed'
- operationId: updateClientTaxData
- parameters:
- - $ref: '#/components/parameters/X-API-TOKEN'
- - $ref: '#/components/parameters/X-Requested-With'
- - $ref: '#/components/parameters/include'
- - name: client
- in: path
- description: 'The Client Hashed ID reference'
- required: true
- schema:
- type: string
- format: string
- example: V2J234DFA
- responses:
- 200:
- description: 'Success'
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
- X-RateLimit-Remaining:
- $ref: '#/components/headers/X-RateLimit-Remaining'
- X-RateLimit-Limit:
- $ref: '#/components/headers/X-RateLimit-Limit'
- 400:
- description: 'Postmark exception - generated if the suppression cannot be removed for any reason'
- 401:
- $ref: '#/components/responses/401'
- 403:
- $ref: '#/components/responses/403'
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: '#/components/responses/default'
- /api/v1/credits:
- get:
- tags:
- - 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"
- operationId: getCredits
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- responses:
- 200:
- description: "A list of credits"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Credit'
- meta:
- type: object
- $ref: '#/components/schemas/Meta'
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- post:
- tags:
- - credits
- summary: "Create credit"
- description: "Adds an credit to the system"
- operationId: storeCredit
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- responses:
- 200:
- description: "Returns the saved credit object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Credit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
-
- "/api/v1/credits/{id}":
- get:
- tags:
- - credits
- summary: "Show credit"
- description: "Displays an credit by id"
- operationId: showCredit
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Credit Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns the credit object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Credit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- put:
- tags:
- - Credits
- summary: "Update credit"
- description: "Handles the updating of an Credit by id"
- operationId: updateCredit
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Credit Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns the Credit object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Credit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- delete:
- tags:
- - credits
- summary: "Delete credit"
- description: "Handles the deletion of an credit by id"
- operationId: deleteCredit
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Credit Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns a HTTP status"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- "/api/v1/credits/{id}/edit":
- get:
- tags:
- - credits
- summary: "Edit credit"
- description: "Displays an credit by id"
- operationId: editCredit
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Invoice Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns the credit object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Invoice"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- /api/v1/credits/create:
- get:
- tags:
- - credits
- summary: "Blank credit"
- description: "Returns a blank object with default values"
- operationId: getCreditsCreate
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- responses:
- 200:
- description: "A blank credit object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Credit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- /api/v1/credits/bulk:
- post:
- tags:
- - credits
- summary: "Bulk credit actions"
- description: ""
- operationId: bulkCredits
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/index"
- requestBody:
- description: "User credentials"
- required: true
- content:
- application/json:
- schema:
- type: array
- items:
- description: "Array of hashed IDs to be bulk 'actioned"
- type: string
- example: '[D2J234DFA,D2J234DFA,D2J234DFA]'
- responses:
- 200:
- description: "The Bulk Action response"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- "/api/v1/credit/{invitation_key}/download":
- get:
- tags:
- - quotes
- summary: "Download quote PDF"
- description: "Downloads a specific quote"
- operationId: downloadCredit
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: invitation_key
- in: path
- description: "The Credit Invitation Key"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- responses:
- 200:
- description: "Returns the credit pdf"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
-
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- "/api/v1/credits/{id}/upload":
- post:
- tags:
- - credits
- summary: "Upload a credit document"
- description: "Handles the uploading of a document to a credit"
- operationId: uploadCredits
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- - name: id
- in: path
- description: "The Credit Hashed ID"
- required: true
- schema:
- type: string
- format: string
- example: D2J234DFA
- requestBody:
- description: "File Upload Body"
- required: true
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- _method:
- type: string
- example: PUT
- documents:
- type: array
- items:
- description: "Array of binary documents for upload"
- type: string
- format: binary
- responses:
- 200:
- description: "Returns the Credit object"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/Credit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
- /api/v1/projects:
- get:
- tags:
- - projects
- summary: "List projects"
- description: "Lists projects"
- operationId: getProjects
+ - 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"
+ operationId: getTasks
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
@@ -11362,7 +9646,7 @@ paths:
- $ref: "#/components/parameters/index"
responses:
200:
- description: "A list of projects"
+ description: "A list of tasks"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11378,7 +9662,7 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/Project'
+ $ref: '#/components/schemas/Task'
meta:
type: object
$ref: '#/components/schemas/Meta'
@@ -11396,17 +9680,17 @@ paths:
$ref: "#/components/responses/default"
post:
tags:
- - projects
- summary: "Create project"
- description: "Adds an project to a company"
- operationId: storeProject
+ - tasks
+ summary: "Create task"
+ description: "Adds an task to a company"
+ operationId: storeTask
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
responses:
200:
- description: "Returns the saved project object"
+ description: "Returns the saved task object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11417,7 +9701,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Project"
+ $ref: "#/components/schemas/Task"
401:
$ref: "#/components/responses/401"
403:
@@ -11430,20 +9714,20 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- "/api/v1/projects/{id}":
+ "/api/v1/tasks/{id}":
get:
tags:
- - projects
- summary: "Show project"
- description: "Displays a project by id"
- operationId: showProject
+ - tasks
+ summary: "Show task"
+ description: "Displays a task by id"
+ operationId: showTask
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Project Hashed ID"
+ description: "The Task Hashed ID"
required: true
schema:
type: string
@@ -11451,7 +9735,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the expense object"
+ description: "Returns the task object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11462,7 +9746,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Project"
+ $ref: "#/components/schemas/Task"
401:
$ref: "#/components/responses/401"
403:
@@ -11477,17 +9761,17 @@ paths:
$ref: "#/components/responses/default"
put:
tags:
- - projects
- summary: "Update project"
- description: "Handles the updating of a project by id"
- operationId: updateProject
+ - tasks
+ summary: "Update task"
+ description: "Handles the updating of a task by id"
+ operationId: updateTask
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Project Hashed ID"
+ description: "The task Hashed ID"
required: true
schema:
type: string
@@ -11495,7 +9779,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the project object"
+ description: "Returns the task object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11506,7 +9790,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Project"
+ $ref: "#/components/schemas/Task"
401:
$ref: "#/components/responses/401"
403:
@@ -11521,17 +9805,17 @@ paths:
$ref: "#/components/responses/default"
delete:
tags:
- - projects
- summary: "Delete project"
- description: "Handles the deletion of a project by id"
- operationId: deleteProject
+ - tasks
+ summary: "Delete task"
+ description: "Handles the deletion of a task by id"
+ operationId: deleteTask
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Project Hashed ID"
+ description: "The Task Hashed ID"
required: true
schema:
type: string
@@ -11559,20 +9843,20 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- "/api/v1/projects/{id}/edit":
+ "/api/v1/tasks/{id}/edit":
get:
tags:
- - projects
- summary: "Edit project"
- description: "Displays a project by id"
- operationId: editProject
+ - tasks
+ summary: "Edit task"
+ description: "Displays a task by id"
+ operationId: editTask
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Project Hashed ID"
+ description: "The Task Hashed ID"
required: true
schema:
type: string
@@ -11580,7 +9864,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the project object"
+ description: "Returns the client object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11591,7 +9875,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Project"
+ $ref: "#/components/schemas/Task"
401:
$ref: "#/components/responses/401"
403:
@@ -11604,20 +9888,20 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- /api/v1/projects/create:
+ /api/v1/tasks/create:
get:
tags:
- - projects
- summary: "Blank project"
- description: "Returns a blank object with default values"
- operationId: getProjectsCreate
+ - tasks
+ summary: "Blank task"
+ description: "Returns a blank task with default values"
+ operationId: getTasksCreate
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
responses:
200:
- description: "A blank project object"
+ description: "A blank task object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11628,7 +9912,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Project"
+ $ref: "#/components/schemas/Task"
401:
$ref: "#/components/responses/401"
403:
@@ -11641,13 +9925,13 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- /api/v1/projects/bulk:
+ /api/v1/tasks/bulk:
post:
tags:
- - projects
- summary: "Bulk project actions"
+ - tasks
+ summary: "Bulk task actions"
description: ""
- operationId: bulkProjects
+ operationId: bulkTasks
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
@@ -11665,7 +9949,7 @@ paths:
example: "[0,1,2,3]"
responses:
200:
- description: "The Project User response"
+ description: "The Task User response"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11676,7 +9960,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Project"
+ $ref: "#/components/schemas/Task"
401:
$ref: "#/components/responses/401"
403:
@@ -11689,20 +9973,20 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- "/api/v1/projects/{id}/upload":
+ "/api/v1/tasks/{id}/upload":
post:
tags:
- - projects
- summary: "Uploads a project document"
- description: "Handles the uploading of a document to a project"
- operationId: uploadProject
+ - tasks
+ summary: "Uploads a task document"
+ description: "Handles the uploading of a document to a task"
+ operationId: uploadTask
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Project Hashed ID"
+ description: "The Task Hashed ID"
required: true
schema:
type: string
@@ -11727,7 +10011,7 @@ paths:
format: binary
responses:
200:
- description: "Returns the Project object"
+ description: "Returns the Task object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -11738,7 +10022,40 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Project"
+ $ref: "#/components/schemas/Task"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ /api/v1/tasks/sort:
+ post:
+ tags:
+ - tasks
+ summary: "Sort tasks on KanBan"
+ description: "Sorts tasks after drag and drop on the KanBan."
+ operationId: sortTasks
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ responses:
+ 200:
+ description: "Returns an Ok, 200 HTTP status"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
401:
$ref: "#/components/responses/401"
403:
@@ -13008,6 +11325,812 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
+ /api/v1/projects:
+ get:
+ tags:
+ - projects
+ summary: "List projects"
+ description: "Lists projects"
+ operationId: getProjects
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - $ref: "#/components/parameters/index"
+ responses:
+ 200:
+ description: "A list of projects"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Project'
+ meta:
+ type: object
+ $ref: '#/components/schemas/Meta'
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ post:
+ tags:
+ - projects
+ summary: "Create project"
+ description: "Adds an project to a company"
+ operationId: storeProject
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ responses:
+ 200:
+ description: "Returns the saved project object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Project"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ "/api/v1/projects/{id}":
+ get:
+ tags:
+ - projects
+ summary: "Show project"
+ description: "Displays a project by id"
+ operationId: showProject
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Project Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns the expense object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Project"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ put:
+ tags:
+ - projects
+ summary: "Update project"
+ description: "Handles the updating of a project by id"
+ operationId: updateProject
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Project Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns the project object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Project"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ delete:
+ tags:
+ - projects
+ summary: "Delete project"
+ description: "Handles the deletion of a project by id"
+ operationId: deleteProject
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Project Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns a HTTP status"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ "/api/v1/projects/{id}/edit":
+ get:
+ tags:
+ - projects
+ summary: "Edit project"
+ description: "Displays a project by id"
+ operationId: editProject
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Project Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns the project object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Project"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ /api/v1/projects/create:
+ get:
+ tags:
+ - projects
+ summary: "Blank project"
+ description: "Returns a blank object with default values"
+ operationId: getProjectsCreate
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ responses:
+ 200:
+ description: "A blank project object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Project"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ /api/v1/projects/bulk:
+ post:
+ tags:
+ - projects
+ summary: "Bulk project actions"
+ description: ""
+ operationId: bulkProjects
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/index"
+ requestBody:
+ description: "User credentials"
+ required: true
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ description: "Array of hashed IDs to be bulk 'actioned"
+ type: integer
+ example: "[0,1,2,3]"
+ responses:
+ 200:
+ description: "The Project User response"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Project"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ "/api/v1/projects/{id}/upload":
+ post:
+ tags:
+ - projects
+ summary: "Uploads a project document"
+ description: "Handles the uploading of a document to a project"
+ operationId: uploadProject
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Project Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ requestBody:
+ description: "File Upload Body"
+ required: true
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ _method:
+ type: string
+ example: PUT
+ documents:
+ type: array
+ items:
+ description: "Array of binary documents for upload"
+ type: string
+ format: binary
+ responses:
+ 200:
+ description: "Returns the Project object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Project"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ /api/v1/vendors:
+ get:
+ tags:
+ - 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"
+ operationId: getVendors
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - $ref: "#/components/parameters/index"
+ responses:
+ 200:
+ description: "A list of vendors"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Vendor'
+ meta:
+ type: object
+ $ref: '#/components/schemas/Meta'
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ post:
+ tags:
+ - vendors
+ summary: "Create vendor"
+ description: "Adds a vendor to a company"
+ operationId: storeVendor
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ responses:
+ 200:
+ description: "Returns the saved clivendorent object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Vendor"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ "/api/v1/vendors/{id}":
+ get:
+ tags:
+ - vendors
+ summary: "Show vendor"
+ description: "Displays a vendor by id"
+ operationId: showVendor
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The vendor Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns the vendor object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Vendor"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ put:
+ tags:
+ - vendors
+ summary: "Update vendor"
+ description: "Handles the updating of a vendor by id"
+ operationId: updateVendor
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Vendor Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns the vendor object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Vendor"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ delete:
+ tags:
+ - vendors
+ summary: "Delete vendor"
+ description: "Handles the deletion of a vendor by id"
+ operationId: deleteVendor
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Vendor Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns a HTTP status"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ "/api/v1/vendors/{id}/edit":
+ get:
+ tags:
+ - vendors
+ summary: "Edit vendor"
+ description: "Displays a vendor by id"
+ operationId: editVendor
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Vendor Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: "Returns the vendor object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Vendor"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ /api/v1/vendors/create:
+ get:
+ tags:
+ - vendors
+ summary: "Blank vendor"
+ description: "Returns a blank vendor with default values"
+ operationId: getVendorsCreate
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ responses:
+ 200:
+ description: "A blank vendor object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Vendor"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ /api/v1/vendors/bulk:
+ post:
+ tags:
+ - vendors
+ summary: "Bulk vendor actions"
+ description: ""
+ operationId: bulkVendors
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/index"
+ requestBody:
+ description: "User credentials"
+ required: true
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ description: "Array of hashed IDs to be bulk 'actioned"
+ type: integer
+ example: "[0,1,2,3]"
+ responses:
+ 200:
+ description: "The Vendor User response"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Vendor"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
+ "/api/v1/vendors/{id}/upload":
+ post:
+ tags:
+ - vendors
+ summary: "Uploads a vendor document"
+ description: "Handles the uploading of a document to a vendor"
+ operationId: uploadVendor
+ parameters:
+ - $ref: "#/components/parameters/X-API-TOKEN"
+ - $ref: "#/components/parameters/X-Requested-With"
+ - $ref: "#/components/parameters/include"
+ - name: id
+ in: path
+ description: "The Vendor Hashed ID"
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ requestBody:
+ description: "File Upload Body"
+ required: true
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ _method:
+ type: string
+ example: PUT
+ documents:
+ type: array
+ items:
+ description: "Array of binary documents for upload"
+ type: string
+ format: binary
+ responses:
+ 200:
+ description: "Returns the Vendor object"
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
+ X-RateLimit-Remaining:
+ $ref: "#/components/headers/X-RateLimit-Remaining"
+ X-RateLimit-Limit:
+ $ref: "#/components/headers/X-RateLimit-Limit"
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/Vendor"
+ 401:
+ $ref: "#/components/responses/401"
+ 403:
+ $ref: "#/components/responses/403"
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: "#/components/responses/default"
/api/v1/payments:
get:
tags:
@@ -13553,6 +12676,786 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
+ /api/v1/clients:
+ get:
+ tags:
+ - clients
+ summary: 'List clients'
+ x-codeSamples:
+ - lang: php
+ label: php
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $invoices = $ninja->clients->all();
+ - lang: curl
+ label: curl
+ source: |
+ curl --request GET \
+ --url 'https://invoicing.co/api/v1/clients?per_page=10&page=1&sort=name&sort_dir=asc' \
+ --header 'X-API-TOKEN: YOUR_API_TOKEN_HERE' \
+ --header 'Accept: application/json'
+ description: |
+ When retrieving a list of clients you can also chain query parameters in order to filter the dataset that is returned. For example, you can send a request to the following URL to retrieve clients that have a balance greater than 1000:\
+
+ ```
+ /api/v1/clients?balance=gt:1000
+ ```
+
+ You can also sort the results by adding a sort parameter. The following example will sort the results by the client name in descending order:\
+
+ ```
+ /api/v1/clients?sort=name|desc
+ ```
+
+ You can also combine multiple filters together. The following example will return clients that have a balance greater than 1000 and are not deleted and have a name that starts with "Bob":\
+
+ ```
+ /api/v1/clients?balance=gt:1000&name=Bob*
+ ```
+
+ If you wish to retrieve child relations, you can also combine the query parameter `?include=` with a comma separated list of relationships:\
+
+ ```
+ /api/v1/clients?include=activities,ledger,system_logs'
+ ```
+
+ The per_page and page variables allow pagination of the list of clients. The following example will return the second page of clients with 15 clients per page:\
+
+ ```
+ /api/v1/clients?per_page=15&page=2
+ ```
+
+ The default per_page value is 20.
+
+ operationId: getClients
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ - $ref: '#/components/parameters/index'
+ - $ref: "#/components/parameters/status"
+ - $ref: "#/components/parameters/created_at"
+ - $ref: "#/components/parameters/updated_at"
+ - $ref: "#/components/parameters/is_deleted"
+ - $ref: "#/components/parameters/filter_deleted_clients"
+ - $ref: "#/components/parameters/vendor_id"
+ - name: name
+ in: query
+ description: Filter by client name
+ required: false
+ schema:
+ type: string
+ example: bob
+ - name: balance
+ in: query
+ description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq
+ required: false
+ schema:
+ type: string
+ example: lt:10
+ - name: between_balance
+ in: query
+ description: Filter between client balances, format uses two values separated by a colon
+ required: false
+ schema:
+ type: string
+ example: 10:100
+ - name: email
+ in: query
+ description: Filter by client email
+ required: false
+ schema:
+ type: string
+ example: bob@gmail.com
+ - name: id_number
+ in: query
+ description: Filter by client id_number
+ required: false
+ schema:
+ type: string
+ example: a1039883
+ - name: number
+ in: query
+ description: Filter by client number
+ required: false
+ schema:
+ type: string
+ example: a1039883
+ - name: filter
+ in: query
+ description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4
+ required: false
+ schema:
+ type: string
+ example: a1039883
+ - name: sort
+ in: query
+ description: Returns the list sorted by column in ascending or descending order.
+ required: false
+ schema:
+ type: string
+ example: id|desc name|desc balance|asc
+
+ responses:
+ 200:
+ description: 'A list of clients'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ post:
+ tags:
+ - clients
+ summary: 'Create client'
+ description: |
+ Adds a client to a company
+
+ When creating (or updating) a client you must include the child contacts with all mutating requests. Client contacts cannot be modified in isolation.
+
+ operationId: storeClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ requestBody:
+ description: Client object that needs to be added to the company
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientRequest'
+ responses:
+ 200:
+ description: 'Returns the saved client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ '/api/v1/clients/{id}':
+ get:
+ tags:
+ - clients
+ summary: 'Show client'
+ description: 'Displays a client by id'
+ operationId: showClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ - name: id
+ in: path
+ description: 'The Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: 'Returns the client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ put:
+ tags:
+ - clients
+ summary: 'Update client'
+ description: 'Handles the updating of a client by id'
+ operationId: updateClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ - name: id
+ in: path
+ description: 'The Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ requestBody:
+ description: Client object that needs to be updated
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ClientRequest'
+ responses:
+ 200:
+ description: 'Returns the client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ delete:
+ tags:
+ - clients
+ summary: 'Delete client'
+ description: 'Handles the deletion of a client by id'
+ operationId: deleteClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ - name: id
+ in: path
+ description: 'The Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: 'Returns a HTTP status'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ '/api/v1/clients/{id}/edit':
+ get:
+ tags:
+ - clients
+ summary: 'Edit Client'
+ description: 'Displays a client by id, essentially an alias of the show route'
+ operationId: editClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/include'
+ - name: id
+ in: path
+ description: 'The Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: 'Returns the client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ /api/v1/clients/create:
+ get:
+ tags:
+ - clients
+ summary: 'Blank Client'
+ description: 'Returns a blank object with default values'
+ operationId: getClientsCreate
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ responses:
+ 200:
+ description: 'A blank client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ /api/v1/clients/bulk:
+ post:
+ tags:
+ - clients
+ summary: 'Bulk client actions'
+ description: |
+ Bulk actions allow to make changes to multiple clients in a single request the following actions are supported
+
+ - archive
+ - restore
+ - delete
+ - template _requires template,template_id properties also_
+ - assign_group _requires group_settings_id also_
+ - bulk_update _ requires column,new_value also_
+
+ All of these actions require an array of client ids to perform the requested action on ie.
+
+ "ids":['id1','id2']
+
+ actions such as template, assign_group and bulk_update also require additional properties to be passed in the request
+
+ - template
+
+ The template bulk action allows the creation of a custom template using the provided template_id to be run against the array of clients provided.
+
+ - assign_group
+
+ Allows the setting of multiple clients to a single group
+
+ - bulk_update
+
+ Allows updating certain columns on the client model in bulk. the current list of supported columns that can be updated archived_at:
+
+ - public_notes
+ - industry_id
+ - size_id
+ - country_id
+ - custom_value1
+ - custom_value2
+ - custom_value3
+ - custom_value4
+
+ operationId: bulkClients
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/index'
+ requestBody:
+ description: 'Bulk action array'
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/GenericBulkAction'
+
+ responses:
+ 200:
+ description: 'The Client list Response of the updated clients that were bulk updated'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ '/api/v1/clients/{id}/upload':
+ post:
+ tags:
+ - clients
+ summary: 'Add client document'
+ description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST'
+ operationId: uploadClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ - name: id
+ in: path
+ description: 'The Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ requestBody:
+ required: true
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ _method:
+ type: string
+ example: POST
+ documents:
+ type: array
+ items:
+ format: binary
+ responses:
+ 200:
+ description: 'Returns the client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ '/api/v1/clients/{id}/purge':
+ post:
+ tags:
+ - clients
+ summary: 'Purge client'
+ description: |
+ Handles purging a client.
+
+ Please note this is a destructive action.
+
+ This action will remove all data associated with the client and cannot be undone.
+ operationId: purgeClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/X-API-PASSWORD'
+ - $ref: '#/components/parameters/client_include'
+ - name: id
+ in: path
+ description: 'The Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: 'Returns the client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ '/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge':
+ post:
+ tags:
+ - clients
+ summary: 'Merge client'
+ description: |
+ Handles merging 2 clients
+
+ The id parameter is the client that will be the primary client after the merge has completed.
+
+ The mergeable_client_hashed_id is the client that will be merged into the primary client, this clients records will be updated and associated with the primary client.
+ operationId: mergeClient
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/client_include'
+ - $ref: '#/components/parameters/X-API-PASSWORD'
+ - name: id
+ in: path
+ description: 'The Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ - name: mergeable_client_hashed_id
+ in: path
+ description: 'The Mergeable Client Hashed ID'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: D2J234DFA
+ responses:
+ 200:
+ description: 'Returns the client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ default:
+ $ref: '#/components/responses/default'
+ /api/v1/client_statement:
+ post:
+ tags:
+ - clients
+ summary: 'Client statement PDF'
+ description: 'Return a PDF of the client statement'
+ operationId: clientStatement
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/include'
+ requestBody:
+ description: 'Statement Options'
+ required: true
+ content:
+ application/json:
+ schema:
+ properties:
+ start_date:
+ description: 'The start date of the statement period - format Y-m-d'
+ type: string
+ end_date:
+ description: 'The start date of the statement period - format Y-m-d'
+ type: string
+ client_id:
+ description: 'The hashed ID of the client'
+ type: string
+ show_payments_table:
+ description: 'Flag which determines if the payments table is shown'
+ type: boolean
+ show_credits_table:
+ description: 'Flag which determines if the credits table is shown'
+ type: boolean
+ show_aging_table:
+ description: 'Flag which determines if the aging table is shown'
+ type: boolean
+ type: object
+ responses:
+ 200:
+ description: 'Returns the client object'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Client'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: '#/components/responses/default'
+ /api/v1/reactivate_email/{bounce_id}:
+ post:
+ tags:
+ - clients
+ summary: 'Removes email suppression of a user in the system'
+ description: '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
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/include'
+ - name: bounce_id
+ in: path
+ description: 'The postmark Bounce ID reference'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: 123243
+ responses:
+ 200:
+ description: 'Success'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ 400:
+ description: 'Postmark exception - generated if the suppression cannot be removed for any reason'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: '#/components/responses/default'
+ /api/v1/clients/{client}/updateTaxData:
+ post:
+ tags:
+ - clients
+ summary: 'Update tax data'
+ description: 'Updates the clients tax data - if their address has changed'
+ operationId: updateClientTaxData
+ parameters:
+ - $ref: '#/components/parameters/X-API-TOKEN'
+ - $ref: '#/components/parameters/X-Requested-With'
+ - $ref: '#/components/parameters/include'
+ - name: client
+ in: path
+ description: 'The Client Hashed ID reference'
+ required: true
+ schema:
+ type: string
+ format: string
+ example: V2J234DFA
+ responses:
+ 200:
+ description: 'Success'
+ headers:
+ X-MINIMUM-CLIENT-VERSION:
+ $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
+ X-RateLimit-Remaining:
+ $ref: '#/components/headers/X-RateLimit-Remaining'
+ X-RateLimit-Limit:
+ $ref: '#/components/headers/X-RateLimit-Limit'
+ 400:
+ description: 'Postmark exception - generated if the suppression cannot be removed for any reason'
+ 401:
+ $ref: '#/components/responses/401'
+ 403:
+ $ref: '#/components/responses/403'
+ 422:
+ $ref: '#/components/responses/422'
+ 429:
+ $ref: '#/components/responses/429'
+ 5XX:
+ description: 'Server error'
+ default:
+ $ref: '#/components/responses/default'
/api/v1/purchase_orders:
get:
tags:
@@ -14049,21 +13952,69 @@ paths:
description: 'Server error'
default:
$ref: "#/components/responses/default"
- /api/v1/tasks:
+ /api/v1/products:
get:
tags:
- - 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"
- operationId: getTasks
+ - products
+ summary: "List products"
+ x-codeSamples:
+ - lang: curl
+ label: Curl
+ source: |
+ curl -X GET 'https://invoicing.co/api/v1/products?filter=search&per_page=20&page=1&include=documents' \
+ -H "X-API-TOKEN:company-token-test" \
+ -H "X-Requested-With: XMLHttpRequest";
+ - lang: go
+ label: PHP
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $products = $ninja->products->all([
+ 'filter' => 'search',
+ 'per_page' => 20,
+ 'page' => 1,
+ 'include' => 'documents'
+ ]);
+ description: |
+ Lists products within your company.
+
+ You can search and filter the result set using query parameters. These can be chained together allowing fine grained lists to be generated.
+
+ operationId: getProducts
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- - $ref: "#/components/parameters/index"
+ - $ref: "#/components/parameters/status"
+ - $ref: "#/components/parameters/client_id"
+ - $ref: "#/components/parameters/created_at"
+ - $ref: "#/components/parameters/updated_at"
+ - $ref: "#/components/parameters/is_deleted"
+ - $ref: "#/components/parameters/filter_deleted_clients"
+ - $ref: "#/components/parameters/vendor_id"
+ - name: filter
+ in: query
+ description: Filter by product name
+ required: false
+ schema:
+ type: string
+ example: bob
+ - name: product_key
+ in: query
+ description: Filter by product key
+ required: false
+ schema:
+ type: string
+ example: bob
+ - name: sort
+ in: query
+ description: Returns the list sorted by column in ascending or descending order.
+ required: false
+ schema:
+ type: string
+ example: id|desc product_key|desc
responses:
200:
- description: "A list of tasks"
+ description: "A list of products"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14079,14 +14030,14 @@ paths:
data:
type: array
items:
- $ref: '#/components/schemas/Task'
+ $ref: '#/components/schemas/Product'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14094,20 +14045,46 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
+ $ref: '#/components/responses/default'
post:
tags:
- - tasks
- summary: "Create task"
- description: "Adds an task to a company"
- operationId: storeTask
+ - products
+ summary: "Create Product"
+ x-codeSamples:
+ - lang: curl
+ label: Curl
+ source: |
+ curl -X POST 'https://invoicing.co/api/v1/products' \
+ -H "X-API-TOKEN:company-token-test" \
+ -H "Content-Type:application/json" \
+ -d '{"product_key":"sku_1","notes":"product description","cost":1,"price":10}' \
+ -H "X-Requested-With: XMLHttpRequest";
+ - lang: go
+ label: PHP
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $products = $ninja->products->create([
+ 'product_key' => "sku_1",
+ 'notes' => "product description",
+ 'cost' => 1,
+ 'price' => 10
+ ]);
+ description: "Adds a product to a company"
+ operationId: storeProduct
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
+ requestBody:
+ description: Product object that needs to be added to the company
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ProductRequest'
responses:
200:
- description: "Returns the saved task object"
+ description: "Returns the saved product object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14118,11 +14095,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Task"
+ $ref: "#/components/schemas/Product"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14130,21 +14107,33 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
- "/api/v1/tasks/{id}":
+ $ref: '#/components/responses/default'
+ "/api/v1/products/{id}":
get:
tags:
- - tasks
- summary: "Show task"
- description: "Displays a task by id"
- operationId: showTask
+ - products
+ summary: "Show product"
+ x-codeSamples:
+ - lang: curl
+ label: Curl
+ source: |
+ curl -X GET 'https://invoicing.co/api/v1/products/{id}' \
+ -H "X-API-TOKEN:company-token-test" \
+ -H "X-Requested-With: XMLHttpRequest";
+ - lang: php
+ label: PHP
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $product = $ninja->products->get("{id}");
+ description: "Displays a product by id"
+ operationId: showProduct
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Task Hashed ID"
+ description: "The Product Hashed ID"
required: true
schema:
type: string
@@ -14152,7 +14141,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the task object"
+ description: "Returns the product object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14163,11 +14152,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Task"
+ $ref: "#/components/schemas/Product"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14175,28 +14164,56 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
+ $ref: '#/components/responses/default'
put:
tags:
- - tasks
- summary: "Update task"
- description: "Handles the updating of a task by id"
- operationId: updateTask
+ - products
+ summary: "Update product"
+ x-codeSamples:
+ - lang: curl
+ label: Curl
+ source: |
+ curl -X PUT 'https://invoicing.co/api/v1/products/{id}' \
+ -H "X-API-TOKEN:company-token-test" \
+ -H "Content-Type: application/json" \
+ -d '{
+ "product_key": "Updated Product",
+ "price": 150.0,
+ "notes": "An updated description of the product"
+ }'
+ - lang: go
+ label: PHP
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $product = $ninja->products->update("id", [
+ "name" => "Updated Product",
+ "price" => 150.0,
+ "description" => "An updated description of the product"
+ ]);
+ description: "Handles the updating of a product by id"
+ operationId: updateProduct
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The task Hashed ID"
+ description: "The Product Hashed ID"
required: true
schema:
type: string
format: string
example: D2J234DFA
+ requestBody:
+ description: Product object that needs to be added to the company
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ProductRequest'
responses:
200:
- description: "Returns the task object"
+ description: "Returns the Product object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14207,11 +14224,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Task"
+ $ref: "#/components/schemas/Product"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14219,20 +14236,32 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
+ $ref: '#/components/responses/default'
delete:
tags:
- - tasks
- summary: "Delete task"
- description: "Handles the deletion of a task by id"
- operationId: deleteTask
+ - products
+ summary: "Delete product"
+ x-codeSamples:
+ - lang: curl
+ label: Curl
+ source: |
+ curl -X DELETE 'https://invoicing.co/api/v1/products/{id}' \
+ -H "X-API-TOKEN:company-token-test" \
+ -H "X-Requested-With: XMLHttpRequest";
+ - lang: go
+ label: PHP
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $ninja->products->bulk("delete", "id");
+ description: "Handles the deletion of a product by id"
+ operationId: deleteProduct
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Task Hashed ID"
+ description: "The Product Hashed ID"
required: true
schema:
type: string
@@ -14249,9 +14278,9 @@ paths:
X-RateLimit-Limit:
$ref: "#/components/headers/X-RateLimit-Limit"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14259,21 +14288,33 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
- "/api/v1/tasks/{id}/edit":
+ $ref: '#/components/responses/default'
+ "/api/v1/products/{id}/edit":
get:
tags:
- - tasks
- summary: "Edit task"
- description: "Displays a task by id"
- operationId: editTask
+ - products
+ summary: "Edit product"
+ x-codeSamples:
+ - lang: curl
+ label: Curl
+ source: |
+ curl -X GET 'https://invoicing.co/api/v1/products/{id}/edit' \
+ -H "X-API-TOKEN:company-token-test" \
+ -H "X-Requested-With: XMLHttpRequest";
+ - lang: php
+ label: PHP
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $product = $ninja->products->get("{id}");
+ description: "Displays an Product by id"
+ operationId: editProduct
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
- name: id
in: path
- description: "The Task Hashed ID"
+ description: "The Product Hashed ID"
required: true
schema:
type: string
@@ -14281,7 +14322,7 @@ paths:
example: D2J234DFA
responses:
200:
- description: "Returns the client object"
+ description: "Returns the Product object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14292,11 +14333,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Task"
+ $ref: "#/components/schemas/Product"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14304,21 +14345,21 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
- /api/v1/tasks/create:
+ $ref: '#/components/responses/default'
+ "/api/v1/products/create":
get:
tags:
- - tasks
- summary: "Blank task"
- description: "Returns a blank task with default values"
- operationId: getTasksCreate
+ - products
+ summary: "Blank product"
+ description: "Returns a blank product object with default values"
+ operationId: getProductsCreate
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/include"
responses:
200:
- description: "A blank task object"
+ description: "A blank Product object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14329,11 +14370,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Task"
+ $ref: "#/components/schemas/Product"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14341,32 +14382,43 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
- /api/v1/tasks/bulk:
+ $ref: '#/components/responses/default'
+
+ /api/v1/products/bulk:
post:
tags:
- - tasks
- summary: "Bulk task actions"
- description: ""
- operationId: bulkTasks
+ - products
+ summary: "Bulk product actions"
+ x-codeSamples:
+ - lang: curl
+ label: Curl
+ source: |
+ curl -X GET 'https://invoicing.co/api/v1/products/bulk' \
+ -H "Content-Type:application/json" \
+ -d '{"action":"archive","ids":["id","id2"]}' \
+ -H "X-API-TOKEN:company-token-test" \
+ -H "X-Requested-With: XMLHttpRequest";
+ - lang: php
+ label: PHP
+ source: |
+ $ninja = new InvoiceNinja("your_token");
+ $product = $ninja->products->bulk("action", ["id","id2"]);
+ description: "Archive / Restore / Delete / Set tax id in bulk"
+ operationId: bulkProducts
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- $ref: "#/components/parameters/index"
requestBody:
- description: "User credentials"
+ description: 'Bulk action array'
required: true
content:
application/json:
schema:
- type: array
- items:
- description: "Array of hashed IDs to be bulk 'actioned"
- type: integer
- example: "[0,1,2,3]"
+ $ref: '#/components/schemas/ProductBulkAction'
responses:
200:
- description: "The Task User response"
+ description: "The Product response"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14377,11 +14429,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Task"
+ $ref: "#/components/schemas/Product"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14389,28 +14441,28 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
- "/api/v1/tasks/{id}/upload":
+ $ref: '#/components/responses/default'
+
+ "/api/v1/products/{id}/upload":
post:
tags:
- - tasks
- summary: "Uploads a task document"
- description: "Handles the uploading of a document to a task"
- operationId: uploadTask
+ - products
+ summary: "Add product document"
+ description: "Handles the uploading of a document to a product"
+ operationId: uploadProduct
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
- $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
+ - $ref: "#/components/parameters/client_include"
- name: id
in: path
- description: "The Task Hashed ID"
+ description: "The Product Hashed ID"
required: true
schema:
type: string
format: string
example: D2J234DFA
requestBody:
- description: "File Upload Body"
required: true
content:
multipart/form-data:
@@ -14419,16 +14471,14 @@ paths:
properties:
_method:
type: string
- example: PUT
+ example: POST
documents:
type: array
items:
- description: "Array of binary documents for upload"
- type: string
format: binary
responses:
200:
- description: "Returns the Task object"
+ description: "Returns the Product object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@@ -14439,11 +14489,11 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/Task"
+ $ref: "#/components/schemas/Product"
401:
- $ref: "#/components/responses/401"
+ $ref: '#/components/responses/401'
403:
- $ref: "#/components/responses/403"
+ $ref: '#/components/responses/403'
422:
$ref: '#/components/responses/422'
429:
@@ -14451,40 +14501,8 @@ paths:
5XX:
description: 'Server error'
default:
- $ref: "#/components/responses/default"
- /api/v1/tasks/sort:
- post:
- tags:
- - tasks
- summary: "Sort tasks on KanBan"
- description: "Sorts tasks after drag and drop on the KanBan."
- operationId: sortTasks
- parameters:
- - $ref: "#/components/parameters/X-API-TOKEN"
- - $ref: "#/components/parameters/X-Requested-With"
- - $ref: "#/components/parameters/include"
- responses:
- 200:
- description: "Returns an Ok, 200 HTTP status"
- headers:
- X-MINIMUM-CLIENT-VERSION:
- $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
- X-RateLimit-Remaining:
- $ref: "#/components/headers/X-RateLimit-Remaining"
- X-RateLimit-Limit:
- $ref: "#/components/headers/X-RateLimit-Limit"
- 401:
- $ref: "#/components/responses/401"
- 403:
- $ref: "#/components/responses/403"
- 422:
- $ref: '#/components/responses/422'
- 429:
- $ref: '#/components/responses/429'
- 5XX:
- description: 'Server error'
- default:
- $ref: "#/components/responses/default"
+ $ref: '#/components/responses/default'
+
components:
headers:
X-MINIMUM-CLIENT-VERSION:
@@ -14579,19 +14597,6 @@ components:
# - prev: null
# - next: null
responses:
- 500:
- description: 'Gateway Error'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error'
- 403:
- description: 'Authorization error'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AuthorizationError'
-
default:
description: 'Unexpected Error'
content:
@@ -14604,24 +14609,31 @@ components:
application/json:
schema:
$ref: '#/components/schemas/RateLimiterError'
- 422:
- description: 'Validation error'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ValidationError'
- 401:
- description: 'Authentication error'
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AuthenticationError'
400:
description: 'Invalid user input'
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidInputError'
+
+ 401:
+ description: 'Authentication error'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthenticationError'
+ 403:
+ description: 'Authorization error'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/AuthorizationError'
+ 422:
+ description: 'Validation error'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ValidationError'
parameters:
X-API-SECRET:
name: X-API-SECRET
@@ -15205,193 +15217,873 @@ components:
type: string
example: JSON
type: object
- Credit:
+ Meta:
+ properties:
+ pagination:
+ $ref: '#/components/schemas/Pagination'
+ Pagination:
+ type: object
+ properties:
+ total:
+ type: integer
+ description: 'The total number of items'
+ example: 1
+ readOnly: true
+ count:
+ type: integer
+ description: 'The number of items per page'
+ example: 1
+ readOnly: true
+ per_page:
+ type: integer
+ description: 'The number of items per page'
+ example: 1
+ readOnly: true
+ current_page:
+ type: integer
+ description: 'The current page number'
+ example: 1
+ readOnly: true
+ total_pages:
+ type: integer
+ description: 'The total number of pages'
+ example: 1
+ readOnly: true
+ links:
+ type: object
+ description: 'The pagination links'
+ readOnly: true
+ Document:
properties:
id:
- description: "The unique hashed ID of the credit"
+ description: 'The document hashed id'
+ type: string
+ example: AS3df3A
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: ''
+ assigned_user_id:
+ description: 'The assigned user hashed id'
+ type: string
+ example: ''
+ project_id:
+ description: 'The project associated with this document'
+ type: string
+ example: ''
+ vendor_id:
+ description: 'The vendor associated with this documents'
+ type: string
+ example: ''
+ name:
+ description: 'The document name'
+ type: string
+ example: Beauty
+ url:
+ description: 'The document url'
+ type: string
+ example: Beauty
+ preview:
+ description: 'The document preview url'
+ type: string
+ example: Beauty
+ type:
+ description: 'The document type'
+ type: string
+ example: Beauty
+ disk:
+ description: 'The document disk'
+ type: string
+ example: Beauty
+ hash:
+ description: 'The document hashed'
+ type: string
+ example: Beauty
+ is_deleted:
+ description: 'Flag to determine if the document is deleted'
+ type: boolean
+ example: true
+ is_default:
+ description: 'Flag to determine if the document is a default doc'
+ type: boolean
+ example: true
+ created_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ deleted_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ type: object
+ Error:
+ properties:
+ message:
+ description: 'Something terrible went wrong'
+ type: string
+ example: 'Unexpected error'
+ code:
+ description: 'The HTTP error code, ie 5xx 4xx'
+ type: integer
+ example: '500'
+ type: object
+ InvoiceItem:
+ type: object
+ properties:
+ quantity:
+ type: number
+ example: 1
+ description: 'The quantity of the product offered for this line item'
+ cost:
+ type: number
+ format: float
+ example: 10.00
+ description: 'The cost of the product offered for this line item'
+ product_key:
+ type: string
+ example: 'Product key'
+ description: 'The product key of the product offered for this line item (Referred to as Product in the product tab)'
+ product_cost:
+ type: number
+ format: float
+ example: 10.00
+ description: 'The cost of the product offered for this line item (Referred to as Cost in the product tab)'
+ notes:
+ type: string
+ example: 'Item notes'
+ description: 'The notes/description for the product offered for this line item'
+ discount:
+ type: number
+ format: float
+ example: 5.00
+ description: 'The discount applied to the product offered for this line item'
+ is_amount_discount:
+ type: boolean
+ example: false
+ description: 'Indicates whether the discount applied to the product offered for this line item is a fixed amount or a percentage'
+ tax_name1:
+ type: string
+ example: 'GST'
+ description: 'The name of the first tax applied to the product offered for this line item'
+ tax_rate1:
+ type: number
+ format: float
+ example: 10.00
+ description: 'The rate of the first tax applied to the product offered for this line item'
+ tax_name2:
+ type: string
+ example: 'VAT'
+ description: 'The name of the second tax applied to the product offered for this line item'
+ tax_rate2:
+ type: number
+ format: float
+ example: 5.00
+ description: 'The rate of the second tax applied to the product offered for this line item'
+ tax_name3:
+ type: string
+ example: 'CA Sales Tax'
+ description: 'The name of the third tax applied to the product offered for this line item'
+ tax_rate3:
+ type: number
+ format: float
+ example: 3.00
+ description: 'The rate of the third tax applied to the product offered for this line item'
+ sort_id:
+ type: string
+ example: '0'
+ description: 'Deprecated'
+ deprecated: true
+ line_total:
+ type: number
+ format: float
+ example: 10.00
+ description: 'The total amount of the product offered for this line item'
+ readOnly: true
+ gross_line_total:
+ type: number
+ format: float
+ example: 15.00
+ description: 'The total amount of the product offered for this line item before discounts'
+ readOnly: true
+ tax_amount:
+ type: number
+ format: float
+ example: 1.00
+ description: 'The total amount of tax applied to the product offered for this line item'
+ readOnly: true
+ date:
+ type: string
+ format: date-time
+ example: '2023-03-19T00:00:00Z'
+ description: 'Deprecated'
+ deprecated: true
+ custom_value1:
+ type: string
+ example: 'Custom value 1'
+ description: 'The first custom value of the product offered for this line item'
+ custom_value2:
+ type: string
+ example: 'Custom value 2'
+ description: 'The second custom value of the product offered for this line item'
+ custom_value3:
+ type: string
+ example: 'Custom value 3'
+ description: 'The third custom value of the product offered for this line item'
+ custom_value4:
+ type: string
+ example: 'Custom value 4'
+ description: 'The fourth custom value of the product offered for this line item'
+ type_id:
+ type: string
+ example: '1'
+ description: '1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense'
+ default: '1'
+ tax_id:
+ type: string
+ example: '1'
+ default: '1'
+ description: 'The tax ID of the product: 1 product, 2 service, 3 digital, 4 shipping, 5 exempt, 5 reduced tax, 7 override, 8 zero rate, 9 reverse tax'
+ ExpenseCategory:
+ properties:
+ id:
+ description: 'The expense hashed id'
+ type: string
+ example: Opnel5aKBz
+ name:
+ description: 'The expense category name'
+ type: string
+ example: Accounting
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: XS987sD
+ is_deleted:
+ description: 'Flag determining whether the expense category has been deleted'
+ type: boolean
+ example: true
+ updated_at:
+ description: 'The updated at timestamp'
+ type: integer
+ example: '2'
+ created_at:
+ description: 'The created at timestamp'
+ type: integer
+ example: '2'
+ type: object
+ Client:
+ properties:
+ id:
+ description: 'The unique identifier of the client'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ contacts:
+ type: array
+ items:
+ $ref: '#/components/schemas/ClientContact'
+ user_id:
+ description: 'The unique identifier of the user who created the client'
+ type: string
+ example: Ua6Rw4pVbS
+ readOnly: true
+ assigned_user_id:
+ description: 'The unique identifier of the user who has been assigned the client'
+ type: string
+ example: Ua6Rw4pVbS
+ name:
+ description: 'The name of the client company or organization'
+ type: string
+ example: "Jim's Housekeeping"
+ website:
+ description: 'The website URL of the client company or organization'
+ type: string
+ example: 'https://www.jims-housekeeping.com'
+ private_notes:
+ description: 'Notes that are only visible to the user who created the client'
+ type: string
+ example: 'Client prefers email communication over phone calls'
+ client_hash:
+ description: 'A unique hash value for the client'
+ type: string
+ example: asdfkjhk342hjhbfdvmnfb1
+ readOnly: true
+ industry_id:
+ description: 'The unique identifier of the industry the client operates in'
+ type: number
+ example: '5'
+ size_id:
+ description: 'The unique identifier for the size category of the client company or organization'
+ type: number
+ example: '2'
+ address1:
+ description: "First line of the client's address"
+ type: string
+ example: '123 Main St'
+ address2:
+ description: "Second line of the client's address, if needed"
+ type: string
+ example: 'Apt 4B'
+ city:
+ description: 'The city the client is located in'
+ type: string
+ example: 'Beverly Hills'
+ state:
+ description: 'The state, province, or locality the client is located in'
+ type: string
+ example: 'California'
+ postal_code:
+ description: 'The postal code or ZIP code of the client'
+ type: string
+ example: '90210'
+ phone:
+ description: "The client's phone number"
+ type: string
+ example: '555-3434-3434'
+ country_id:
+ description: "The unique identifier of the client's country"
+ type: number
+ format: integer
+ example: '1'
+ custom_value1:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'Preferred contact: Email'
+ custom_value2:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'Account manager: John Doe'
+ custom_value3:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'VIP client: Yes'
+ custom_value4:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'Annual contract value: $50,000'
+ vat_number:
+ description: "The client's VAT (Value Added Tax) number, if applicable"
+ type: string
+ example: 'VAT123456'
+ id_number:
+ description: 'A unique identification number for the client, such as a tax ID or business registration number'
+ type: string
+ number:
+ description: 'A system-assigned unique number for the client, typically used for invoicing purposes'
+ type: string
+ example: 'CL-0001'
+ shipping_address1:
+ description: "First line of the client's shipping address"
+ type: string
+ example: '5 Wallaby Way'
+ shipping_address2:
+ description: "Second line of the client's shipping address, if needed"
+ type: string
+ example: 'Suite 5'
+ shipping_city:
+ description: "The city of the client's shipping address"
+ type: string
+ example: 'Perth'
+ shipping_state:
+ description: "The state, province, or locality of the client's shipping address"
+ type: string
+ example: 'Western Australia'
+ shipping_postal_code:
+ description: "The postal code or ZIP code of the client's shipping address"
+ type: string
+ example: '6110'
+ shipping_country_id:
+ description: "The unique identifier of the country for the client's shipping address"
+ type: number
+ format: integer
+ example: '4'
+ is_deleted:
+ description: 'A boolean value indicating whether the client has been deleted or not'
+ type: boolean
+ example: false
+ readOnly: true
+ balance:
+ description: 'The outstanding balance the client owes'
+ type: number
+ format: float
+ example: '500.00'
+ readOnly: true
+ paid_to_date:
+ description: 'The total amount the client has paid to date'
+ type: number
+ format: float
+ example: '2000.00'
+ readOnly: true
+ credit_balance:
+ description: 'The available credit balance for the client to use on future purchases'
+ type: number
+ format: float
+ example: '100.00'
+ readOnly: true
+ last_login:
+ description: "The timestamp of the client's last login"
+ type: number
+ format: integer
+ example: '1628686031'
+ readOnly: true
+ created_at:
+ description: 'The timestamp when the client was created'
+ type: number
+ format: integer
+ example: '1617629031'
+ readOnly: true
+ updated_at:
+ description: 'The timestamp when the client was last updated'
+ type: number
+ format: integer
+ example: '1628445631'
+ readOnly: true
+ group_settings_id:
+ description: 'The group settings assigned to the client'
+ type: string
+ example: Opnel5aKBz
+ routing_id:
+ description: 'The routing address id for e-invoicing for this client'
+ type: string
+ example: Opnel5aKBz3489-dfkiu-2239-sdsd
+ is_tax_exempt:
+ description: 'Flag which defines if the client is exempt from taxes'
+ type: boolean
+ example: false
+ has_valid_vat_number:
+ description: 'Flag which defines if the client has a valid VAT number'
+ type: boolean
+ example: false
+ readOnly: true
+ payment_balance:
+ description: 'Defines the payment balance the client has on file (pre payments / over payments / unapplied amounts)'
+ type: number
+ example: 100
+ readOnly: true
+ settings:
+ $ref: '#/components/schemas/ClientSettings'
+ type: object
+ Quote:
+ properties:
+ id:
+ description: 'The unique hashed identifier for the quote'
type: string
example: Opnel5aKBz
user_id:
- description: "The unique hashed ID of the user associated with the credit"
+ description: 'The unique hashed identifier for the user who created the quote'
type: string
- example: 1a2b3c4d5e
+ example: ''
assigned_user_id:
- description: "The unique hashed ID of the assigned user responsible for the credit"
+ description: 'The unique hashed identifier for the user assigned to the quote'
type: string
- example: 6f7g8h9i0j
+ example: ''
client_id:
- description: "The unique hashed ID of the client associated with the credit"
+ description: 'The unique hashed identifier for the client associated with the quote'
type: string
- example: p1q2r3s4t5
+ example: ''
status_id:
- description: "The ID representing the current status of the credit"
+ description: 'The status of the quote represented by a unique identifier'
type: string
- example: 3
- invoice_id:
- description: "The unique hashed ID of the linked invoice to which the credit is applied"
- type: string
- example: u1v2w3x4y5
+ example: ''
number:
- description: "The unique alphanumeric credit number per company"
+ description: 'The unique alpha-numeric quote number for the quote per company'
type: string
example: QUOTE_101
po_number:
- description: "The purchase order number referred to by the credit"
+ description: 'The purchase order number associated with the quote'
type: string
- example: PO_12345
+ example: PO-1234
terms:
- description: "The terms associated with the credit"
+ description: 'The terms and conditions for the quote'
type: string
- example: "Net 30"
+ example: 'These are some quote terms. Valid for 14 days.'
public_notes:
- description: "Public notes for the credit"
+ description: 'Publicly visible notes associated with the quote'
type: string
- example: "Thank you for your business."
+ example: 'These are public notes which the client may see'
private_notes:
- description: "Private notes for internal use, not visible to the client"
+ description: 'Privately visible notes associated with the quote, not disclosed to the client'
type: string
- example: "Client is requesting a discount."
+ example: 'These are private notes, not to be disclosed to the client'
footer:
- description: "The footer text for the credit"
+ description: 'The footer text of the quote'
type: string
- example: "Footer text goes here."
+ example: 'The text goes in the footer of the quote'
custom_value1:
- description: "Custom value 1 for additional credit information"
+ description: 'First custom value field for additional information'
type: string
- example: "Custom data 1"
+ example: 'A custom value'
custom_value2:
- description: "Custom value 2 for additional credit information"
+ description: 'Second custom value field for additional information'
type: string
- example: "Custom data 2"
+ example: 'A custom value'
custom_value3:
- description: "Custom value 3 for additional credit information"
+ description: 'Third custom value field for additional information'
type: string
- example: "Custom data 3"
+ example: 'A custom value'
custom_value4:
- description: "Custom value 4 for additional credit information"
+ description: 'Fourth custom value field for additional information'
type: string
- example: "Custom data 4"
+ example: 'A custom value'
tax_name1:
- description: "The name of the first tax applied to the credit"
+ description: 'The name of the first tax applied to the quote'
type: string
- example: "VAT"
+ example: GST
tax_name2:
- description: "The name of the second tax applied to the credit"
+ description: 'The name of the second tax applied to the quote'
type: string
- example: "GST"
+ example: VAT
tax_rate1:
- description: "The rate of the first tax applied to the credit"
+ description: 'The rate of the first tax applied to the quote'
type: number
format: float
example: 10.00
tax_rate2:
- description: "The rate of the second tax applied to the credit"
+ description: 'The rate of the second tax applied to the quote'
type: number
format: float
- example: 5.00
+ example: 10.00
tax_name3:
- description: "The name of the third tax applied to the credit"
+ description: 'The name of the third tax applied to the quote'
type: string
- example: "PST"
+ example: ''
tax_rate3:
- description: "The rate of the third tax applied to the credit"
+ description: 'The rate of the third tax applied to the quote'
type: number
format: float
- example: 8.00
+ example: 10.00
total_taxes:
- description: "The total amount of taxes for the credit"
+ description: 'The total amount of taxes for the quote'
type: number
format: float
- example: 23.00
+ example: 10.00
line_items:
type: array
- description: 'An array of objects which define the line items of the credit'
+ description: 'An array of objects which define the line items of the quote'
items:
$ref: '#/components/schemas/InvoiceItem'
amount:
- description: "The total amount of the credit"
+ description: 'The total amount of the quote before taxes and discounts'
type: number
format: float
- example: 100.00
+ example: 10.00
balance:
- description: "The outstanding balance of the credit"
+ description: 'The balance due for the quote after accounting for payments'
type: number
format: float
- example: 50.00
+ example: 10.00
paid_to_date:
- description: "The total amount paid to date for the credit"
+ description: 'The total amount paid on the quote so far'
type: number
format: float
- example: 50.00
+ example: 10.00
discount:
- description: "The discount applied to the credit"
+ description: 'The discount amount or percentage applied to the quote'
type: number
format: float
example: 10.00
partial:
- description: "The partial amount applied to the credit"
+ description: 'The partial or deposit amount for the quote'
type: number
format: float
- example: 20.00
+ example: 10.00
is_amount_discount:
- description: "Indicates whether the discount applied is a fixed amount or a percentage"
+ description: 'Boolean flag indicating if the discount is a fixed amount or a percentage'
type: boolean
example: true
is_deleted:
- description: "Indicates whether the credit has been deleted"
+ description: 'Boolean flag indicating if the quote has been deleted'
type: boolean
example: false
uses_inclusive_taxes:
- description: "Indicates whether the tax rates applied to the credit are inclusive or exclusive"
+ description: 'Boolean flag indicating if the taxes used are inclusive or exclusive'
type: boolean
example: true
date:
- description: "The date the credit was issued"
+ description: 'The date the quote was created'
type: string
format: date
- example: "1994-07-30"
+ example: '1994-07-30'
last_sent_date:
- description: "The date the credit was last sent out"
+ description: 'The last date the quote was sent to the client'
type: string
format: date
- example: "1994-07-30"
+ example: '1994-07-30'
next_send_date:
- description: "The next scheduled date for sending a credit reminder"
+ description: 'The next scheduled date for sending a reminder for the quote'
type: string
format: date
- example: "1994-07-30"
+ example: '1994-07-30'
partial_due_date:
- description: "The due date for the partial amount of the credit"
+ description: 'The due date for the partial or deposit amount'
type: string
format: date
- example: "1994-07-30"
+ example: '1994-07-30'
due_date:
- description: "The due date for the total amount of the credit"
+ description: 'The due date for the total amount of the quote'
type: string
format: date
- example: "1994-07-30"
+ example: '1994-07-30'
settings:
- $ref: "#/components/schemas/CompanySettings"
+ $ref: '#/components/schemas/CompanySettings'
last_viewed:
- description: "The timestamp of the last time the credit was viewed"
+ description: 'The timestamp of the last time the quote was viewed'
type: number
format: integer
example: 1434342123
updated_at:
- description: "The timestamp of the last time the credit was updated"
+ description: 'The timestamp of the last update to the quote'
type: number
format: integer
example: 1434342123
archived_at:
- description: "The timestamp of the last time the credit was archived"
+ description: 'The timestamp of when the quote was archived'
type: number
format: integer
example: 1434342123
custom_surcharge1:
- description: "First custom surcharge amount"
+ description: 'First custom surcharge amount for the quote'
type: number
format: float
example: 10.00
+ custom_surcharge2:
+ description: 'Second custom surcharge amount for the quote'
+ type: number
+ format: float
+ example: 10.00
+ custom_surcharge3:
+ description: 'Third custom surcharge amount for the quote'
+ type: number
+ format: float
+ example: 10.00
+ custom_surcharge4:
+ description: 'Fourth custom surcharge amount for the quote'
+ type: number
+ format: float
+ example: 10.00
+ custom_surcharge_tax1:
+ description: 'Boolean flag indicating if taxes are charged on the first custom surcharge amount'
+ type: boolean
+ example: true
+ custom_surcharge_tax2:
+ description: 'Boolean flag indicating if taxes are charged on the second custom surcharge amount'
+ type: boolean
+ example: true
+ custom_surcharge_tax3:
+ description: 'Boolean flag indicating if taxes are charged on the third custom surcharge amount'
+ type: boolean
+ example: true
+ custom_surcharge_tax4:
+ description: 'Boolean flag indicating if taxes are charged on the fourth custom surcharge amount'
+ type: boolean
+ example: true
+ type: object
+ InvoiceRequest:
+ required:
+ - client_id
+ properties:
+ id:
+ description: 'The invoice hashed id'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: Opnel5aKBz
+ assigned_user_id:
+ description: 'The assigned user hashed id'
+ type: string
+ example: Opnel5aKBz
+ client_id:
+ description: 'The client hashed id'
+ type: string
+ example: Opnel5aKBz
+ status_id:
+ description: 'The invoice status variable'
+ type: string
+ example: '4'
+ readOnly: true
+ number:
+ description: 'The invoice number - is a unique alpha numeric number per invoice per company'
+ type: string
+ example: INV_101
+ po_number:
+ description: 'The purchase order associated with this invoice'
+ type: string
+ example: PO-1234
+ terms:
+ description: 'The invoice terms'
+ type: string
+ example: 'These are invoice terms'
+ public_notes:
+ description: 'The public notes of the invoice'
+ type: string
+ example: 'These are some public notes'
+ private_notes:
+ description: 'The private notes of the invoice'
+ type: string
+ example: 'These are some private notes'
+ footer:
+ description: 'The invoice footer notes'
+ type: string
+ example: ''
+ custom_value1:
+ description: 'A custom field value'
+ type: string
+ example: '2022-10-01'
+ custom_value2:
+ description: 'A custom field value'
+ type: string
+ example: 'Something custom'
+ custom_value3:
+ description: 'A custom field value'
+ type: string
+ example: ''
+ custom_value4:
+ description: 'A custom field value'
+ type: string
+ example: ''
+ tax_name1:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_name2:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_rate1:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_rate2:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_name3:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_rate3:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ total_taxes:
+ description: 'The total taxes for the invoice'
+ type: number
+ format: float
+ example: '10.00'
+ readOnly: true
+ line_items:
+ type: array
+ description: 'An array of objects which define the line items of the invoice'
+ items:
+ $ref: '#/components/schemas/InvoiceItem'
+ invitations:
+ type: array
+ description: 'An array of objects which define the invitations of the invoice'
+ items:
+ $ref: '#/components/schemas/InvoiceInvitationRequest'
+ amount:
+ description: 'The invoice amount'
+ type: number
+ format: float
+ example: '10.00'
+ readOnly: true
+ balance:
+ description: 'The invoice balance'
+ type: number
+ format: float
+ example: '10.00'
+ readOnly: true
+ paid_to_date:
+ description: 'The amount paid on the invoice to date'
+ type: number
+ format: float
+ example: '10.00'
+ readOnly: true
+ discount:
+ description: 'The invoice discount, can be an amount or a percentage'
+ type: number
+ format: float
+ example: '10.00'
+ partial:
+ description: 'The deposit/partial amount'
+ type: number
+ format: float
+ example: '10.00'
+ is_amount_discount:
+ description: 'Flag determining if the discount is an amount or a percentage'
+ type: boolean
+ example: true
+ is_deleted:
+ description: 'Defines if the invoice has been deleted'
+ type: boolean
+ example: true
+ readOnly: true
+ uses_inclusive_taxes:
+ description: 'Defines the type of taxes used as either inclusive or exclusive'
+ type: boolean
+ example: true
+ date:
+ description: 'The Invoice Date'
+ type: string
+ format: date
+ example: '1994-07-30'
+ last_sent_date:
+ description: 'The last date the invoice was sent out'
+ type: string
+ format: date
+ example: '1994-07-30'
+ readOnly: true
+ next_send_date:
+ description: 'The Next date for a reminder to be sent'
+ type: string
+ format: date
+ example: '1994-07-30'
+ readOnly: true
+ partial_due_date:
+ description: 'The due date for the deposit/partial amount'
+ type: string
+ format: date
+ example: '1994-07-30'
+ due_date:
+ description: 'The due date of the invoice'
+ type: string
+ format: date
+ example: '1994-07-30'
+ last_viewed:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ custom_surcharge1:
+ description: 'First Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
custom_surcharge2:
description: 'Second Custom Surcharge'
type: number
@@ -15423,21 +16115,10 @@ components:
description: 'Toggles charging taxes on custom surcharge amounts'
type: boolean
example: true
- type: object
-
- GenericBulkAction:
- properties:
- action:
+ project_id:
+ description: 'The project associated with this invoice'
type: string
- example: archive
- description: 'The action to perform ie. archive / restore / delete'
- ids:
- type: array
- items:
- format: string
- type: string
- example: 2J234DFA,D2J234DFA,D2J234DFA
- description: string array of client hashed ids
+ example: Opnel5aKBz
type: object
ProductRequest:
type: object
@@ -15599,274 +16280,517 @@ components:
```
example: '1'
- CompanyLedger:
- properties:
- entity_id:
- description: 'This field will reference one of the following entity hashed ID payment_id, invoice_id or credit_id'
- type: string
- example: AS3df3A
- notes:
- description: 'The notes which reference this entry of the ledger'
- type: string
- example: 'Credit note for invoice #3212'
- balance:
- description: 'The client balance'
- type: number
- format: float
- example: '10.00'
- adjustment:
- description: 'The amount the client balance is adjusted by'
- type: number
- format: float
- example: '10.00'
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- created_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- type: object
- Invoice:
+ InvoiceInvitationRequest:
+ required:
+ - client_contact_id
properties:
id:
- description: 'The invoice hashed id'
+ description: 'The entity invitation hashed id'
type: string
example: Opnel5aKBz
readOnly: true
+ client_contact_id:
+ description: 'The client contact hashed id'
+ type: string
+ example: Opnel5aKBz
+ key:
+ description: 'The invitation key'
+ type: string
+ example: Opnel5aKBz4343343566236gvbb
+ readOnly: true
+ link:
+ description: 'The invitation link'
+ type: string
+ example: 'https://www.example.com/invitations/Opnel5aKBz4343343566236gvbb'
+ readOnly: true
+ sent_date:
+ description: 'The invitation sent date'
+ type: string
+ format: date-time
+ readOnly: true
+ viewed_date:
+ description: 'The invitation viewed date'
+ type: string
+ format: date-time
+ readOnly: true
+ opened_date:
+ description: 'The invitation opened date'
+ type: string
+ format: date-time
+ readOnly: true
+ updated_at:
+ description: 'Timestamp'
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ archived_at:
+ description: 'Timestamp'
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ email_error:
+ description: 'The email error'
+ type: string
+ example: 'The email error'
+ readOnly: true
+ email_status:
+ description: 'The email status'
+ type: string
+ readOnly: true
+
+ BankIntegration:
+ properties:
+ id:
+ description: 'The bank integration hashed id'
+ type: string
+ example: AS3df3A
user_id:
description: 'The user hashed id'
type: string
+ example: AS3df3A
+ provider_bank_name:
+ description: 'The providers bank name'
+ type: string
+ example: 'Chase Bank'
+ bank_account_id:
+ description: 'The bank account id'
+ type: integer
+ example: '1233434'
+ bank_account_name:
+ description: 'The name of the account'
+ type: string
+ example: 'My Checking Acc'
+ bank_account_number:
+ description: 'The account number'
+ type: string
+ example: '111 234 2332'
+ bank_account_status:
+ description: 'The status of the bank account'
+ type: string
+ example: ACTIVE
+ bank_account_type:
+ description: 'The type of account'
+ type: string
+ example: CREDITCARD
+ balance:
+ description: 'The current bank balance if available'
+ type: number
+ example: '1000000'
+ currency:
+ description: 'iso_3166_3 code'
+ type: string
+ example: USD
+ type: object
+ CompanyToken:
+ properties:
+ name:
+ description: 'The token name'
+ type: string
+ example: 'Token Name'
+ token:
+ description: 'The token value'
+ type: string
+ example: AS3df3jUUH765fhfd9KJuidj3JShjA
+ is_system:
+ description: 'Determines whether the token is created by the system rather than a user'
+ type: boolean
+ example: 'true'
+ type: object
+ PurchaseOrder:
+ properties:
+ id:
+ description: 'The unique hashed identifier for the purchase order'
+ type: string
example: Opnel5aKBz
- readOnly: true
+ user_id:
+ description: 'The unique hashed identifier for the user who created the purchase order'
+ type: string
+ example: ''
assigned_user_id:
- description: 'The assigned user hashed id'
+ description: 'The unique hashed identifier for the user assigned to the purchase order'
type: string
- example: Opnel5aKBz
- client_id:
- description: 'The client hashed id'
+ example: ''
+ vendor_id:
+ description: 'The unique hashed identifier for the vendor associated with the purchase order'
type: string
- example: Opnel5aKBz
+ example: ''
status_id:
- description: 'The invoice status variable'
+ description: 'The status of the purchase order represented by a unique identifier'
type: string
- example: '4'
+ example: ''
number:
- description: 'The invoice number - is a unique alpha numeric number per invoice per company'
+ description: 'The unique alpha-numeric purchase order number per company'
type: string
- example: INV_101
- po_number:
- description: 'The purchase order associated with this invoice'
+ example: PO_101
+ quote_number:
+ description: 'The quote number associated with this purchase order'
type: string
- example: PO-1234
+ example: QUOTE_101
terms:
- description: 'The invoice terms'
+ description: 'The terms and conditions for the purchase order'
type: string
- example: 'These are invoice terms'
+ example: 'These are some purchase order terms. Valid for 14 days.'
public_notes:
- description: 'The public notes of the invoice'
+ description: 'Publicly visible notes associated with the purchase order'
type: string
- example: 'These are some public notes'
+ example: 'These are public notes which the vendor may see'
private_notes:
- description: 'The private notes of the invoice'
+ description: 'Privately visible notes associated with the purchase order, not disclosed to the vendor'
type: string
- example: 'These are some private notes'
+ example: 'These are private notes, not to be disclosed to the vendor'
footer:
- description: 'The invoice footer notes'
+ description: 'The footer text of the purchase order'
type: string
- example: ''
+ example: 'The text goes in the footer of the purchase order'
custom_value1:
- description: 'A custom field value'
+ description: 'First custom value field for additional information'
type: string
- example: '2022-10-01'
+ example: 'A custom value'
custom_value2:
- description: 'A custom field value'
+ description: 'Second custom value field for additional information'
type: string
- example: 'Something custom'
+ example: 'A custom value'
custom_value3:
- description: 'A custom field value'
+ description: 'Third custom value field for additional information'
type: string
- example: ''
+ example: 'A custom value'
custom_value4:
- description: 'A custom field value'
+ description: 'Fourth custom value field for additional information'
type: string
- example: ''
+ example: 'A custom value'
tax_name1:
- description: 'The tax name'
+ description: 'The name of the first tax applied to the purchase order'
type: string
- example: ''
+ example: GST
tax_name2:
- description: 'The tax name'
+ description: 'The name of the second tax applied to the purchase order'
type: string
- example: ''
+ example: VAT
tax_rate1:
- description: 'The tax rate'
+ description: 'The rate of the first tax applied to the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
tax_rate2:
- description: 'The tax rate'
+ description: 'The rate of the second tax applied to the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
tax_name3:
- description: 'The tax name'
+ description: 'The name of the third tax applied to the purchase order'
type: string
example: ''
tax_rate3:
- description: 'The tax rate'
+ description: 'The rate of the third tax applied to the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
total_taxes:
- description: 'The total taxes for the invoice'
+ description: 'The total amount of taxes applied to the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
line_items:
type: array
- description: 'An array of objects which define the line items of the invoice'
+ description: 'An array of objects which define the line items of the purchase order'
items:
$ref: '#/components/schemas/InvoiceItem'
- invitations:
- type: array
- description: 'An array of objects which define the invitations of the invoice'
- items:
- $ref: '#/components/schemas/InvoiceInvitation'
amount:
- description: 'The invoice amount'
+ description: 'The total amount of the purchase order before taxes and discounts'
type: number
format: float
- example: '10.00'
+ example: 10.00
balance:
- description: 'The invoice balance'
+ description: 'The balance due for the purchase order after accounting for payments'
type: number
format: float
- example: '10.00'
+ example: 10.00
paid_to_date:
- description: 'The amount paid on the invoice to date'
+ description: 'The total amount paid on the purchase order so far'
type: number
format: float
- example: '10.00'
+ example: 10.00
discount:
- description: 'The invoice discount, can be an amount or a percentage'
+ description: 'The discount amount or percentage applied to the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
partial:
- description: 'The deposit/partial amount'
+ description: 'The partial or deposit amount for the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
is_amount_discount:
- description: 'Flag determining if the discount is an amount or a percentage'
+ description: 'Boolean flag indicating if the discount is a fixed amount or a percentage'
type: boolean
example: true
is_deleted:
- description: 'Defines if the invoice has been deleted'
+ description: 'Boolean flag indicating if the purchase order has been deleted'
type: boolean
- example: true
+ example: false
uses_inclusive_taxes:
- description: 'Defines the type of taxes used as either inclusive or exclusive'
+ description: 'Boolean flag indicating if the taxes used are inclusive or exclusive'
type: boolean
example: true
date:
- description: 'The Invoice Date'
+ description: 'The date the purchase order was created'
type: string
format: date
example: '1994-07-30'
last_sent_date:
- description: 'The last date the invoice was sent out'
+ description: 'The last date the purchase order was sent to the vendor'
type: string
format: date
example: '1994-07-30'
next_send_date:
- description: 'The Next date for a reminder to be sent'
+ description: 'The next scheduled date for sending a reminder for the purchase order'
type: string
format: date
example: '1994-07-30'
partial_due_date:
- description: 'The due date for the deposit/partial amount'
+ description: 'The due date for the partial or deposit amount'
type: string
format: date
example: '1994-07-30'
due_date:
- description: 'The due date of the invoice'
+ description: 'The due date for the total amount of the purchase order'
type: string
format: date
example: '1994-07-30'
+ settings:
+ $ref: '#/components/schemas/CompanySettings'
last_viewed:
description: Timestamp
type: number
format: integer
- example: '1434342123'
+ example: 1434342123
updated_at:
description: Timestamp
type: number
format: integer
- example: '1434342123'
+ example: 1434342123
archived_at:
description: Timestamp
type: number
format: integer
- example: '1434342123'
+ example: 1434342123
custom_surcharge1:
- description: 'First Custom Surcharge'
+ description: 'First custom surcharge amount for the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
custom_surcharge2:
- description: 'Second Custom Surcharge'
+ description: 'Second custom surcharge amount for the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
custom_surcharge3:
- description: 'Third Custom Surcharge'
+ description: 'Third custom surcharge amount for the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
custom_surcharge4:
- description: 'Fourth Custom Surcharge'
+ description: 'Fourth custom surcharge amount for the purchase order'
type: number
format: float
- example: '10.00'
+ example: 10.00
custom_surcharge_tax1:
- description: 'Toggles charging taxes on custom surcharge amounts'
+ description: 'Boolean flag indicating if taxes are charged on the first custom surcharge amount'
type: boolean
example: true
custom_surcharge_tax2:
- description: 'Toggles charging taxes on custom surcharge amounts'
+ description: 'Boolean flag indicating if taxes are charged on the second custom surcharge amount'
type: boolean
example: true
custom_surcharge_tax3:
- description: 'Toggles charging taxes on custom surcharge amounts'
+ description: 'Boolean flag indicating if taxes are charged on the third custom surcharge amount'
type: boolean
example: true
custom_surcharge_tax4:
- description: 'Toggles charging taxes on custom surcharge amounts'
+ description: 'Boolean flag indicating if taxes are charged on the fourth custom surcharge amount'
type: boolean
example: true
- project_id:
- description: 'The project associated with this invoice'
+ type: object
+
+
+ InvoiceInvitation:
+ properties:
+ id:
+ description: 'The entity invitation hashed id'
type: string
example: Opnel5aKBz
- auto_bill_tries:
- description: 'The number of times the invoice has attempted to be auto billed'
- type: integer
- example: '1'
readOnly: true
- auto_bill_enabled:
- description: 'Boolean flag determining if the invoice is set to auto bill'
- type: boolean
- example: true
- subscription_id:
- description: 'The subscription associated with this invoice'
+ client_contact_id:
+ description: 'The client contact hashed id'
type: string
example: Opnel5aKBz
-
+ key:
+ description: 'The invitation key'
+ type: string
+ example: Opnel5aKBz4343343566236gvbb
+ readOnly: true
+ link:
+ description: 'The invitation link'
+ type: string
+ example: 'https://www.example.com/invitations/Opnel5aKBz4343343566236gvbb'
+ readOnly: true
+ sent_date:
+ description: 'The invitation sent date'
+ type: string
+ format: date-time
+ readOnly: true
+ viewed_date:
+ description: 'The invitation viewed date'
+ type: string
+ format: date-time
+ readOnly: true
+ opened_date:
+ description: 'The invitation opened date'
+ type: string
+ format: date-time
+ readOnly: true
+ updated_at:
+ description: 'Timestamp'
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ archived_at:
+ description: 'Timestamp'
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ email_error:
+ description: 'The email error'
+ type: string
+ example: 'The email error'
+ readOnly: true
+ email_status:
+ description: 'The email status'
+ type: string
+ readOnly: true
+
+ VendorContact:
+ properties:
+ id:
+ description: 'The hashed id of the vendor contact'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ user_id:
+ description: 'The hashed id of the user id'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ vendor_id:
+ description: 'The hashed id of the vendor'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ first_name:
+ description: 'The first name of the contact'
+ type: string
+ example: Harry
+ last_name:
+ description: 'The last name of the contact'
+ type: string
+ example: Windsor
+ contact_key:
+ description: 'A unique identifier for the contact'
+ type: string
+ example: JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a
+ readOnly: true
+ confirmation_code:
+ description: 'The confirmation code used to authenticate the contacts email address'
+ type: string
+ example: 333-sdjkh34gbasd
+ readOnly: true
+ phone:
+ description: 'The contacts phone number'
+ type: string
+ example: 555-123-1234
+ custom_value1:
+ description: 'A custom value'
+ type: string
+ example: '2022-10-10'
+ custom_value2:
+ description: 'A custom value'
+ type: string
+ example: $1000
+ custom_value3:
+ description: 'A custom value'
+ type: string
+ example: ''
+ custom_value4:
+ description: 'A custom value'
+ type: string
+ example: ''
+ email:
+ description: 'The contact email address'
+ type: string
+ example: harry@windsor.com
+ email_verified_at:
+ description: 'The date which the contact confirmed their email'
+ type: number
+ format: integer
+ example: '134341234234'
+ readOnly: true
+ password:
+ description: 'The hashed password of the contact'
+ type: string
+ example: '*****'
+ is_primary:
+ description: 'Boolean flag determining if the contact is the primary contact for the vendor'
+ type: boolean
+ example: true
+ created_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ readOnly: true
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ readOnly: true
+ deleted_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ readOnly: true
+ type: object
+ ClientGatewayToken:
+ properties:
+ id:
+ description: 'The hashed id of the client gateway token'
+ type: string
+ example: Opnel5aKBz
+ client_id:
+ description: 'The hashed_id of the client'
+ type: string
+ example: '2'
+ token:
+ description: 'The payment token'
+ type: string
+ example: '2'
+ routing_number:
+ description: 'THe bank account routing number'
+ type: string
+ example: '2'
+ company_gateway_id:
+ description: 'The hashed id of the company gateway'
+ type: string
+ example: '2'
+ is_default:
+ description: 'Flag determining if the token is the default payment method'
+ type: boolean
+ example: 'true'
type: object
Company:
properties:
@@ -16230,2020 +17154,115 @@ components:
description: "A flag determining whether to include the item description on invoices by default"
type: boolean
example: true
-
- settings:
- $ref: '#/components/schemas/CompanySettings'
- type: object
- InvoiceRequest:
- required:
- - client_id
- properties:
- id:
- description: 'The invoice hashed id'
+
+ expense_mailbox:
+ description: "The email address for the expense mailbox"
type: string
- example: Opnel5aKBz
- readOnly: true
- user_id:
- description: 'The user hashed id'
- type: string
- example: Opnel5aKBz
- assigned_user_id:
- description: 'The assigned user hashed id'
- type: string
- example: Opnel5aKBz
- client_id:
- description: 'The client hashed id'
- type: string
- example: Opnel5aKBz
- status_id:
- description: 'The invoice status variable'
- type: string
- example: '4'
- readOnly: true
- number:
- description: 'The invoice number - is a unique alpha numeric number per invoice per company'
- type: string
- example: INV_101
- po_number:
- description: 'The purchase order associated with this invoice'
- type: string
- example: PO-1234
- terms:
- description: 'The invoice terms'
- type: string
- example: 'These are invoice terms'
- public_notes:
- description: 'The public notes of the invoice'
- type: string
- example: 'These are some public notes'
- private_notes:
- description: 'The private notes of the invoice'
- type: string
- example: 'These are some private notes'
- footer:
- description: 'The invoice footer notes'
- type: string
- example: ''
- custom_value1:
- description: 'A custom field value'
- type: string
- example: '2022-10-01'
- custom_value2:
- description: 'A custom field value'
- type: string
- example: 'Something custom'
- custom_value3:
- description: 'A custom field value'
- type: string
- example: ''
- custom_value4:
- description: 'A custom field value'
- type: string
- example: ''
- tax_name1:
- description: 'The tax name'
- type: string
- example: ''
- tax_name2:
- description: 'The tax name'
- type: string
- example: ''
- tax_rate1:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- tax_rate2:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- tax_name3:
- description: 'The tax name'
- type: string
- example: ''
- tax_rate3:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- total_taxes:
- description: 'The total taxes for the invoice'
- type: number
- format: float
- example: '10.00'
- readOnly: true
- line_items:
- type: array
- description: 'An array of objects which define the line items of the invoice'
- items:
- $ref: '#/components/schemas/InvoiceItem'
- invitations:
- type: array
- description: 'An array of objects which define the invitations of the invoice'
- items:
- $ref: '#/components/schemas/InvoiceInvitationRequest'
- amount:
- description: 'The invoice amount'
- type: number
- format: float
- example: '10.00'
- readOnly: true
- balance:
- description: 'The invoice balance'
- type: number
- format: float
- example: '10.00'
- readOnly: true
- paid_to_date:
- description: 'The amount paid on the invoice to date'
- type: number
- format: float
- example: '10.00'
- readOnly: true
- discount:
- description: 'The invoice discount, can be an amount or a percentage'
- type: number
- format: float
- example: '10.00'
- partial:
- description: 'The deposit/partial amount'
- type: number
- format: float
- example: '10.00'
- is_amount_discount:
- description: 'Flag determining if the discount is an amount or a percentage'
- type: boolean
- example: true
- is_deleted:
- description: 'Defines if the invoice has been deleted'
- type: boolean
- example: true
- readOnly: true
- uses_inclusive_taxes:
- description: 'Defines the type of taxes used as either inclusive or exclusive'
- type: boolean
- example: true
- date:
- description: 'The Invoice Date'
- type: string
- format: date
- example: '1994-07-30'
- last_sent_date:
- description: 'The last date the invoice was sent out'
- type: string
- format: date
- example: '1994-07-30'
- readOnly: true
- next_send_date:
- description: 'The Next date for a reminder to be sent'
- type: string
- format: date
- example: '1994-07-30'
- readOnly: true
- partial_due_date:
- description: 'The due date for the deposit/partial amount'
- type: string
- format: date
- example: '1994-07-30'
- due_date:
- description: 'The due date of the invoice'
- type: string
- format: date
- example: '1994-07-30'
- last_viewed:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- custom_surcharge1:
- description: 'First Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge2:
- description: 'Second Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge3:
- description: 'Third Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge4:
- description: 'Fourth Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge_tax1:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- custom_surcharge_tax2:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- custom_surcharge_tax3:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- custom_surcharge_tax4:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- project_id:
- description: 'The project associated with this invoice'
- type: string
- example: Opnel5aKBz
- type: object
- SystemLog:
- properties:
- id:
- description: 'The account hashed id'
- type: string
- example: AS3df3A
- user_id:
- description: 'The user_id hashed id'
- type: string
- example: AS3df3A
- client_id:
- description: 'The client_id hashed id'
- type: string
- example: AS3df3A
- event_id:
- description: 'The Log Type ID'
- type: integer
- example: 1
- category_id:
- description: 'The Category Type ID'
- type: integer
- example: 1
- type_id:
- description: 'The Type Type ID'
- type: integer
- example: 1
- log:
- description: 'The json object of the error'
- type: object
- example: '{''key'':''value''}'
- updated_at:
- description: Timestamp
- type: string
- example: '2'
- created_at:
- description: Timestamp
- type: string
- example: '2'
- type: object
- Expense:
- properties:
- id:
- description: 'The expense hashed id'
- type: string
- example: 'Opnel5aKBz'
- user_id:
- description: 'The user hashed id'
- type: string
- example: 'Opnel5aKBz'
- assigned_user_id:
- description: 'The assigned user hashed id'
- type: string
- example: 'Opnel5aKBz'
- project_id:
- description: 'The associated project_id'
- type: string
- example: 'Opnel5aKBz'
- client_id:
- description: 'The client hashed id'
- type: string
- example: 'Opnel5aKBz'
- invoice_id:
- description: 'The related invoice hashed id'
- type: string
- example: 'Opnel5aKBz'
- bank_id:
- description: 'The bank id related to this expense'
- type: string
- example: ''
- invoice_currency_id:
- description: 'The currency id of the related invoice'
- type: string
- example: '1'
- currency_id:
- description: 'The currency id of the expense'
- type: string
- example: '2'
- invoice_category_id:
- description: 'The invoice category id'
- type: string
- example: 'Opnel5aKBz'
- payment_type_id:
- description: 'The payment type id'
- type: string
- example: ''
- recurring_expense_id:
- description: 'The related recurring expense this expense was created from'
- type: string
- example: 'Opnel5aKBz'
- private_notes:
- description: 'The private notes of the expense'
- type: string
- example: ''
- public_notes:
- description: 'The public notes of the expense'
- type: string
- example: ''
- transaction_reference:
- description: 'The transaction references of the expense'
- type: string
- example: ''
- transcation_id:
- description: 'The transaction id of the expense'
- type: string
- example: ''
- custom_value1:
- description: 'A custom value'
- type: string
- example: ''
- custom_value2:
- description: 'A custom value'
- type: string
- example: ''
- custom_value3:
- description: 'A custom value'
- type: string
- example: ''
- custom_value4:
- description: 'A custom value'
- type: string
- example: ''
- tax_amount:
- description: 'The tax amount'
- type: number
- example: 10.00
- tax_name1:
- description: 'Tax Name 1'
- type: string
- example: 'GST'
- tax_name2:
- description: 'Tax Name 2'
- type: string
- example: 'VAT'
- tax_name3:
- description: 'Tax Name 3'
- type: string
- example: 'IVA'
- tax_rate1:
- description: 'Tax rate 1'
- type: number
- format: float
- example: '10.00'
- tax_rate2:
- description: 'Tax rate 2'
- type: number
- format: float
- example: '10.00'
- tax_rate3:
- description: 'Tax rate 3'
- type: number
- format: float
- example: '10.00'
- amount:
- description: 'The total expense amont'
- type: number
- format: float
- example: '10.00'
- foreign_amount:
- description: 'The total foreign amount of the expense'
- type: number
- format: float
- example: '10.00'
- exchange_rate:
- description: 'The exchange rate at the time of the expense'
- type: number
- format: float
- example: '0.80'
- date:
- description: 'The expense date format Y-m-d'
- type: string
- example: '2022-12-01'
- payment_date:
- description: 'The date of payment for the expense, format Y-m-d'
- type: string
- example: '2022-12-01'
- should_be_invoiced:
- description: 'Flag whether the expense should be invoiced'
- type: boolean
- example: true
- is_deleted:
- description: 'Boolean determining whether the expense has been deleted'
- type: boolean
- example: true
- invoice_documents:
- description: 'Passing the expense documents over to the invoice'
- type: boolean
- example: true
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- type: object
- BankTransaction:
- properties:
- id:
- description: 'The bank integration hashed id'
- type: string
- example: AS3df3A
- user_id:
- description: 'The user hashed id'
- type: string
- example: AS3df3A
- transaction_id:
- description: 'The id of the transaction rule'
- type: integer
- example: 343434
- amount:
- description: 'The transaction amount'
- type: number
- example: 10
- currency_id:
- description: 'The currency ID of the currency'
- type: string
- example: '1'
- account_type:
- description: 'The account type'
- type: string
- example: creditCard
- description:
- description: 'The description of the transaction'
- type: string
- example: 'Potato purchases for kevin'
- category_id:
- description: 'The category id'
- type: integer
- example: 1
- category_type:
- description: 'The category description'
- type: string
- example: Expenses
- base_type:
- description: 'Either CREDIT or DEBIT'
- type: string
- example: CREDIT
- date:
- description: 'The date of the transaction'
- type: string
- example: '2022-09-01'
- bank_account_id:
- description: 'The ID number of the bank account'
- type: integer
- example: '1'
- type: object
- ExpenseCategory:
- properties:
- id:
- description: 'The expense hashed id'
- type: string
- example: Opnel5aKBz
- name:
- description: 'The expense category name'
- type: string
- example: Accounting
- user_id:
- description: 'The user hashed id'
- type: string
- example: XS987sD
- is_deleted:
- description: 'Flag determining whether the expense category has been deleted'
- type: boolean
- example: true
- updated_at:
- description: 'The updated at timestamp'
- type: integer
- example: '2'
- created_at:
- description: 'The created at timestamp'
- type: integer
- example: '2'
- type: object
- BankIntegration:
- properties:
- id:
- description: 'The bank integration hashed id'
- type: string
- example: AS3df3A
- user_id:
- description: 'The user hashed id'
- type: string
- example: AS3df3A
- provider_bank_name:
- description: 'The providers bank name'
- type: string
- example: 'Chase Bank'
- bank_account_id:
- description: 'The bank account id'
- type: integer
- example: '1233434'
- bank_account_name:
- description: 'The name of the account'
- type: string
- example: 'My Checking Acc'
- bank_account_number:
- description: 'The account number'
- type: string
- example: '111 234 2332'
- bank_account_status:
- description: 'The status of the bank account'
- type: string
- example: ACTIVE
- bank_account_type:
- description: 'The type of account'
- type: string
- example: CREDITCARD
- balance:
- description: 'The current bank balance if available'
- type: number
- example: '1000000'
- currency:
- description: 'iso_3166_3 code'
- type: string
- example: USD
- type: object
- Subscription:
- properties:
- id:
- description: Unique identifier for the subscription
- type: string
- example: Opnel5aKBz
- user_id:
- description: Unique identifier for the user associated with the subscription
- type: string
- example: Ua6Rw4pVbS
- product_id:
- description: Unique identifier for the product associated with the subscription
- type: string
- example: Pr5Ft7yBmC
- recurring_invoice_id:
- description: Unique identifier for the recurring invoice associated with the subscription
- type: string
- example: Ri2Yt8zJkP
- is_recurring:
- description: Indicates whether the subscription is recurring
- type: boolean
- example: 'true'
- frequency_id:
- description: 'integer const representation of the frequency'
- type: string
- example: '1'
- auto_bill:
- description: 'enum setting'
- type: string
- example: always
- promo_code:
- description: Promotional code applied to the subscription
- type: string
- example: PROMOCODE4U
- promo_discount:
- description: Discount percentage or amount applied to the subscription
- type: number
- example: 10
- is_amount_discount:
- description: Indicates whether the discount is a fixed amount
- type: boolean
- example: 'true'
- allow_cancellation:
- description: Indicates whether the subscription can be cancelled
- type: boolean
- example: 'true'
- per_seat_enabled:
- description: Indicates whether the subscription pricing is per seat
- type: boolean
- example: 'true'
- currency_id:
- description: Unique identifier for the currency used in the subscription
- type: integer
- example: '1'
- max_seats_limit:
- description: Maximum number of seats allowed for the subscription
- type: integer
- example: '100'
- trial_enabled:
- description: Indicates whether the subscription has a trial period
- type: boolean
- example: 'true'
- trial_duration:
- description: Duration of the trial period in days
- type: integer
- example: '14'
- allow_query_overrides:
- description: Indicates whether query overrides are allowed for the subscription
- type: boolean
- example: 'true'
- allow_plan_changes:
- description: Indicates whether plan changes are allowed for the subscription
- type: boolean
- example: 'true'
- refund_period:
- description: Number of days within which refunds can be requested
- type: integer
- example: '30'
- webhook_configuration:
- description: Webhook configuration for the subscription
- type: string
- example: 'expand reference for this'
- is_deleted:
- description: Indicates whether the subscription has been deleted
- type: boolean
- example: 'false'
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- created_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- type: object
- BulkAction:
- type: array
- items:
- type: integer
- example: '[0,1,2,3,]'
- FillableInvoice:
- properties:
- assigned_user_id:
- description: "The assigned user's hashed ID"
- type: string
- example: 'a1b2c3d4'
- client_id:
- description: "The client's hashed ID"
- type: string
- example: 'x1y2z3a4'
- number:
- description: "The unique alphanumeric invoice number for each invoice per company"
- type: string
- example: INV_101
- po_number:
- description: "The purchase order number associated with the invoice"
- type: string
- example: 'PO12345'
- terms:
- description: "The terms and conditions for the invoice"
- type: string
- example: 'Net 30'
- public_notes:
- description: "Public notes visible to the client on the invoice"
- type: string
- example: 'Thank you for your business.'
- private_notes:
- description: "Private notes for internal use only"
- type: string
- example: 'Client is a slow payer.'
- footer:
- description: "The footer text displayed on the invoice"
- type: string
- example: 'Authorized Signature'
- custom_value1:
- description: "First custom value for additional information"
- type: string
- example: 'Project ABC'
- custom_value2:
- description: "Second custom value for additional information"
- type: string
- example: 'Department XYZ'
- custom_value3:
- description: "Third custom value for additional information"
- type: string
- example: 'Location 123'
- custom_value4:
- description: "Fourth custom value for additional information"
- type: string
- example: 'Currency USD'
- tax_name1:
- description: "Name of the first tax applied to the invoice"
- type: string
- example: 'VAT'
- tax_name2:
- description: "Name of the second tax applied to the invoice"
- type: string
- example: 'GST'
- tax_rate1:
- description: "Rate of the first tax applied to the invoice"
- type: number
- example: 10.00
- tax_rate2:
- description: "Rate of the second tax applied to the invoice"
- type: number
- example: 5.00
- tax_name3:
- description: "Name of the third tax applied to the invoice"
- type: string
- example: 'PST'
- tax_rate3:
- description: "Rate of the third tax applied to the invoice"
- type: number
- example: 8.00
- line_items:
- type: array
- description: 'An array of objects which define the line items of the invoice'
- items:
- $ref: '#/components/schemas/InvoiceItem'
- discount:
- description: "The discount applied to the invoice"
- type: number
- example: 10.00
- partial:
- description: "The partial amount applied to the invoice"
- type: number
- example: 20.00
- is_amount_discount:
- description: "Indicates whether the discount applied is a fixed amount or a percentage"
- type: boolean
- example: true
- uses_inclusive_taxes:
- description: "Indicates whether the tax rates applied to the invoice are inclusive or exclusive"
- type: boolean
- example: true
- date:
- description: "The date the invoice was issued"
- type: string
- example: '1994-07-30'
- partial_due_date:
- description: "The due date for the partial payment"
- type: string
- example: '1994-08-15'
- due_date:
- description: "The due date for the invoice"
- type: string
- example: '1994-08-30'
- custom_surcharge1:
- description: "First custom surcharge applied to the invoice"
- type: number
- example: 10.00
- custom_surcharge2:
- description: "Second custom surcharge applied to the invoice"
- type: number
- example: 15.00
- custom_surcharge3:
- description: "Third custom surcharge applied to the invoice"
- type: number
- example: 5.00
- custom_surcharge4:
- description: "Fourth custom surcharge applied to the invoice"
- type: number
- example: 20.00
- type: object
- RecurringQuote:
- properties:
- id:
- description: 'The hashed id of the recurring quote'
- type: string
- example: Opnel5aKBz
- user_id:
- description: 'The user hashed id'
- type: string
- example: Opnel5aKBz
- assigned_user_id:
- description: 'The assigned user hashed id'
- type: string
- example: Opnel5aKBz
- client_id:
- description: 'The client hashed id'
- type: string
- example: Opnel5aKBz
- status_id:
- description: 'The quote status variable'
- type: string
- example: '4'
- frequency_id:
- description: 'The recurring quote frequency'
- type: number
- example: '4'
- remaining_cycles:
- description: 'The number of quotes left to be generated'
- type: number
- example: '4'
- number:
- description: 'The recurringquote number - is a unique alpha numeric number per quote per company'
- type: string
- example: INV_101
- po_number:
- description: 'The purchase order associated with this recurring quote'
- type: string
- example: PO-1234
- terms:
- description: 'The quote terms'
- type: string
- example: 'These are quote terms'
- public_notes:
- description: 'The public notes of the quote'
- type: string
- example: 'These are some public notes'
- private_notes:
- description: 'The private notes of the quote'
- type: string
- example: 'These are some private notes'
- footer:
- description: 'The quote footer notes'
- type: string
- example: ''
- custom_value1:
- description: 'A custom field value'
- type: string
- example: '2022-10-01'
- custom_value2:
- description: 'A custom field value'
- type: string
- example: 'Something custom'
- custom_value3:
- description: 'A custom field value'
- type: string
- example: ''
- custom_value4:
- description: 'A custom field value'
- type: string
- example: ''
- tax_name1:
- description: 'The tax name'
- type: string
- example: ''
- tax_name2:
- description: 'The tax name'
- type: string
- example: ''
- tax_rate1:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- tax_rate2:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- tax_name3:
- description: 'The tax name'
- type: string
- example: ''
- tax_rate3:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- total_taxes:
- description: 'The total taxes for the quote'
- type: number
- format: float
- example: '10.00'
- line_items:
- description: 'An array of objects which define the line items of the quote'
- type: object
- example: ''
- amount:
- description: 'The quote amount'
- type: number
- format: float
- example: '10.00'
- balance:
- description: 'The quote balance'
- type: number
- format: float
- example: '10.00'
- paid_to_date:
- description: 'The amount paid on the quote to date'
- type: number
- format: float
- example: '10.00'
- discount:
- description: 'The quote discount, can be an amount or a percentage'
- type: number
- format: float
- example: '10.00'
- partial:
- description: 'The deposit/partial amount'
- type: number
- format: float
- example: '10.00'
- is_amount_discount:
- description: 'Flag determining if the discount is an amount or a percentage'
- type: boolean
- example: true
- is_deleted:
- description: 'Defines if the quote has been deleted'
- type: boolean
- example: true
- uses_inclusive_taxes:
- description: 'Defines the type of taxes used as either inclusive or exclusive'
- type: boolean
- example: true
- date:
- description: 'The quote Date'
- type: string
- format: date
- example: '1994-07-30'
- last_sent_date:
- description: 'The last date the quote was sent out'
- type: string
- format: date
- example: '1994-07-30'
- next_send_date:
- description: 'The Next date for a reminder to be sent'
- type: string
- format: date
- example: '1994-07-30'
- partial_due_date:
- description: 'The due date for the deposit/partial amount'
- type: string
- format: date
- example: '1994-07-30'
- due_date:
- description: 'The due date of the quote'
- type: string
- format: date
- example: '1994-07-30'
- settings:
- $ref: '#/components/schemas/CompanySettings'
- last_viewed:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- custom_surcharge1:
- description: 'First Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge2:
- description: 'Second Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge3:
- description: 'Third Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge4:
- description: 'Fourth Custom Surcharge'
- type: number
- format: float
- example: '10.00'
- custom_surcharge_tax1:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- custom_surcharge_tax2:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- custom_surcharge_tax3:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- custom_surcharge_tax4:
- description: 'Toggles charging taxes on custom surcharge amounts'
- type: boolean
- example: true
- type: object
- Paymentable:
- properties:
- id:
- description: 'The paymentable hashed id'
- type: string
- example: AS3df3A
- invoice_id:
- description: 'The invoice hashed id'
- type: string
- example: AS3df3A
- credit_id:
- description: 'The credit hashed id'
- type: string
- example: AS3df3A
- refunded:
- description: 'The amount that has been refunded for this payment'
- type: number
- format: float
- example: '10.00'
- amount:
- description: 'The amount that has been applied to the payment'
- type: number
- format: float
- example: '10.00'
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- created_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- type: object
- Meta:
- properties:
- pagination:
- $ref: '#/components/schemas/Pagination'
- Pagination:
- type: object
- properties:
- total:
- type: integer
- description: 'The total number of items'
- example: 1
- readOnly: true
- count:
- type: integer
- description: 'The number of items per page'
- example: 1
- readOnly: true
- per_page:
- type: integer
- description: 'The number of items per page'
- example: 1
- readOnly: true
- current_page:
- type: integer
- description: 'The current page number'
- example: 1
- readOnly: true
- total_pages:
- type: integer
- description: 'The total number of pages'
- example: 1
- readOnly: true
- links:
- type: object
- description: 'The pagination links'
- readOnly: true
- Project:
- type: object
- properties:
- id:
- description: 'The project hashed id'
- type: string
- example: Opnel5aKBz
- user_id:
- description: 'The user hashed id'
- type: string
- example: Opnel5aKBz
- assigned_user_id:
- description: The assigned user identifier associated with the project
- type: string
- example: Opnel5aKBz
- client_id:
- type: string
- example: Opnel5aKBz
- description: The client identifier associated with the project
- name:
- type: string
- description: The name of the project
- example: 'New Project'
- task_rate:
- type: number
- format: float
- example: 10
- description: The default rate per task for the project
- due_date:
- type: string
- format: date
- example: '2019-01-01'
- description: The due date for the project
- private_notes:
- type: string
- description: Private notes associated with the project
- budgeted_hours:
- type: number
- format: float
- description: The number of budgeted hours for the project
- custom_value1:
- type: string
- description: Custom value field 1
- custom_value2:
- type: string
- description: Custom value field 2
- custom_value3:
- type: string
- description: Custom value field 3
- custom_value4:
- type: string
- description: Custom value field 4
- created_at:
- type: number
- format: integer
- example: 134341234234
- description: The timestamp of the project creation
- updated_at:
- type: number
- format: integer
- example: 134341234234
- description: The timestamp of the last project update
- archived_at:
- type: number
- format: integer
- example: 134341234234
- description: The timestamp of the project deletion
- public_notes:
- type: string
- description: Public notes associated with the project
- is_deleted:
- type: boolean
- description: A flag indicating if the project is deleted
- number:
- type: string
- description: The project number
- color:
- type: string
- description: The color associated with the project
- required:
- - id
- - user_id
- - name
- - task_rate
- - budgeted_hours
- - is_deleted
- - color
+ example: "expenses@company.com"
- Client:
- properties:
- id:
- description: 'The unique identifier of the client'
- type: string
- example: Opnel5aKBz
- readOnly: true
- contacts:
- type: array
- items:
- $ref: '#/components/schemas/ClientContact'
- user_id:
- description: 'The unique identifier of the user who created the client'
- type: string
- example: Ua6Rw4pVbS
- readOnly: true
- assigned_user_id:
- description: 'The unique identifier of the user who has been assigned the client'
- type: string
- example: Ua6Rw4pVbS
- name:
- description: 'The name of the client company or organization'
- type: string
- example: "Jim's Housekeeping"
- website:
- description: 'The website URL of the client company or organization'
- type: string
- example: 'https://www.jims-housekeeping.com'
- private_notes:
- description: 'Notes that are only visible to the user who created the client'
- type: string
- example: 'Client prefers email communication over phone calls'
- client_hash:
- description: 'A unique hash value for the client'
- type: string
- example: asdfkjhk342hjhbfdvmnfb1
- readOnly: true
- industry_id:
- description: 'The unique identifier of the industry the client operates in'
- type: number
- example: '5'
- size_id:
- description: 'The unique identifier for the size category of the client company or organization'
- type: number
- example: '2'
- address1:
- description: "First line of the client's address"
- type: string
- example: '123 Main St'
- address2:
- description: "Second line of the client's address, if needed"
- type: string
- example: 'Apt 4B'
- city:
- description: 'The city the client is located in'
- type: string
- example: 'Beverly Hills'
- state:
- description: 'The state, province, or locality the client is located in'
- type: string
- example: 'California'
- postal_code:
- description: 'The postal code or ZIP code of the client'
- type: string
- example: '90210'
- phone:
- description: "The client's phone number"
- type: string
- example: '555-3434-3434'
- country_id:
- description: "The unique identifier of the client's country"
- type: number
- format: integer
- example: '1'
- custom_value1:
- description: 'A custom field for storing additional information'
- type: string
- example: 'Preferred contact: Email'
- custom_value2:
- description: 'A custom field for storing additional information'
- type: string
- example: 'Account manager: John Doe'
- custom_value3:
- description: 'A custom field for storing additional information'
- type: string
- example: 'VIP client: Yes'
- custom_value4:
- description: 'A custom field for storing additional information'
- type: string
- example: 'Annual contract value: $50,000'
- vat_number:
- description: "The client's VAT (Value Added Tax) number, if applicable"
- type: string
- example: 'VAT123456'
- id_number:
- description: 'A unique identification number for the client, such as a tax ID or business registration number'
- type: string
- number:
- description: 'A system-assigned unique number for the client, typically used for invoicing purposes'
- type: string
- example: 'CL-0001'
- shipping_address1:
- description: "First line of the client's shipping address"
- type: string
- example: '5 Wallaby Way'
- shipping_address2:
- description: "Second line of the client's shipping address, if needed"
- type: string
- example: 'Suite 5'
- shipping_city:
- description: "The city of the client's shipping address"
- type: string
- example: 'Perth'
- shipping_state:
- description: "The state, province, or locality of the client's shipping address"
- type: string
- example: 'Western Australia'
- shipping_postal_code:
- description: "The postal code or ZIP code of the client's shipping address"
- type: string
- example: '6110'
- shipping_country_id:
- description: "The unique identifier of the country for the client's shipping address"
- type: number
- format: integer
- example: '4'
- is_deleted:
- description: 'A boolean value indicating whether the client has been deleted or not'
- type: boolean
- example: false
- readOnly: true
- balance:
- description: 'The outstanding balance the client owes'
- type: number
- format: float
- example: '500.00'
- readOnly: true
- paid_to_date:
- description: 'The total amount the client has paid to date'
- type: number
- format: float
- example: '2000.00'
- readOnly: true
- credit_balance:
- description: 'The available credit balance for the client to use on future purchases'
- type: number
- format: float
- example: '100.00'
- readOnly: true
- last_login:
- description: "The timestamp of the client's last login"
- type: number
- format: integer
- example: '1628686031'
- readOnly: true
- created_at:
- description: 'The timestamp when the client was created'
- type: number
- format: integer
- example: '1617629031'
- readOnly: true
- updated_at:
- description: 'The timestamp when the client was last updated'
- type: number
- format: integer
- example: '1628445631'
- readOnly: true
- group_settings_id:
- description: 'The group settings assigned to the client'
- type: string
- example: Opnel5aKBz
- routing_id:
- description: 'The routing address id for e-invoicing for this client'
- type: string
- example: Opnel5aKBz3489-dfkiu-2239-sdsd
- is_tax_exempt:
- description: 'Flag which defines if the client is exempt from taxes'
- type: boolean
- example: false
- has_valid_vat_number:
- description: 'Flag which defines if the client has a valid VAT number'
- type: boolean
- example: false
- readOnly: true
- payment_balance:
- description: 'Defines the payment balance the client has on file (pre payments / over payments / unapplied amounts)'
- type: number
- example: 100
- readOnly: true
- settings:
- $ref: '#/components/schemas/ClientSettings'
- type: object
- Vendor:
- properties:
- id:
- description: 'The hashed id of the vendor. This is a unique identifier for the vendor.'
- type: string
- example: Opnel5aKBz
- readOnly: true
- user_id:
- description: 'The hashed id of the user who created the vendor. This is a unique identifier for the user.'
- type: string
- example: Opnel5aKBz
- assigned_user_id:
- description: 'The hashed id of the assigned user to this vendor. This is a unique identifier for the user.'
- type: string
- example: Opnel5aKBz
- contacts:
- type: array
- items:
- $ref: '#/components/schemas/VendorContact'
- description: 'An array of contacts associated with the vendor.'
- name:
- description: 'The name of the vendor.'
- type: string
- example: 'Harry cafe de wheels'
- classification:
- description: 'The classification of the vendor.'
- type: string
- example: 'individual'
- website:
- description: 'The website of the vendor.'
- type: string
- example: www.harry.com
- private_notes:
- description: 'The private notes of the vendor. These notes are only visible to users with appropriate permissions.'
- type: string
- example: 'Shhh, do not tell the vendor'
- industry_id:
- description: 'The industry id of the vendor. This is a unique identifier for the industry.'
- type: string
- example: '1'
- size_id:
- description: 'The size id of the vendor. This is a unique identifier for the size of the vendor.'
- type: string
- example: ''
- address1:
- description: 'The first line of the vendor''s address.'
- type: string
- example: ''
- address2:
- description: 'The second line of the vendor''s address.'
- type: string
- example: ''
- city:
- description: 'The city of the vendor''s address.'
- type: string
- example: ''
- state:
- description: 'The state of the vendor''s address.'
- type: string
- example: ''
- postal_code:
- description: 'The postal code of the vendor''s address.'
- type: string
- example: ''
- phone:
- description: 'The phone number of the vendor.'
- type: string
- example: 555-3434-3434
- country_id:
- description: 'The country id of the vendor. This is a unique identifier for the country.'
- type: string
- example: ''
- currency_id:
- description: 'The currency id of the vendor. This is a unique identifier for the currency.'
- type: string
- example: '4'
- custom_value1:
- description: 'The value of the first custom field for the vendor.'
- type: string
- example: ''
- custom_value2:
- description: 'The value of the second custom field for the vendor.'
- type: string
- example: ''
- custom_value3:
- description: 'The value of the third custom field for the vendor.'
- type: string
- example: ''
- custom_value4:
- description: 'The value of the fourth custom field for the vendor.'
- type: string
- example: ''
- vat_number:
- description: 'The VAT number of the vendor.'
- type: string
- example: ''
- id_number:
- description: 'The ID number of the vendor.'
- type: string
- example: ''
- number:
- description: 'The number of the vendor'
- type: string
- example: '11234'
- is_deleted:
- description: 'Boolean flag determining if the vendor has been deleted'
+ expense_mailbox_active:
+ description: "Whether the expense mailbox is active"
type: boolean
example: true
- language_id:
- description: 'The language id of the vendor. This is a unique identifier for the language.'
- type: string
- example: '1'
- vendor_hash:
- description: 'The vendor hash of the vendor. This is a unique identifier for the vendor.'
- type: string
- example: 'aaa-sss-www'
- readOnly: true
- transaction_name:
- description: 'The transaction name of the vendor.'
- type: string
- example: 'aaa-sss-www'
- last_login:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- readOnly: true
- created_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- readOnly: true
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- readOnly: true
- display_name:
- description: 'The display name of the vendor.'
- type: string
- example: 'Bob the vendor'
- readOnly: true
- type: object
- VendorContact:
- properties:
- id:
- description: 'The hashed id of the vendor contact'
- type: string
- example: Opnel5aKBz
- readOnly: true
- user_id:
- description: 'The hashed id of the user id'
- type: string
- example: Opnel5aKBz
- readOnly: true
- vendor_id:
- description: 'The hashed id of the vendor'
- type: string
- example: Opnel5aKBz
- readOnly: true
- first_name:
- description: 'The first name of the contact'
- type: string
- example: Harry
- last_name:
- description: 'The last name of the contact'
- type: string
- example: Windsor
- contact_key:
- description: 'A unique identifier for the contact'
- type: string
- example: JD0X52bkfZlJRiroCJ0tcSiAjsJTntZ5uqKdiZ0a
- readOnly: true
- confirmation_code:
- description: 'The confirmation code used to authenticate the contacts email address'
- type: string
- example: 333-sdjkh34gbasd
- readOnly: true
- phone:
- description: 'The contacts phone number'
- type: string
- example: 555-123-1234
- custom_value1:
- description: 'A custom value'
- type: string
- example: '2022-10-10'
- custom_value2:
- description: 'A custom value'
- type: string
- example: $1000
- custom_value3:
- description: 'A custom value'
- type: string
- example: ''
- custom_value4:
- description: 'A custom value'
- type: string
- example: ''
- email:
- description: 'The contact email address'
- type: string
- example: harry@windsor.com
- email_verified_at:
- description: 'The date which the contact confirmed their email'
- type: number
- format: integer
- example: '134341234234'
- readOnly: true
- password:
- description: 'The hashed password of the contact'
- type: string
- example: '*****'
- is_primary:
- description: 'Boolean flag determining if the contact is the primary contact for the vendor'
+
+ inbound_mailbox_allow_company_users:
+ description: "Whether company users are allowed to use the inbound mailbox"
type: boolean
example: true
- created_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- readOnly: true
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- readOnly: true
- deleted_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
- readOnly: true
- type: object
- Quote:
- properties:
- id:
- description: 'The unique hashed identifier for the quote'
- type: string
- example: Opnel5aKBz
- user_id:
- description: 'The unique hashed identifier for the user who created the quote'
- type: string
- example: ''
- assigned_user_id:
- description: 'The unique hashed identifier for the user assigned to the quote'
- type: string
- example: ''
- client_id:
- description: 'The unique hashed identifier for the client associated with the quote'
- type: string
- example: ''
- status_id:
- description: 'The status of the quote represented by a unique identifier'
- type: string
- example: ''
- number:
- description: 'The unique alpha-numeric quote number for the quote per company'
- type: string
- example: QUOTE_101
- po_number:
- description: 'The purchase order number associated with the quote'
- type: string
- example: PO-1234
- terms:
- description: 'The terms and conditions for the quote'
- type: string
- example: 'These are some quote terms. Valid for 14 days.'
- public_notes:
- description: 'Publicly visible notes associated with the quote'
- type: string
- example: 'These are public notes which the client may see'
- private_notes:
- description: 'Privately visible notes associated with the quote, not disclosed to the client'
- type: string
- example: 'These are private notes, not to be disclosed to the client'
- footer:
- description: 'The footer text of the quote'
- type: string
- example: 'The text goes in the footer of the quote'
- custom_value1:
- description: 'First custom value field for additional information'
- type: string
- example: 'A custom value'
- custom_value2:
- description: 'Second custom value field for additional information'
- type: string
- example: 'A custom value'
- custom_value3:
- description: 'Third custom value field for additional information'
- type: string
- example: 'A custom value'
- custom_value4:
- description: 'Fourth custom value field for additional information'
- type: string
- example: 'A custom value'
- tax_name1:
- description: 'The name of the first tax applied to the quote'
- type: string
- example: GST
- tax_name2:
- description: 'The name of the second tax applied to the quote'
- type: string
- example: VAT
- tax_rate1:
- description: 'The rate of the first tax applied to the quote'
- type: number
- format: float
- example: 10.00
- tax_rate2:
- description: 'The rate of the second tax applied to the quote'
- type: number
- format: float
- example: 10.00
- tax_name3:
- description: 'The name of the third tax applied to the quote'
- type: string
- example: ''
- tax_rate3:
- description: 'The rate of the third tax applied to the quote'
- type: number
- format: float
- example: 10.00
- total_taxes:
- description: 'The total amount of taxes for the quote'
- type: number
- format: float
- example: 10.00
- line_items:
- type: array
- description: 'An array of objects which define the line items of the quote'
- items:
- $ref: '#/components/schemas/InvoiceItem'
- amount:
- description: 'The total amount of the quote before taxes and discounts'
- type: number
- format: float
- example: 10.00
- balance:
- description: 'The balance due for the quote after accounting for payments'
- type: number
- format: float
- example: 10.00
- paid_to_date:
- description: 'The total amount paid on the quote so far'
- type: number
- format: float
- example: 10.00
- discount:
- description: 'The discount amount or percentage applied to the quote'
- type: number
- format: float
- example: 10.00
- partial:
- description: 'The partial or deposit amount for the quote'
- type: number
- format: float
- example: 10.00
- is_amount_discount:
- description: 'Boolean flag indicating if the discount is a fixed amount or a percentage'
- type: boolean
- example: true
- is_deleted:
- description: 'Boolean flag indicating if the quote has been deleted'
+
+ inbound_mailbox_allow_vendors:
+ description: "Whether vendors are allowed to use the inbound mailbox"
type: boolean
example: false
- uses_inclusive_taxes:
- description: 'Boolean flag indicating if the taxes used are inclusive or exclusive'
+
+ inbound_mailbox_allow_clients:
+ description: "Whether clients are allowed to use the inbound mailbox"
type: boolean
example: true
- date:
- description: 'The date the quote was created'
+
+ inbound_mailbox_allow_unknown:
+ description: "Whether unknown senders are allowed to use the inbound mailbox"
+ type: boolean
+ example: false
+
+ inbound_mailbox_whitelist:
+ description: "Comma-separated list of whitelisted email addresses for the inbound mailbox"
type: string
- format: date
- example: '1994-07-30'
- last_sent_date:
- description: 'The last date the quote was sent to the client'
+ example: "user1@example.com,user2@example.com"
+
+ inbound_mailbox_blacklist:
+ description: "Comma-separated list of blacklisted email addresses for the inbound mailbox"
type: string
- format: date
- example: '1994-07-30'
- next_send_date:
- description: 'The next scheduled date for sending a reminder for the quote'
+ example: "spam@example.com,unwanted@example.com"
+
+ smtp_host:
+ description: "The SMTP host for sending emails"
type: string
- format: date
- example: '1994-07-30'
- partial_due_date:
- description: 'The due date for the partial or deposit amount'
+ example: "smtp.gmail.com"
+
+ smtp_port:
+ description: "The SMTP port for sending emails"
+ type: integer
+ example: 587
+
+ smtp_encryption:
+ description: "The encryption method for SMTP"
type: string
- format: date
- example: '1994-07-30'
- due_date:
- description: 'The due date for the total amount of the quote'
+ enum: [tls, ssl, null]
+ example: "tls"
+
+ smtp_local_domain:
+ description: "The local domain for SMTP"
type: string
- format: date
- example: '1994-07-30'
+ example: "company.com"
+
+ smtp_verify_peer:
+ description: "Whether to verify the SMTP peer"
+ type: boolean
+ example: true
+
+ e_invoice:
+ description: "E-invoice settings for the company"
+ type: object
+ additionalProperties: true
+
+ legal_entity_id:
+ description: "The ID of the legal entity associated with the company"
+ type: integer
+ example: 1234
settings:
$ref: '#/components/schemas/CompanySettings'
- last_viewed:
- description: 'The timestamp of the last time the quote was viewed'
- type: number
- format: integer
- example: 1434342123
- updated_at:
- description: 'The timestamp of the last update to the quote'
- type: number
- format: integer
- example: 1434342123
- archived_at:
- description: 'The timestamp of when the quote was archived'
- type: number
- format: integer
- example: 1434342123
- custom_surcharge1:
- description: 'First custom surcharge amount for the quote'
- type: number
- format: float
- example: 10.00
- custom_surcharge2:
- description: 'Second custom surcharge amount for the quote'
- type: number
- format: float
- example: 10.00
- custom_surcharge3:
- description: 'Third custom surcharge amount for the quote'
- type: number
- format: float
- example: 10.00
- custom_surcharge4:
- description: 'Fourth custom surcharge amount for the quote'
- type: number
- format: float
- example: 10.00
- custom_surcharge_tax1:
- description: 'Boolean flag indicating if taxes are charged on the first custom surcharge amount'
- type: boolean
- example: true
- custom_surcharge_tax2:
- description: 'Boolean flag indicating if taxes are charged on the second custom surcharge amount'
- type: boolean
- example: true
- custom_surcharge_tax3:
- description: 'Boolean flag indicating if taxes are charged on the third custom surcharge amount'
- type: boolean
- example: true
- custom_surcharge_tax4:
- description: 'Boolean flag indicating if taxes are charged on the fourth custom surcharge amount'
- type: boolean
- example: true
type: object
- Payment:
+ CompanyLedger:
properties:
- id:
- description: 'The payment hashed id'
+ entity_id:
+ description: 'This field will reference one of the following entity hashed ID payment_id, invoice_id or credit_id'
type: string
- example: Opnel5aKBz
- client_id:
- description: 'The client hashed id'
+ example: AS3df3A
+ notes:
+ description: 'The notes which reference this entry of the ledger'
type: string
- example: Opnel5aKBz
- invitation_id:
- description: 'The invitation hashed id'
- type: string
- example: Opnel5aKBz
- client_contact_id:
- description: 'The client contact hashed id'
- type: string
- example: Opnel5aKBz
- user_id:
- description: 'The user hashed id'
- type: string
- example: Opnel5aKBz
- type_id:
- description: 'The Payment Type ID'
- type: string
- example: '1'
- date:
- description: 'The Payment date'
- type: string
- example: 1-1-2014
- transaction_reference:
- description: 'The transaction reference as defined by the payment gateway'
- type: string
- example: xcsSxcs124asd
- assigned_user_id:
- description: 'The assigned user hashed id'
- type: string
- example: Opnel5aKBz
- private_notes:
- description: 'The private notes of the payment'
- type: string
- example: 'The payment was refunded due to error'
- is_manual:
- description: 'Flags whether the payment was made manually or processed via a gateway'
- type: boolean
- example: true
- is_deleted:
- description: 'Defines if the payment has been deleted'
- type: boolean
- example: true
- amount:
- description: 'The amount of this payment'
+ example: 'Credit note for invoice #3212'
+ balance:
+ description: 'The client balance'
type: number
- example: 10
- refunded:
- description: 'The refunded amount of this payment'
+ format: float
+ example: '10.00'
+ adjustment:
+ description: 'The amount the client balance is adjusted by'
type: number
- example: 10
+ format: float
+ example: '10.00'
updated_at:
description: Timestamp
type: number
format: integer
example: '1434342123'
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- company_gateway_id:
- description: 'The company gateway id'
- type: string
- example: '3'
- paymentables:
- $ref: '#/components/schemas/Paymentable'
- invoices:
- description: ''
- type: array
- items:
- $ref: '#/components/schemas/InvoicePaymentable'
- credits:
- description: ''
- type: array
- items:
- $ref: '#/components/schemas/CreditPaymentable'
- number:
- description: 'The payment number - is a unique alpha numeric number per payment per company'
- type: string
- example: PAY_101
- type: object
-
- Task:
- properties:
- id:
- description: 'The hashed id of the task'
- type: string
- example: Opnel5aKBz
- user_id:
- description: 'The hashed id of the user who created the task'
- type: string
- example: Opnel5aKBz
- assigned_user_id:
- description: 'The assigned user of the task'
- type: string
- example: Opnel5aKBz
- client_id:
- description: 'The hashed if of the client'
- type: string
- example: Opnel5aKBz
- invoice_id:
- description: 'The hashed id of the invoice associated with the task'
- type: string
- example: Opnel5aKBz
- project_id:
- description: 'The hashed id of the project associated with the task'
- type: string
- example: Opnel5aKBz
- number:
- description: 'The number of the task'
- type: string
- example: TASK-123
- time_log:
- description: 'An array of unix time stamps defining the start and end times of the task'
- type: string
- example: '[[1,2],[3,4]]'
- is_running:
- description: 'Determines if the task is still running'
- type: boolean
- example: true
- is_deleted:
- description: 'Boolean flag determining if the task has been deleted'
- type: boolean
- example: true
- task_status_id:
- description: 'The hashed id of the task status'
- type: string
- example: Opnel5aKBz
- description:
- description: 'The task description'
- type: string
- example: 'A wonder task to work on'
- duration:
- description: 'The task duration in seconds'
- type: integer
- example: '3600'
- task_status_order:
- description: 'The order of the task'
- type: integer
- example: '4'
- rate:
- description: 'The task rate'
- type: number
- example: 10.00
- custom_value1:
- description: 'A custom value'
- type: string
- example: '2022-10-10'
- custom_value2:
- description: 'A custom value'
- type: string
- example: $1100
- custom_value3:
- description: 'A custom value'
- type: string
- example: 'I need help'
- custom_value4:
- description: 'A custom value'
- type: string
- example: INV-3343
- is_date_based:
- description: 'Boolean flag determining if the task is date based'
- type: boolean
- example: true
- calculated_start_date:
- description: 'The calculated start date of the task'
- type: string
- example: '2022-10-10'
- readOnly: true
- invoice_documents:
- description: "Boolean flags which determines whether to include the task documents on the invoice"
- type: boolean
- example: true
created_at:
description: Timestamp
type: number
format: integer
example: '1434342123'
- readOnly: true
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
type: object
RecurringInvoice:
properties:
@@ -18468,408 +17487,64 @@ components:
example: true
type: object
- InvoiceItem:
- type: object
- properties:
- quantity:
- type: number
- example: 1
- description: 'The quantity of the product offered for this line item'
- cost:
- type: number
- format: float
- example: 10.00
- description: 'The cost of the product offered for this line item'
- product_key:
- type: string
- example: 'Product key'
- description: 'The product key of the product offered for this line item (Referred to as Product in the product tab)'
- product_cost:
- type: number
- format: float
- example: 10.00
- description: 'The cost of the product offered for this line item (Referred to as Cost in the product tab)'
- notes:
- type: string
- example: 'Item notes'
- description: 'The notes/description for the product offered for this line item'
- discount:
- type: number
- format: float
- example: 5.00
- description: 'The discount applied to the product offered for this line item'
- is_amount_discount:
- type: boolean
- example: false
- description: 'Indicates whether the discount applied to the product offered for this line item is a fixed amount or a percentage'
- tax_name1:
- type: string
- example: 'GST'
- description: 'The name of the first tax applied to the product offered for this line item'
- tax_rate1:
- type: number
- format: float
- example: 10.00
- description: 'The rate of the first tax applied to the product offered for this line item'
- tax_name2:
- type: string
- example: 'VAT'
- description: 'The name of the second tax applied to the product offered for this line item'
- tax_rate2:
- type: number
- format: float
- example: 5.00
- description: 'The rate of the second tax applied to the product offered for this line item'
- tax_name3:
- type: string
- example: 'CA Sales Tax'
- description: 'The name of the third tax applied to the product offered for this line item'
- tax_rate3:
- type: number
- format: float
- example: 3.00
- description: 'The rate of the third tax applied to the product offered for this line item'
- sort_id:
- type: string
- example: '0'
- description: 'Deprecated'
- deprecated: true
- line_total:
- type: number
- format: float
- example: 10.00
- description: 'The total amount of the product offered for this line item'
- readOnly: true
- gross_line_total:
- type: number
- format: float
- example: 15.00
- description: 'The total amount of the product offered for this line item before discounts'
- readOnly: true
- tax_amount:
- type: number
- format: float
- example: 1.00
- description: 'The total amount of tax applied to the product offered for this line item'
- readOnly: true
- date:
- type: string
- format: date-time
- example: '2023-03-19T00:00:00Z'
- description: 'Deprecated'
- deprecated: true
- custom_value1:
- type: string
- example: 'Custom value 1'
- description: 'The first custom value of the product offered for this line item'
- custom_value2:
- type: string
- example: 'Custom value 2'
- description: 'The second custom value of the product offered for this line item'
- custom_value3:
- type: string
- example: 'Custom value 3'
- description: 'The third custom value of the product offered for this line item'
- custom_value4:
- type: string
- example: 'Custom value 4'
- description: 'The fourth custom value of the product offered for this line item'
- type_id:
- type: string
- example: '1'
- description: '1 = product, 2 = service, 3 unpaid gateway fee, 4 paid gateway fee, 5 late fee, 6 expense'
- default: '1'
- tax_id:
- type: string
- example: '1'
- default: '1'
- description: 'The tax ID of the product: 1 product, 2 service, 3 digital, 4 shipping, 5 exempt, 5 reduced tax, 7 override, 8 zero rate, 9 reverse tax'
- Activity:
+ Payment:
properties:
id:
- description: 'The id field of the activity'
- type: string
- example: Opnel5aKBz
- activity_type_id:
- description: 'The activity type id'
+ description: 'The payment hashed id'
type: string
example: Opnel5aKBz
client_id:
description: 'The client hashed id'
type: string
example: Opnel5aKBz
- company_id:
- description: 'The company hashed id'
+ invitation_id:
+ description: 'The invitation hashed id'
+ type: string
+ example: Opnel5aKBz
+ client_contact_id:
+ description: 'The client contact hashed id'
type: string
example: Opnel5aKBz
user_id:
description: 'The user hashed id'
type: string
example: Opnel5aKBz
- invoice_id:
- description: 'The invoice hashed id'
- type: string
- example: Opnel5aKBz
- payment_id:
- description: 'The payment hashed id'
- type: string
- example: Opnel5aKBz
- credit_id:
- description: 'The credit hashed id'
- type: string
- example: Opnel5aKBz
- updated_at:
- description: 'Unixtimestamp the last time the record was updated'
- type: integer
- example: '343421434'
- expense_id:
- description: 'The expense hashed id'
- type: string
- example: Opnel5aKBz
- is_system:
- description: 'Defines is the activity was performed by the system'
- type: boolean
- example: true
- contact_id:
- description: 'The contact hashed id'
- type: string
- example: Opnel5aKBz
- task_id:
- description: 'The task hashed id'
- type: string
- example: Opnel5aKBz
- notes:
- description: 'Activity Notes'
- type: string
- example: Opnel5aKBz
- token_id:
- description: 'The hashed ID of the token who performed the action'
- type: string
- example: Opnel5aKBz
- ip:
- description: 'The IP Address of the user who performed the action'
- type: string
- example: 192.168.1.252
- user:
- $ref: '#/components/schemas/User'
- client:
- $ref: '#/components/schemas/Client'
- contact:
- $ref: '#/components/schemas/ClientContact'
- recurring_invoice:
- $ref: '#/components/schemas/RecurringInvoice'
- invoice:
- $ref: '#/components/schemas/Invoice'
- credit:
- $ref: '#/components/schemas/Credit'
- quote:
- $ref: '#/components/schemas/Quote'
- payment:
- $ref: '#/components/schemas/Payment'
- expense:
- $ref: '#/components/schemas/Expense'
- task:
- $ref: '#/components/schemas/Task'
- purchase_order:
- $ref: '#/components/schemas/PurchaseOrder'
- vendor:
- $ref: '#/components/schemas/Vendor'
- vendor_contact:
- $ref: '#/components/schemas/VendorContact'
- type: object
-
- ProductBulkAction:
- required:
- - action
- - ids
- properties:
- action:
- type: string
- example: archive
- description: 'The action to perform ie. archive / restore / delete / set_tax_id'
- ids:
- type: array
- items:
- format: string
- type: string
- example: 2J234DFA,D2J234DFA,D2J234DFA
- description: string array of client hashed ids
- tax_id:
+ type_id:
+ description: 'The Payment Type ID'
type: string
example: '1'
- description: |
- The tax rate id to set on the list of products
-
- The following constants are available (default = '1')
-
- ```
- PRODUCT_TYPE_PHYSICAL = '1'
- PRODUCT_TYPE_SERVICE = '2'
- PRODUCT_TYPE_DIGITAL = '3'
- PRODUCT_TYPE_SHIPPING = '4'
- PRODUCT_TYPE_EXEMPT = '5'
- PRODUCT_TYPE_REDUCED_TAX = '6'
- PRODUCT_TYPE_OVERRIDE_TAX = '7'
- PRODUCT_TYPE_ZERO_RATED = '8'
- PRODUCT_TYPE_REVERSE_TAX = '9'
- ```
- type: object
- RecurringExpense:
- properties:
- id:
- description: 'The hashed id of the recurring expense'
- type: string
- example: Opnel5aKBz
- user_id:
- description: 'The hashed id of the user who created the recurring expense'
- type: string
- example: Opnel5aKBz
- assigned_user_id:
- description: 'The hashed id of the user assigned to this recurring expense'
- type: string
- example: Opnel5aKBz
- client_id:
- description: 'The hashed id of the client'
- type: string
- example: Opnel5aKBz
- invoice_id:
- description: 'The hashed id of the invoice'
- type: string
- example: Opnel5aKBz
- bank_id:
- description: 'The id of the bank associated with this recurring expense'
- type: string
- example: '22'
- invoice_currency_id:
- description: 'The currency id of the invoice associated with this recurring expense'
- type: string
- example: '1'
- expense_currency_id:
- description: 'The currency id of the expense associated with this recurring expense'
- type: string
- example: '1'
- invoice_category_id:
- description: 'The category id of the invoice'
- type: string
- example: '1'
- payment_type_id:
- description: 'The payment type id'
- type: string
- example: '1'
- private_notes:
- description: 'The recurring expense private notes'
- type: string
- example: 'Private and confidential'
- public_notes:
- description: 'The recurring expense public notes'
- type: string
- example: 'This is the best client in the world'
- transaction_reference:
- description: 'The recurring expense transaction reference'
- type: string
- example: EXP-1223-2333
- transcation_id:
- description: 'The transaction id of the recurring expense'
- type: string
- example: '1233312312'
- custom_value1:
- description: 'Custom value field'
- type: string
- example: $1000
- custom_value2:
- description: 'Custom value field'
- type: string
- example: '2022-10-10'
- custom_value3:
- description: 'Custom value field'
- type: string
- example: 'short text'
- custom_value4:
- description: 'Custom value field'
- type: string
- example: 'very long text'
- tax_name1:
- description: 'The tax name'
- type: string
- example: GST
- tax_name2:
- description: 'The tax name'
- type: string
- example: VAT
- tax_rate1:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- tax_rate2:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- tax_name3:
- description: 'The tax name'
- type: string
- example: ''
- tax_rate3:
- description: 'The tax rate'
- type: number
- format: float
- example: '10.00'
- amount:
- description: 'The total amount of the recurring expense'
- type: number
- format: float
- example: '10.00'
- frequency_id:
- description: 'The frequency this recurring expense fires'
- type: number
- format: int
- example: '1'
- remaining_cycles:
- description: 'The number of remaining cycles for this recurring expense'
- type: number
- format: int
- example: '1'
- foreign_amount:
- description: 'The foreign currency amount of the recurring expense'
- type: number
- format: float
- example: '10.00'
- exchange_rate:
- description: 'The exchange rate for the expernse'
- type: number
- format: float
- example: '0.80'
date:
- description: 'The date of the expense'
+ description: 'The Payment date'
type: string
- example: ''
- payment_date:
- description: 'The date the expense was paid'
+ example: 1-1-2014
+ transaction_reference:
+ description: 'The transaction reference as defined by the payment gateway'
type: string
- example: ''
- should_be_invoiced:
- description: 'Boolean flag determining if the expense should be invoiced'
+ example: xcsSxcs124asd
+ assigned_user_id:
+ description: 'The assigned user hashed id'
+ type: string
+ example: Opnel5aKBz
+ private_notes:
+ description: 'The private notes of the payment'
+ type: string
+ example: 'The payment was refunded due to error'
+ is_manual:
+ description: 'Flags whether the payment was made manually or processed via a gateway'
type: boolean
example: true
is_deleted:
- description: 'Boolean flag determining if the recurring expense is deleted'
- type: boolean
- example: true
- last_sent_date:
- description: 'The Date it was sent last'
- type: string
- format: date
- example: '1994-07-30'
- next_send_date:
- description: 'The next send date'
- type: string
- format: date
- example: '1994-07-30'
- invoice_documents:
- description: 'Boolean flag determining if the documents associated with this expense should be passed onto the invoice if it is converted to an invoice'
+ description: 'Defines if the payment has been deleted'
type: boolean
example: true
+ amount:
+ description: 'The amount of this payment'
+ type: number
+ example: 10
+ refunded:
+ description: 'The refunded amount of this payment'
+ type: number
+ example: 10
updated_at:
description: Timestamp
type: number
@@ -18880,17 +17555,338 @@ components:
type: number
format: integer
example: '1434342123'
+ company_gateway_id:
+ description: 'The company gateway id'
+ type: string
+ example: '3'
+ paymentables:
+ $ref: '#/components/schemas/Paymentable'
+ invoices:
+ description: ''
+ type: array
+ items:
+ $ref: '#/components/schemas/InvoicePaymentable'
+ credits:
+ description: ''
+ type: array
+ items:
+ $ref: '#/components/schemas/CreditPaymentable'
+ number:
+ description: 'The payment number - is a unique alpha numeric number per payment per company'
+ type: string
+ example: PAY_101
type: object
- PaymentTerm:
+
+ Credit:
properties:
- num_days:
- description: 'The payment term length in days'
+ id:
+ description: "The unique hashed ID of the credit"
+ type: string
+ example: Opnel5aKBz
+ user_id:
+ description: "The unique hashed ID of the user associated with the credit"
+ type: string
+ example: 1a2b3c4d5e
+ assigned_user_id:
+ description: "The unique hashed ID of the assigned user responsible for the credit"
+ type: string
+ example: 6f7g8h9i0j
+ client_id:
+ description: "The unique hashed ID of the client associated with the credit"
+ type: string
+ example: p1q2r3s4t5
+ status_id:
+ description: "The ID representing the current status of the credit"
+ type: string
+ example: 3
+ invoice_id:
+ description: "The unique hashed ID of the linked invoice to which the credit is applied"
+ type: string
+ example: u1v2w3x4y5
+ number:
+ description: "The unique alphanumeric credit number per company"
+ type: string
+ example: QUOTE_101
+ po_number:
+ description: "The purchase order number referred to by the credit"
+ type: string
+ example: PO_12345
+ terms:
+ description: "The terms associated with the credit"
+ type: string
+ example: "Net 30"
+ public_notes:
+ description: "Public notes for the credit"
+ type: string
+ example: "Thank you for your business."
+ private_notes:
+ description: "Private notes for internal use, not visible to the client"
+ type: string
+ example: "Client is requesting a discount."
+ footer:
+ description: "The footer text for the credit"
+ type: string
+ example: "Footer text goes here."
+ custom_value1:
+ description: "Custom value 1 for additional credit information"
+ type: string
+ example: "Custom data 1"
+ custom_value2:
+ description: "Custom value 2 for additional credit information"
+ type: string
+ example: "Custom data 2"
+ custom_value3:
+ description: "Custom value 3 for additional credit information"
+ type: string
+ example: "Custom data 3"
+ custom_value4:
+ description: "Custom value 4 for additional credit information"
+ type: string
+ example: "Custom data 4"
+ tax_name1:
+ description: "The name of the first tax applied to the credit"
+ type: string
+ example: "VAT"
+ tax_name2:
+ description: "The name of the second tax applied to the credit"
+ type: string
+ example: "GST"
+ tax_rate1:
+ description: "The rate of the first tax applied to the credit"
+ type: number
+ format: float
+ example: 10.00
+ tax_rate2:
+ description: "The rate of the second tax applied to the credit"
+ type: number
+ format: float
+ example: 5.00
+ tax_name3:
+ description: "The name of the third tax applied to the credit"
+ type: string
+ example: "PST"
+ tax_rate3:
+ description: "The rate of the third tax applied to the credit"
+ type: number
+ format: float
+ example: 8.00
+ total_taxes:
+ description: "The total amount of taxes for the credit"
+ type: number
+ format: float
+ example: 23.00
+ line_items:
+ type: array
+ description: 'An array of objects which define the line items of the credit'
+ items:
+ $ref: '#/components/schemas/InvoiceItem'
+ amount:
+ description: "The total amount of the credit"
+ type: number
+ format: float
+ example: 100.00
+ balance:
+ description: "The outstanding balance of the credit"
+ type: number
+ format: float
+ example: 50.00
+ paid_to_date:
+ description: "The total amount paid to date for the credit"
+ type: number
+ format: float
+ example: 50.00
+ discount:
+ description: "The discount applied to the credit"
+ type: number
+ format: float
+ example: 10.00
+ partial:
+ description: "The partial amount applied to the credit"
+ type: number
+ format: float
+ example: 20.00
+ is_amount_discount:
+ description: "Indicates whether the discount applied is a fixed amount or a percentage"
+ type: boolean
+ example: true
+ is_deleted:
+ description: "Indicates whether the credit has been deleted"
+ type: boolean
+ example: false
+ uses_inclusive_taxes:
+ description: "Indicates whether the tax rates applied to the credit are inclusive or exclusive"
+ type: boolean
+ example: true
+ date:
+ description: "The date the credit was issued"
+ type: string
+ format: date
+ example: "1994-07-30"
+ last_sent_date:
+ description: "The date the credit was last sent out"
+ type: string
+ format: date
+ example: "1994-07-30"
+ next_send_date:
+ description: "The next scheduled date for sending a credit reminder"
+ type: string
+ format: date
+ example: "1994-07-30"
+ partial_due_date:
+ description: "The due date for the partial amount of the credit"
+ type: string
+ format: date
+ example: "1994-07-30"
+ due_date:
+ description: "The due date for the total amount of the credit"
+ type: string
+ format: date
+ example: "1994-07-30"
+ settings:
+ $ref: "#/components/schemas/CompanySettings"
+ last_viewed:
+ description: "The timestamp of the last time the credit was viewed"
+ type: number
+ format: integer
+ example: 1434342123
+ updated_at:
+ description: "The timestamp of the last time the credit was updated"
+ type: number
+ format: integer
+ example: 1434342123
+ archived_at:
+ description: "The timestamp of the last time the credit was archived"
+ type: number
+ format: integer
+ example: 1434342123
+ custom_surcharge1:
+ description: "First custom surcharge amount"
+ type: number
+ format: float
+ example: 10.00
+ custom_surcharge2:
+ description: 'Second Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge3:
+ description: 'Third Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge4:
+ description: 'Fourth Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge_tax1:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax2:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax3:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax4:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ type: object
+ Subscription:
+ properties:
+ id:
+ description: Unique identifier for the subscription
+ type: string
+ example: Opnel5aKBz
+ user_id:
+ description: Unique identifier for the user associated with the subscription
+ type: string
+ example: Ua6Rw4pVbS
+ product_id:
+ description: Unique identifier for the product associated with the subscription
+ type: string
+ example: Pr5Ft7yBmC
+ recurring_invoice_id:
+ description: Unique identifier for the recurring invoice associated with the subscription
+ type: string
+ example: Ri2Yt8zJkP
+ is_recurring:
+ description: Indicates whether the subscription is recurring
+ type: boolean
+ example: 'true'
+ frequency_id:
+ description: 'integer const representation of the frequency'
+ type: string
+ example: '1'
+ auto_bill:
+ description: 'enum setting'
+ type: string
+ example: always
+ promo_code:
+ description: Promotional code applied to the subscription
+ type: string
+ example: PROMOCODE4U
+ promo_discount:
+ description: Discount percentage or amount applied to the subscription
+ type: number
+ example: 10
+ is_amount_discount:
+ description: Indicates whether the discount is a fixed amount
+ type: boolean
+ example: 'true'
+ allow_cancellation:
+ description: Indicates whether the subscription can be cancelled
+ type: boolean
+ example: 'true'
+ per_seat_enabled:
+ description: Indicates whether the subscription pricing is per seat
+ type: boolean
+ example: 'true'
+ currency_id:
+ description: Unique identifier for the currency used in the subscription
type: integer
example: '1'
- name:
- description: 'The payment term length in string format'
+ max_seats_limit:
+ description: Maximum number of seats allowed for the subscription
+ type: integer
+ example: '100'
+ trial_enabled:
+ description: Indicates whether the subscription has a trial period
+ type: boolean
+ example: 'true'
+ trial_duration:
+ description: Duration of the trial period in days
+ type: integer
+ example: '14'
+ allow_query_overrides:
+ description: Indicates whether query overrides are allowed for the subscription
+ type: boolean
+ example: 'true'
+ allow_plan_changes:
+ description: Indicates whether plan changes are allowed for the subscription
+ type: boolean
+ example: 'true'
+ refund_period:
+ description: Number of days within which refunds can be requested
+ type: integer
+ example: '30'
+ webhook_configuration:
+ description: Webhook configuration for the subscription
type: string
- example: 'NET 1'
+ example: 'expand reference for this'
+ is_deleted:
+ description: Indicates whether the subscription has been deleted
+ type: boolean
+ example: 'false'
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
created_at:
description: Timestamp
type: number
@@ -18901,335 +17897,978 @@ components:
type: number
format: integer
example: '134341234234'
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
type: object
- ClientGatewayToken:
+ BulkAction:
+ type: array
+ items:
+ type: integer
+ example: '[0,1,2,3,]'
+ Project:
+ type: object
properties:
id:
- description: 'The hashed id of the client gateway token'
+ description: 'The project hashed id'
type: string
example: Opnel5aKBz
- client_id:
- description: 'The hashed_id of the client'
- type: string
- example: '2'
- token:
- description: 'The payment token'
- type: string
- example: '2'
- routing_number:
- description: 'THe bank account routing number'
- type: string
- example: '2'
- company_gateway_id:
- description: 'The hashed id of the company gateway'
- type: string
- example: '2'
- is_default:
- description: 'Flag determining if the token is the default payment method'
- type: boolean
- example: 'true'
- type: object
- User:
- properties:
- id:
- description: 'The hashed id of the user'
- type: string
- example: Opnel5aKBz
- readOnly: true
- first_name:
- description: 'The first name of the user'
- type: string
- example: Brad
- last_name:
- description: 'The last name of the user'
- type: string
- example: Pitt
- email:
- description: 'The users email address'
- type: string
- example: brad@pitt.com
- phone:
- description: 'The users phone number'
- type: string
- example: 555-1233-23232
- signature:
- description: 'The users sign off signature'
- type: string
- example: 'Have a nice day!'
- avatar:
- description: 'The users avatar'
- type: string
- example: 'https://url.to.your/avatar.png'
- accepted_terms_version:
- description: 'The version of the invoice ninja terms that has been accepted by the user'
- type: string
- example: 1.0.1
- readOnly: true
- oauth_user_id:
- description: 'The provider id of the oauth entity'
- type: string
- example: jkhasdf789as6f675sdf768sdfs
- readOnly: true
- oauth_provider_id:
- description: 'The oauth entity id'
- type: string
- example: google
- readOnly: true
- language_id:
- description: 'The language id of the user'
- type: string
- example: 1
- verified_phone_number:
- description: 'Boolean flag if the user has their phone verified. Required to settings up 2FA'
- type: boolean
- example: true
- readOnly: true
- sms_verification_code:
- description: 'The sms verification code for the user. Required to settings up 2FA'
- type: string
- example: '123456'
- readOnly: true
- oauth_user_token_expiry:
- description: 'The expiry date of the oauth token'
- type: string
- example: '2022-10-10'
- readOnly: true
- has_password:
- description: 'Boolean flag determining if the user has a password'
- type: boolean
- example: true
- readOnly: true
- last_confirmed_email_address:
- description: 'The last confirmed email address of the user'
- type: string
- example: 'bob@gmail.com'
- readOnly: true
- custom_value1:
- description: 'A custom value'
- type: string
- example: 'Custom value 1'
- custom_value2:
- description: 'A custom value'
- type: string
- example: '$1000'
- custom_value3:
- description: 'A custom value'
- type: string
- example: 'Custom value 3'
- custom_value4:
- description: 'A custom value'
- type: string
- example: 'Custom value 4'
- is_deleted:
- description: 'Boolean flag determining if the user has been deleted'
- type: boolean
- example: true
- readOnly: true
- google_2fa_secret:
- description: 'The google 2fa secret for the user'
- type: string
- example: '123456'
- readOnly: true
- company_user:
- $ref: '#/components/schemas/CompanyUserRef'
- type: object
- UserRef:
- properties:
- id:
- description: 'The hashed id of the user'
- type: string
- example: Opnel5aKBz
- readOnly: true
- first_name:
- description: 'The first name of the user'
- type: string
- example: Brad
- last_name:
- description: 'The last name of the user'
- type: string
- example: Pitt
- email:
- description: 'The users email address'
- type: string
- example: brad@pitt.com
- phone:
- description: 'The users phone number'
- type: string
- example: 555-1233-23232
- signature:
- description: 'The users sign off signature'
- type: string
- example: 'Have a nice day!'
- avatar:
- description: 'The users avatar'
- type: string
- example: 'https://url.to.your/avatar.png'
- accepted_terms_version:
- description: 'The version of the invoice ninja terms that has been accepted by the user'
- type: string
- example: 1.0.1
- readOnly: true
- oauth_user_id:
- description: 'The provider id of the oauth entity'
- type: string
- example: jkhasdf789as6f675sdf768sdfs
- readOnly: true
- oauth_provider_id:
- description: 'The oauth entity id'
- type: string
- example: google
- readOnly: true
- language_id:
- description: 'The language id of the user'
- type: string
- example: 1
- verified_phone_number:
- description: 'Boolean flag if the user has their phone verified. Required to settings up 2FA'
- type: boolean
- example: true
- readOnly: true
- sms_verification_code:
- description: 'The sms verification code for the user. Required to settings up 2FA'
- type: string
- example: '123456'
- readOnly: true
- oauth_user_token_expiry:
- description: 'The expiry date of the oauth token'
- type: string
- example: '2022-10-10'
- readOnly: true
- has_password:
- description: 'Boolean flag determining if the user has a password'
- type: boolean
- example: true
- readOnly: true
- last_confirmed_email_address:
- description: 'The last confirmed email address of the user'
- type: string
- example: 'bob@gmail.com'
- readOnly: true
- custom_value1:
- description: 'A custom value'
- type: string
- example: 'Custom value 1'
- custom_value2:
- description: 'A custom value'
- type: string
- example: '$1000'
- custom_value3:
- description: 'A custom value'
- type: string
- example: 'Custom value 3'
- custom_value4:
- description: 'A custom value'
- type: string
- example: 'Custom value 4'
- is_deleted:
- description: 'Boolean flag determining if the user has been deleted'
- type: boolean
- example: true
- readOnly: true
- google_2fa_secret:
- description: 'The google 2fa secret for the user'
- type: string
- example: '123456'
- readOnly: true
- type: object
- CompanyGateway:
- properties:
- id:
- description: 'The hashed id of the company gateway'
- type: string
- example: Opnel5aKBz
- gateway_key:
- description: 'The gateway key (hash)'
- type: string
- example: '2'
- accepted_credit_cards:
- description: 'Bitmask representation of cards'
- type: integer
- example: '32'
- require_billing_address:
- description: 'Determines if the the billing address is required prior to payment.'
- type: boolean
- example: true
- require_shipping_address:
- description: 'Determines if the the billing address is required prior to payment.'
- type: boolean
- example: true
- config:
- description: 'The configuration map for the gateway'
- type: string
- example: dfadsfdsafsafd
- update_details:
- description: 'Determines if the client details should be updated.'
- type: boolean
- example: true
- fees_and_limits:
- description: 'A mapped collection of the fees and limits for the configured gateway'
- type: array
- items:
- $ref: '#/components/schemas/FeesAndLimits'
- type: object
-
-
- Document:
- properties:
- id:
- description: 'The document hashed id'
- type: string
- example: AS3df3A
user_id:
description: 'The user hashed id'
type: string
- example: ''
+ example: Opnel5aKBz
assigned_user_id:
- description: 'The assigned user hashed id'
+ description: The assigned user identifier associated with the project
type: string
- example: ''
- project_id:
- description: 'The project associated with this document'
+ example: Opnel5aKBz
+ client_id:
type: string
- example: ''
- vendor_id:
- description: 'The vendor associated with this documents'
- type: string
- example: ''
+ example: Opnel5aKBz
+ description: The client identifier associated with the project
name:
- description: 'The document name'
type: string
- example: Beauty
- url:
- description: 'The document url'
+ description: The name of the project
+ example: 'New Project'
+ task_rate:
+ type: number
+ format: float
+ example: 10
+ description: The default rate per task for the project
+ due_date:
type: string
- example: Beauty
- preview:
- description: 'The document preview url'
+ format: date
+ example: '2019-01-01'
+ description: The due date for the project
+ private_notes:
type: string
- example: Beauty
- type:
- description: 'The document type'
+ description: Private notes associated with the project
+ budgeted_hours:
+ type: number
+ format: float
+ description: The number of budgeted hours for the project
+ custom_value1:
type: string
- example: Beauty
- disk:
- description: 'The document disk'
+ description: Custom value field 1
+ custom_value2:
type: string
- example: Beauty
- hash:
- description: 'The document hashed'
+ description: Custom value field 2
+ custom_value3:
type: string
- example: Beauty
+ description: Custom value field 3
+ custom_value4:
+ type: string
+ description: Custom value field 4
+ created_at:
+ type: number
+ format: integer
+ example: 134341234234
+ description: The timestamp of the project creation
+ updated_at:
+ type: number
+ format: integer
+ example: 134341234234
+ description: The timestamp of the last project update
+ archived_at:
+ type: number
+ format: integer
+ example: 134341234234
+ description: The timestamp of the project deletion
+ public_notes:
+ type: string
+ description: Public notes associated with the project
is_deleted:
- description: 'Flag to determine if the document is deleted'
+ type: boolean
+ description: A flag indicating if the project is deleted
+ number:
+ type: string
+ description: The project number
+ color:
+ type: string
+ description: The color associated with the project
+ required:
+ - id
+ - user_id
+ - name
+ - task_rate
+ - budgeted_hours
+ - is_deleted
+ - color
+
+ CompanySettings:
+ required:
+ - currency_id
+ properties:
+ currency_id:
+ description: "The default currency id"
+ type: string
+ example: true
+ timezone_id:
+ description: "The timezone id"
+ type: string
+ example: "15"
+ date_format_id:
+ description: "The date format id"
+ type: string
+ example: "15"
+ military_time:
+ description: "Toggles 12/24 hour time"
+ type: boolean
+ example: true
+ language_id:
+ description: "The language id"
+ type: string
+ example: "1"
+ show_currency_code:
+ description: "Toggles whether the currency symbol or code is shown"
+ type: boolean
+ example: true
+ payment_terms:
+ description: "-1 sets no payment term, 0 sets payment due immediately, positive integers indicates payment terms in days"
+ type: integer
+ example: "1"
+ company_gateway_ids:
+ description: "A commad separate list of available gateways"
+ type: string
+ example: "1,2,3,4"
+ custom_value1:
+ description: "A Custom Label"
+ type: string
+ example: "Custom Label"
+ custom_value2:
+ description: "A Custom Label"
+ type: string
+ example: "Custom Label"
+ custom_value3:
+ description: "A Custom Label"
+ type: string
+ example: "Custom Label"
+ custom_value4:
+ description: "A Custom Label"
+ type: string
+ example: "Custom Label"
+ default_task_rate:
+ description: "The default task rate"
+ type: number
+ format: float
+ example: "10.00"
+ send_reminders:
+ description: "Toggles whether reminders are sent"
+ type: boolean
+ example: true
+ enable_client_portal_tasks:
+ description: "Show/hide the tasks panel in the client portal"
+ type: boolean
+ example: true
+ email_style:
+ description: "options include plain,light,dark,custom"
+ type: string
+ example: light
+ reply_to_email:
+ description: "The reply to email address"
+ type: string
+ example: email@gmail.com
+ bcc_email:
+ description: "A comma separate list of BCC emails"
+ type: string
+ example: "email@gmail.com, contact@gmail.com"
+ pdf_email_attachment:
+ description: "Toggles whether to attach PDF as attachment"
+ type: boolean
+ example: true
+ ubl_email_attachment:
+ description: "Toggles whether to attach UBL as attachment"
+ type: boolean
+ example: true
+ email_style_custom:
+ description: "The custom template"
+ type: string
+ example: ""
+ counter_number_applied:
+ description: "enum when the invoice number counter is set, ie when_saved, when_sent, when_paid"
+ type: string
+ example: when_sent
+ quote_number_applied:
+ description: "enum when the quote number counter is set, ie when_saved, when_sent"
+ type: string
+ example: when_sent
+ custom_message_dashboard:
+ description: "A custom message which is displayed on the dashboard"
+ type: string
+ example: "Please pay invoices immediately"
+ custom_message_unpaid_invoice:
+ description: "A custom message which is displayed in the client portal when a client is viewing a unpaid invoice."
+ type: string
+ example: "Please pay invoices immediately"
+ custom_message_paid_invoice:
+ description: "A custom message which is displayed in the client portal when a client is viewing a paid invoice."
+ type: string
+ example: "Thanks for paying this invoice!"
+ custom_message_unapproved_quote:
+ description: "A custom message which is displayed in the client portal when a client is viewing a unapproved quote."
+ type: string
+ example: "Please approve quote"
+ lock_invoices:
+ description: "Toggles whether invoices are locked once sent and cannot be modified further"
+ type: enum
+ enum: [off, when_sent, when_paid, end_of_month]
+ example: 'off'
+ auto_archive_invoice:
+ description: "Toggles whether a invoice is archived immediately following payment"
+ type: boolean
+ example: true
+ auto_archive_quote:
+ description: "Toggles whether a quote is archived after being converted to a invoice"
+ type: boolean
+ example: true
+ auto_convert_quote:
+ description: "Toggles whether a quote is converted to a invoice when approved"
+ type: boolean
+ example: true
+ inclusive_taxes:
+ description: "Boolean flag determining whether inclusive or exclusive taxes are used"
+ type: boolean
+ example: true
+ translations:
+ description: "JSON payload of customized translations"
+ type: object
+ example: ""
+ task_number_pattern:
+ description: "Allows customisation of the task number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ task_number_counter:
+ description: "The incrementing counter for tasks"
+ type: integer
+ example: "1"
+ reminder_send_time:
+ description: "Time from UTC +0 when the email will be sent to the client"
+ type: integer
+ example: "32400"
+ expense_number_pattern:
+ description: "Allows customisation of the expense number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ expense_number_counter:
+ description: "The incrementing counter for expenses"
+ type: integer
+ example: "1"
+ vendor_number_pattern:
+ description: "Allows customisation of the vendor number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ vendor_number_counter:
+ description: "The incrementing counter for vendors"
+ type: integer
+ example: "1"
+ ticket_number_pattern:
+ description: "Allows customisation of the ticket number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ ticket_number_counter:
+ description: "The incrementing counter for tickets"
+ type: integer
+ example: "1"
+ payment_number_pattern:
+ description: "Allows customisation of the payment number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ payment_number_counter:
+ description: "The incrementing counter for payments"
+ type: integer
+ example: "1"
+ invoice_number_pattern:
+ description: "Allows customisation of the invoice number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ invoice_number_counter:
+ description: "The incrementing counter for invoices"
+ type: integer
+ example: "1"
+ quote_number_pattern:
+ description: "Allows customisation of the quote number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ quote_number_counter:
+ description: "The incrementing counter for quotes"
+ type: integer
+ example: "1"
+ client_number_pattern:
+ description: "Allows customisation of the client number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ client_number_counter:
+ description: "The incrementing counter for clients"
+ type: integer
+ example: "1"
+ credit_number_pattern:
+ description: "Allows customisation of the credit number pattern"
+ type: string
+ example: "{$year}-{$counter}"
+ credit_number_counter:
+ description: "The incrementing counter for credits"
+ type: integer
+ example: "1"
+ recurring_invoice_number_prefix:
+ description: "This string is prepended to the recurring invoice number"
+ type: string
+ example: R
+ reset_counter_frequency_id:
+ description: "CONSTANT which is used to apply the frequency which the counters are reset"
+ type: integer
+ example: "1"
+ reset_counter_date:
+ description: "The explicit date which is used to reset counters"
+ type: string
+ example: "2019-01-01"
+ counter_padding:
+ description: "Pads the counter with leading zeros"
+ type: integer
+ example: "1"
+ shared_invoice_quote_counter:
+ description: "Flags whether to share the counter for invoices and quotes"
+ type: boolean
+ example: true
+ update_products:
+ description: "Determines if client fields are updated from third party APIs"
+ type: boolean
+ example: true
+ convert_products:
+ description: ""
+ type: boolean
+ example: true
+ fill_products:
+ description: "Automatically fill products based on product_key"
+ type: boolean
+ example: true
+ invoice_terms:
+ description: "The default invoice terms"
+ type: string
+ example: "Invoice Terms are..."
+ quote_terms:
+ description: "The default quote terms"
+ type: string
+ example: "Quote Terms are..."
+ invoice_taxes:
+ description: "The number of Taxes that can be applied to the invoice"
+ type: number
+ example: "1"
+ invoice_design_id:
+ description: "The default design id (invoice, quote etc)"
+ type: string
+ example: "1"
+ quote_design_id:
+ description: "The default design id (invoice, quote etc)"
+ type: string
+ example: "1"
+ invoice_footer:
+ description: "The default invoice footer"
+ type: string
+ example: "1"
+ invoice_labels:
+ description: "JSON string of invoice labels"
+ type: string
+ example: "1"
+ tax_rate1:
+ description: "The tax rate (float)"
+ type: number
+ example: "10"
+ tax_name1:
+ description: "The tax name"
+ type: string
+ example: GST
+ tax_rate2:
+ description: "The tax rate (float)"
+ type: number
+ example: "10"
+ tax_name2:
+ description: "The tax name"
+ type: string
+ example: GST
+ tax_rate3:
+ description: "The tax rate (float)"
+ type: number
+ example: "10"
+ tax_name3:
+ description: "The tax name"
+ type: string
+ example: GST
+ payment_type_id:
+ description: "The default payment type id"
+ type: string
+ example: "1"
+ custom_fields:
+ description: "JSON string of custom fields"
+ type: string
+ example: "{}"
+ email_footer:
+ description: "The default email footer"
+ type: string
+ example: "A default email footer"
+ email_sending_method:
+ description: "The email driver to use to send email, options include default, gmail, client_postmark, client_mailgun, client_brevo, office365"
+ type: string
+ enum: [default, gmail, office365, client_postmark, client_mailgun, mailgun, client_brevo]
+ example: 'default'
+ gmail_sending_user_id:
+ description: "The hashed_id of the user account to send email from"
+ type: string
+ example: F76sd34D
+ email_subject_invoice:
+ description: ""
+ type: string
+ example: "Your Invoice Subject"
+ email_subject_quote:
+ description: ""
+ type: string
+ example: "Your Quote Subject"
+ email_subject_payment:
+ description: ""
+ type: string
+ example: "Your Payment Subject"
+ email_template_invoice:
+ description: "The full template for invoice emails"
+ type: string
+ example: ""
+ email_template_quote:
+ description: "The full template for quote emails"
+ type: string
+ example: ""
+ email_template_payment:
+ description: "The full template for payment emails"
+ type: string
+ example: ""
+ email_subject_reminder1:
+ description: "Email subject for Reminder"
+ type: string
+ example: ""
+ email_subject_reminder2:
+ description: "Email subject for Reminder"
+ type: string
+ example: ""
+ email_subject_reminder3:
+ description: "Email subject for Reminder"
+ type: string
+ example: ""
+ email_subject_reminder_endless:
+ description: "Email subject for endless reminders"
+ type: string
+ example: ""
+ email_template_reminder1:
+ description: "The full template for Reminder 1"
+ type: string
+ example: ""
+ email_template_reminder2:
+ description: "The full template for Reminder 2"
+ type: string
+ example: ""
+ email_template_reminder3:
+ description: "The full template for Reminder 3"
+ type: string
+ example: ""
+ email_template_reminder_endless:
+ description: "The full template for enless reminders"
+ type: string
+ example: ""
+ enable_portal_password:
+ description: "Toggles whether a password is required to log into the client portal"
+ type: boolean
+ example: true
+ show_accept_invoice_terms:
+ description: "Toggles whether the terms dialogue is shown to the client"
+ type: boolean
+ example: true
+ show_accept_quote_terms:
+ description: "Toggles whether the terms dialogue is shown to the client"
+ type: boolean
+ example: true
+ require_invoice_signature:
+ description: "Toggles whether a invoice signature is required"
+ type: boolean
+ example: true
+ require_quote_signature:
+ description: "Toggles whether a quote signature is required"
+ type: boolean
+ example: true
+ name:
+ description: "The company name"
+ type: string
+ example: "Acme Co"
+ company_logo:
+ description: "The company logo file"
+ type: object
+ example: logo.png
+ website:
+ description: "The company website URL"
+ type: string
+ example: www.acme.com
+ address1:
+ description: "The company address line 1"
+ type: string
+ example: "Suite 888"
+ address2:
+ description: "The company address line 2"
+ type: string
+ example: "5 Jimbo Way"
+ city:
+ description: "The company city"
+ type: string
+ example: Sydney
+ state:
+ description: "The company state"
+ type: string
+ example: Florisa
+ postal_code:
+ description: "The company zip/postal code"
+ type: string
+ example: "90210"
+ phone:
+ description: "The company phone"
+ type: string
+ example: 555-213-3948
+ email:
+ description: "The company email"
+ type: string
+ example: joe@acme.co
+ country_id:
+ description: "The country ID"
+ type: string
+ example: "1"
+ vat_number:
+ description: "The company VAT/TAX ID number"
+ type: string
+ example: "32 120 377 720"
+ page_size:
+ description: "The default page size"
+ type: string
+ example: A4
+ font_size:
+ description: "The font size"
+ type: number
+ example: "9"
+ primary_font:
+ description: "The primary font"
+ type: string
+ example: roboto
+ secondary_font:
+ description: "The secondary font"
+ type: string
+ example: roboto
+ hide_paid_to_date:
+ description: "Flags whether to hide the paid to date field"
+ type: boolean
+ example: false
+ embed_documents:
+ description: "Toggled whether to embed documents in the PDF"
+ type: boolean
+ example: false
+ all_pages_header:
+ description: "The header for the PDF"
+ type: boolean
+ example: false
+ all_pages_footer:
+ description: "The footer for the PDF"
+ type: boolean
+ example: false
+ document_email_attachment:
+ description: "Toggles whether to attach documents in the email"
+ type: boolean
+ example: false
+ enable_client_portal_password:
+ description: "Toggles password protection of the client portal"
+ type: boolean
+ example: false
+ enable_email_markup:
+ description: "Toggles the use of markdown in emails"
+ type: boolean
+ example: false
+ enable_client_portal_dashboard:
+ description: "Toggles whether the client dashboard is shown in the client portal"
+ type: boolean
+ example: false
+ enable_client_portal:
+ description: "Toggles whether the entire client portal is displayed to the client, or only the context"
+ type: boolean
+ example: false
+ email_template_statement:
+ description: "The body of the email for statements"
+ type: string
+ example: "template matter"
+ email_subject_statement:
+ description: "The subject of the email for statements"
+ type: string
+ example: "subject matter"
+ signature_on_pdf:
+ description: "Toggles whether the signature (if available) is displayed on the PDF"
+ type: boolean
+ example: false
+ quote_footer:
+ description: "The default quote footer"
+ type: string
+ example: "the quote footer"
+ email_subject_custom1:
+ description: "Custom reminder template subject"
+ type: string
+ example: "Custom Subject 1"
+ email_subject_custom2:
+ description: "Custom reminder template subject"
+ type: string
+ example: "Custom Subject 2"
+ email_subject_custom3:
+ description: "Custom reminder template subject"
+ type: string
+ example: "Custom Subject 3"
+ email_template_custom1:
+ description: "Custom reminder template body"
+ type: string
+ example: ""
+ email_template_custom2:
+ description: "Custom reminder template body"
+ type: string
+ example: ""
+ email_template_custom3:
+ description: "Custom reminder template body"
+ type: string
+ example: ""
+ enable_reminder1:
+ description: "Toggles whether this reminder is enabled"
+ type: boolean
+ example: false
+ enable_reminder2:
+ description: "Toggles whether this reminder is enabled"
+ type: boolean
+ example: false
+ enable_reminder3:
+ description: "Toggles whether this reminder is enabled"
+ type: boolean
+ example: false
+ num_days_reminder1:
+ description: "The Reminder interval"
+ type: number
+ example: "9"
+ num_days_reminder2:
+ description: "The Reminder interval"
+ type: number
+ example: "9"
+ num_days_reminder3:
+ description: "The Reminder interval"
+ type: number
+ example: "9"
+ schedule_reminder1:
+ description: "(enum: after_invoice_date, before_due_date, after_due_date)"
+ type: string
+ example: after_invoice_date
+ schedule_reminder2:
+ description: "(enum: after_invoice_date, before_due_date, after_due_date)"
+ type: string
+ example: after_invoice_date
+ schedule_reminder3:
+ description: "(enum: after_invoice_date, before_due_date, after_due_date)"
+ type: string
+ example: after_invoice_date
+ late_fee_amount1:
+ description: "The late fee amount for reminder 1"
+ type: number
+ example: 10
+ late_fee_amount2:
+ description: "The late fee amount for reminder 2"
+ type: number
+ example: 20
+ late_fee_amount3:
+ description: "The late fee amount for reminder 2"
+ type: number
+ example: 100
+ endless_reminder_frequency_id:
+ description: "The frequency id of the endless reminder"
+ type: string
+ example: "1"
+ client_online_payment_notification:
+ description: "Determines if a client should receive the notification for a online payment"
+ type: boolean
+ example: false
+ client_manual_payment_notification:
+ description: "Determines if a client should receive the notification for a manually entered payment"
+ type: boolean
+ example: false
+ enable_e_invoice:
+ description: "Determines if e-invoicing is enabled"
+ type: boolean
+ example: false
+ default_expense_payment_type_id:
+ description: "The default payment type for expenses"
+ type: string
+ example: "0"
+ e_invoice_type:
+ description: "The e-invoice type"
+ type: string
+ example: "EN16931"
+ mailgun_endpoint:
+ description: "The mailgun endpoint - used to determine whether US or EU endpoints are used"
+ type: string
+ example: "api.mailgun.net or api.eu.mailgun.net"
+ client_initiated_payments:
+ description: "Determines if clients can initiate payments directly from the client portal"
+ type: boolean
+ example: false
+ client_initiated_payments_minimum:
+ description: "The minimum amount a client can pay"
+ type: number
+ example: 10
+ sync_invoice_quote_columns:
+ description: "Determines if invoice and quote columns are synced for the PDF rendering, or if they use their own columns"
+ type: boolean
+ example: false
+ show_task_item_description:
+ description: "Determines if the task item description is shown on the invoice"
+ type: boolean
+ example: false
+ allow_billable_task_items:
+ description: "Determines if task items can be marked as billable"
+ type: boolean
+ example: false
+ accept_client_input_quote_approval:
+ description: "Determines if clients can approve quotes and also pass through a PO Number reference"
+ type: boolean
+ example: false
+ custom_sending_email:
+ description: "When using Mailgun or Postmark, the FROM email address can be customized using this setting."
+ type: string
+ example: "bob@gmail.com"
+ show_paid_stamp:
+ description: "Determines if the PAID stamp is shown on the invoice"
+ type: boolean
+ example: false
+ show_shipping_address:
+ description: "Determines if the shipping address is shown on the invoice"
+ type: boolean
+ example: false
+ company_logo_size:
+ description: "The size of the company logo on the PDF - percentage value between 0 and 100"
+ type: number
+ example: 100
+ show_email_footer:
+ description: "Determines if the email footer is shown on emails"
+ type: boolean
+ example: false
+ email_alignment:
+ description: "The alignment of the email body text, options include left / center / right"
+ type: string
+ example: "left"
+ auto_bill_standard_invoices:
+ description: "Determines if standard invoices are automatically billed when they are created or due"
+ type: boolean
+ example: false
+ postmark_secret:
+ description: "The Postmark secret API key"
+ type: string
+ example: "123456"
+ mailgun_secret:
+ description: "The Mailgun secret API key"
+ type: string
+ example: "123456"
+ mailgun_domain:
+ description: "The Mailgun domain"
+ type: string
+ example: "sandbox123456.mailgun.org"
+ send_email_on_mark_paid:
+ description: "Determines if an email is sent when an invoice is marked as paid"
+ type: boolean
+ example: false
+ vendor_portal_enable_uploads:
+ description: "Determines if vendors can upload files to the portal"
+ type: boolean
+ example: false
+ besr_id:
+ description: "The BESR ID"
+ type: string
+ example: "123456"
+ qr_iban:
+ description: "The IBAN for the QR code"
+ type: string
+ example: "CH123456"
+ email_subject_purchase_order:
+ description: "The email subject for purchase orders"
+ type: string
+ example: "Purchase Order"
+ email_template_purchase_order:
+ description: "The email template for purchase orders"
+ type: string
+ example: "Please see attached your purchase order."
+ require_purchase_order_signature:
+ description: "Determines if a signature is required on purchase orders"
+ type: boolean
+ example: false
+ purchase_order_public_notes:
+ description: "The public notes for purchase orders"
+ type: string
+ example: "Please see attached your purchase order."
+ purchase_order_terms:
+ description: "The terms for purchase orders"
+ type: string
+ example: "Please see attached your purchase order."
+ purchase_order_footer:
+ description: "The footer for purchase orders"
+ type: string
+ example: "Please see attached your purchase order."
+ purchase_order_design_id:
+ description: "The design id for purchase orders"
+ type: string
+ example: "hd677df"
+ purchase_order_number_pattern:
+ description: "The pattern for purchase order numbers"
+ type: string
+ example: "PO-000000"
+ purchase_order_number_counter:
+ description: "The counter for purchase order numbers"
+ type: number
+ example: 1
+ page_numbering_alignment:
+ description: "The alignment for page numbering: options include left / center / right"
+ type: string
+ example: "left"
+ page_numbering:
+ description: "Determines if page numbering is enabled on Document PDFs"
+ type: boolean
+ example: false
+ auto_archive_invoice_cancelled:
+ description: "Determines if invoices are automatically archived when they are cancelled"
+ type: boolean
+ example: false
+ email_from_name:
+ description: "The FROM name for emails when using Custom emailers"
+ type: string
+ example: "Bob Smith"
+ show_all_tasks_client_portal:
+ description: "Determines if all tasks are shown on the client portal"
+ type: boolean
+ example: false
+ entity_send_time:
+ description: "The time that emails are sent. The time is localized to the clients locale, integer values from 1 - 24"
+ type: integer
+ example: 9
+ shared_invoice_credit_counter:
+ description: "Determines if the invoice and credit counter are shared"
+ type: boolean
+ example: false
+ reply_to_name:
+ description: "The reply to name for emails"
+ type: string
+ example: "Bob Smith"
+ hide_empty_columns_on_pdf:
+ description: "Determines if empty columns are hidden on PDFs"
+ type: boolean
+ example: false
+ enable_reminder_endless:
+ description: "Determines if endless reminders are enabled"
+ type: boolean
+ example: false
+ use_credits_payment:
+ description: "Determines if credits can be used as a payment method"
+ type: boolean
+ example: false
+ recurring_invoice_number_pattern:
+ description: "The pattern for recurring invoice numbers"
+ type: string
+ example: "R-000000"
+ recurring_invoice_number_counter:
+ description: "The counter for recurring invoice numbers"
+ type: number
+ example: 1
+ client_portal_under_payment_minimum:
+ description: "The minimum payment payment"
+ type: number
+ example: 10
+ auto_bill_date:
+ description: "Determines when the invoices are auto billed, options are on_send_date (when the invoice is sent) or on_due_date (when the invoice is due))"
+ type: string
+ example: "on_send_date"
+ primary_color:
+ description: "The primary color for the client portal / document highlights"
+ type: string
+ example: "#ffffff"
+ secondary_color:
+ description: "The secondary color for the client portal / document highlights"
+ type: string
+ example: "#ffffff"
+ client_portal_allow_under_payment:
+ description: "Determines if clients can pay invoices under the invoice amount due"
+ type: boolean
+ example: false
+ client_portal_allow_over_payment:
+ description: "Determines if clients can pay invoices over the invoice amount"
+ type: boolean
+ example: false
+ auto_bill:
+ description: "Determines how autobilling is applied for recurring invoices. off (no auto billed), always (always auto bill), optin (The user must opt in to auto billing), optout (The user must opt out of auto billing"
+ type: string
+ example: "off"
+ client_portal_terms:
+ description: "The terms which are displayed on the client portal"
+ type: string
+ example: "Please see attached your invoice."
+ client_portal_privacy_policy:
+ description: "The privacy policy which is displayed on the client portal"
+ type: string
+ example: "These are the terms of use for using the client portal."
+ client_can_register:
+ description: "Determines if clients can register on the client portal"
+ type: boolean
+ example: false
+ portal_design_id:
+ description: "The design id for the client portal"
+ type: string
+ example: "hd677df"
+ late_fee_endless_percent:
+ description: "The late fee percentage for endless late fees"
+ type: number
+ example: 10
+ late_fee_endless_amount:
+ description: "The late fee amount for endless late fees"
+ type: number
+ example: 10
+ auto_email_invoice:
+ description: "Determines if invoices are automatically emailed when they are created"
+ type: boolean
+ example: false
+ email_signature:
+ description: "The email signature for emails"
+ type: string
+ example: "Bob Smith"
+ classification:
+ description: "The classification for the company"
+ type: string
+ example: "individual"
+ valid_until:
+ description: 'Default validity period for quotes'
+ type: string
+ credit_terms:
+ description: 'Default terms for credit notes'
+ type: string
+ credit_footer:
+ description: 'Default footer for credit notes'
+ type: string
+ type: object
+
+ Design:
+ properties:
+ id:
+ description: 'The design hashed id'
+ type: string
+ example: AS3df3A
+ name:
+ description: 'The design name'
+ type: string
+ example: Beauty
+ design:
+ description: 'The design HTML'
+ type: string
+ example: ''
+ is_custom:
+ description: 'Flag to determine if the design is a custom user design'
type: boolean
example: true
- is_default:
- description: 'Flag to determine if the document is a default doc'
+ is_active:
+ description: 'Flag to determine if the design is available for use'
+ type: boolean
+ example: true
+ is_deleted:
+ description: 'Flag to determine if the design is deleted'
type: boolean
example: true
created_at:
@@ -19248,223 +18887,6 @@ components:
format: integer
example: '134341234234'
type: object
- PurchaseOrder:
- properties:
- id:
- description: 'The unique hashed identifier for the purchase order'
- type: string
- example: Opnel5aKBz
- user_id:
- description: 'The unique hashed identifier for the user who created the purchase order'
- type: string
- example: ''
- assigned_user_id:
- description: 'The unique hashed identifier for the user assigned to the purchase order'
- type: string
- example: ''
- vendor_id:
- description: 'The unique hashed identifier for the vendor associated with the purchase order'
- type: string
- example: ''
- status_id:
- description: 'The status of the purchase order represented by a unique identifier'
- type: string
- example: ''
- number:
- description: 'The unique alpha-numeric purchase order number per company'
- type: string
- example: PO_101
- quote_number:
- description: 'The quote number associated with this purchase order'
- type: string
- example: QUOTE_101
- terms:
- description: 'The terms and conditions for the purchase order'
- type: string
- example: 'These are some purchase order terms. Valid for 14 days.'
- public_notes:
- description: 'Publicly visible notes associated with the purchase order'
- type: string
- example: 'These are public notes which the vendor may see'
- private_notes:
- description: 'Privately visible notes associated with the purchase order, not disclosed to the vendor'
- type: string
- example: 'These are private notes, not to be disclosed to the vendor'
- footer:
- description: 'The footer text of the purchase order'
- type: string
- example: 'The text goes in the footer of the purchase order'
- custom_value1:
- description: 'First custom value field for additional information'
- type: string
- example: 'A custom value'
- custom_value2:
- description: 'Second custom value field for additional information'
- type: string
- example: 'A custom value'
- custom_value3:
- description: 'Third custom value field for additional information'
- type: string
- example: 'A custom value'
- custom_value4:
- description: 'Fourth custom value field for additional information'
- type: string
- example: 'A custom value'
- tax_name1:
- description: 'The name of the first tax applied to the purchase order'
- type: string
- example: GST
- tax_name2:
- description: 'The name of the second tax applied to the purchase order'
- type: string
- example: VAT
- tax_rate1:
- description: 'The rate of the first tax applied to the purchase order'
- type: number
- format: float
- example: 10.00
- tax_rate2:
- description: 'The rate of the second tax applied to the purchase order'
- type: number
- format: float
- example: 10.00
- tax_name3:
- description: 'The name of the third tax applied to the purchase order'
- type: string
- example: ''
- tax_rate3:
- description: 'The rate of the third tax applied to the purchase order'
- type: number
- format: float
- example: 10.00
- total_taxes:
- description: 'The total amount of taxes applied to the purchase order'
- type: number
- format: float
- example: 10.00
- line_items:
- type: array
- description: 'An array of objects which define the line items of the purchase order'
- items:
- $ref: '#/components/schemas/InvoiceItem'
- amount:
- description: 'The total amount of the purchase order before taxes and discounts'
- type: number
- format: float
- example: 10.00
- balance:
- description: 'The balance due for the purchase order after accounting for payments'
- type: number
- format: float
- example: 10.00
- paid_to_date:
- description: 'The total amount paid on the purchase order so far'
- type: number
- format: float
- example: 10.00
- discount:
- description: 'The discount amount or percentage applied to the purchase order'
- type: number
- format: float
- example: 10.00
- partial:
- description: 'The partial or deposit amount for the purchase order'
- type: number
- format: float
- example: 10.00
- is_amount_discount:
- description: 'Boolean flag indicating if the discount is a fixed amount or a percentage'
- type: boolean
- example: true
- is_deleted:
- description: 'Boolean flag indicating if the purchase order has been deleted'
- type: boolean
- example: false
- uses_inclusive_taxes:
- description: 'Boolean flag indicating if the taxes used are inclusive or exclusive'
- type: boolean
- example: true
- date:
- description: 'The date the purchase order was created'
- type: string
- format: date
- example: '1994-07-30'
- last_sent_date:
- description: 'The last date the purchase order was sent to the vendor'
- type: string
- format: date
- example: '1994-07-30'
- next_send_date:
- description: 'The next scheduled date for sending a reminder for the purchase order'
- type: string
- format: date
- example: '1994-07-30'
- partial_due_date:
- description: 'The due date for the partial or deposit amount'
- type: string
- format: date
- example: '1994-07-30'
- due_date:
- description: 'The due date for the total amount of the purchase order'
- type: string
- format: date
- example: '1994-07-30'
- settings:
- $ref: '#/components/schemas/CompanySettings'
- last_viewed:
- description: Timestamp
- type: number
- format: integer
- example: 1434342123
- updated_at:
- description: Timestamp
- type: number
- format: integer
- example: 1434342123
- archived_at:
- description: Timestamp
- type: number
- format: integer
- example: 1434342123
- custom_surcharge1:
- description: 'First custom surcharge amount for the purchase order'
- type: number
- format: float
- example: 10.00
- custom_surcharge2:
- description: 'Second custom surcharge amount for the purchase order'
- type: number
- format: float
- example: 10.00
- custom_surcharge3:
- description: 'Third custom surcharge amount for the purchase order'
- type: number
- format: float
- example: 10.00
- custom_surcharge4:
- description: 'Fourth custom surcharge amount for the purchase order'
- type: number
- format: float
- example: 10.00
- custom_surcharge_tax1:
- description: 'Boolean flag indicating if taxes are charged on the first custom surcharge amount'
- type: boolean
- example: true
- custom_surcharge_tax2:
- description: 'Boolean flag indicating if taxes are charged on the second custom surcharge amount'
- type: boolean
- example: true
- custom_surcharge_tax3:
- description: 'Boolean flag indicating if taxes are charged on the third custom surcharge amount'
- type: boolean
- example: true
- custom_surcharge_tax4:
- description: 'Boolean flag indicating if taxes are charged on the fourth custom surcharge amount'
- type: boolean
- example: true
- type: object
-
-
ClientSettings:
required:
- currency_id
@@ -20299,6 +19721,547 @@ components:
type: string
example: 'Bob Smith'
type: object
+ BTRules:
+ properties:
+ data_key:
+ description: 'The key to search'
+ type: string
+ example: 'description,amount'
+ operator:
+ description: 'The operator flag of the search'
+ type: string
+ example: '>'
+ value:
+ description: 'The value to search for'
+ type: string
+ example: bob
+ type: object
+ Account:
+ properties:
+ id:
+ description: 'The account hashed id'
+ type: string
+ example: AS3df3A
+ account_sms_verified:
+ description: 'Boolean flag if the account has been verified by sms'
+ type: string
+ example: true
+ type: object
+ Invoice:
+ properties:
+ id:
+ description: 'The invoice hashed id'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ assigned_user_id:
+ description: 'The assigned user hashed id'
+ type: string
+ example: Opnel5aKBz
+ client_id:
+ description: 'The client hashed id'
+ type: string
+ example: Opnel5aKBz
+ status_id:
+ description: 'The invoice status variable'
+ type: string
+ example: '4'
+ number:
+ description: 'The invoice number - is a unique alpha numeric number per invoice per company'
+ type: string
+ example: INV_101
+ po_number:
+ description: 'The purchase order associated with this invoice'
+ type: string
+ example: PO-1234
+ terms:
+ description: 'The invoice terms'
+ type: string
+ example: 'These are invoice terms'
+ public_notes:
+ description: 'The public notes of the invoice'
+ type: string
+ example: 'These are some public notes'
+ private_notes:
+ description: 'The private notes of the invoice'
+ type: string
+ example: 'These are some private notes'
+ footer:
+ description: 'The invoice footer notes'
+ type: string
+ example: ''
+ custom_value1:
+ description: 'A custom field value'
+ type: string
+ example: '2022-10-01'
+ custom_value2:
+ description: 'A custom field value'
+ type: string
+ example: 'Something custom'
+ custom_value3:
+ description: 'A custom field value'
+ type: string
+ example: ''
+ custom_value4:
+ description: 'A custom field value'
+ type: string
+ example: ''
+ tax_name1:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_name2:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_rate1:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_rate2:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_name3:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_rate3:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ total_taxes:
+ description: 'The total taxes for the invoice'
+ type: number
+ format: float
+ example: '10.00'
+ line_items:
+ type: array
+ description: 'An array of objects which define the line items of the invoice'
+ items:
+ $ref: '#/components/schemas/InvoiceItem'
+ invitations:
+ type: array
+ description: 'An array of objects which define the invitations of the invoice'
+ items:
+ $ref: '#/components/schemas/InvoiceInvitation'
+ amount:
+ description: 'The invoice amount'
+ type: number
+ format: float
+ example: '10.00'
+ balance:
+ description: 'The invoice balance'
+ type: number
+ format: float
+ example: '10.00'
+ paid_to_date:
+ description: 'The amount paid on the invoice to date'
+ type: number
+ format: float
+ example: '10.00'
+ discount:
+ description: 'The invoice discount, can be an amount or a percentage'
+ type: number
+ format: float
+ example: '10.00'
+ partial:
+ description: 'The deposit/partial amount'
+ type: number
+ format: float
+ example: '10.00'
+ is_amount_discount:
+ description: 'Flag determining if the discount is an amount or a percentage'
+ type: boolean
+ example: true
+ is_deleted:
+ description: 'Defines if the invoice has been deleted'
+ type: boolean
+ example: true
+ uses_inclusive_taxes:
+ description: 'Defines the type of taxes used as either inclusive or exclusive'
+ type: boolean
+ example: true
+ date:
+ description: 'The Invoice Date'
+ type: string
+ format: date
+ example: '1994-07-30'
+ last_sent_date:
+ description: 'The last date the invoice was sent out'
+ type: string
+ format: date
+ example: '1994-07-30'
+ next_send_date:
+ description: 'The Next date for a reminder to be sent'
+ type: string
+ format: date
+ example: '1994-07-30'
+ partial_due_date:
+ description: 'The due date for the deposit/partial amount'
+ type: string
+ format: date
+ example: '1994-07-30'
+ due_date:
+ description: 'The due date of the invoice'
+ type: string
+ format: date
+ example: '1994-07-30'
+ last_viewed:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ custom_surcharge1:
+ description: 'First Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge2:
+ description: 'Second Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge3:
+ description: 'Third Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge4:
+ description: 'Fourth Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge_tax1:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax2:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax3:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax4:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ project_id:
+ description: 'The project associated with this invoice'
+ type: string
+ example: Opnel5aKBz
+ auto_bill_tries:
+ description: 'The number of times the invoice has attempted to be auto billed'
+ type: integer
+ example: '1'
+ readOnly: true
+ auto_bill_enabled:
+ description: 'Boolean flag determining if the invoice is set to auto bill'
+ type: boolean
+ example: true
+ subscription_id:
+ description: 'The subscription associated with this invoice'
+ type: string
+ example: Opnel5aKBz
+
+ type: object
+ ClientRequest:
+ required:
+ - contacts
+ - country_id
+ properties:
+ id:
+ description: 'The unique identifier of the client'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ contacts:
+ type: array
+ description: 'A list of contacts associated with the client'
+ items:
+ $ref: '#/components/schemas/ClientContactRequest'
+ name:
+ description: 'The name of the client company or organization'
+ type: string
+ example: "Jim's Housekeeping"
+ website:
+ description: 'The website URL of the client company or organization'
+ type: string
+ example: 'https://www.jims-housekeeping.com'
+ private_notes:
+ description: 'Notes that are only visible to the user who created the client'
+ type: string
+ example: 'Client prefers email communication over phone calls'
+ industry_id:
+ description: 'The unique identifier of the industry the client operates in'
+ type: number
+ example: '5'
+ size_id:
+ description: 'The unique identifier for the size category of the client company or organization'
+ type: number
+ example: '2'
+ address1:
+ description: "First line of the client's address"
+ type: string
+ example: '123 Main St'
+ address2:
+ description: "Second line of the client's address, if needed"
+ type: string
+ example: 'Apt 4B'
+ city:
+ description: 'The city the client is located in'
+ type: string
+ example: 'Beverly Hills'
+ state:
+ description: 'The state, province, or locality the client is located in'
+ type: string
+ example: 'California'
+ postal_code:
+ description: 'The postal code or ZIP code of the client'
+ type: string
+ example: '90210'
+ phone:
+ description: "The client's phone number"
+ type: string
+ example: '555-3434-3434'
+ country_id:
+ description: "The unique identifier of the client's country"
+ type: number
+ format: integer
+ example: '1'
+ custom_value1:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'Preferred contact: Email'
+ custom_value2:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'Account manager: John Doe'
+ custom_value3:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'VIP client: Yes'
+ custom_value4:
+ description: 'A custom field for storing additional information'
+ type: string
+ example: 'Annual contract value: $50,000'
+ vat_number:
+ description: "The client's VAT (Value Added Tax) number, if applicable"
+ type: string
+ example: 'VAT123456'
+ id_number:
+ description: 'A unique identification number for the client, such as a tax ID or business registration number'
+ type: string
+ number:
+ description: 'A system-assigned unique number for the client, typically used for invoicing purposes'
+ type: string
+ example: 'CL-0001'
+ shipping_address1:
+ description: "First line of the client's shipping address"
+ type: string
+ example: '5 Wallaby Way'
+ shipping_address2:
+ description: "Second line of the client's shipping address, if needed"
+ type: string
+ example: 'Suite 5'
+ shipping_city:
+ description: "The city of the client's shipping address"
+ type: string
+ example: 'Perth'
+ shipping_state:
+ description: "The state, province, or locality of the client's shipping address"
+ type: string
+ example: 'Western Australia'
+ shipping_postal_code:
+ description: "The postal code or ZIP code of the client's shipping address"
+ type: string
+ example: '6110'
+ shipping_country_id:
+ description: "The unique identifier of the country for the client's shipping address"
+ type: number
+ format: integer
+ example: '4'
+ is_deleted:
+ description: 'A boolean value indicating whether the client has been deleted or not'
+ type: boolean
+ example: false
+ readOnly: true
+ group_settings_id:
+ description: 'The group settings assigned to the client'
+ type: string
+ example: Opnel5aKBz
+ routing_id:
+ description: 'The routing address id for e-invoicing for this client'
+ type: string
+ example: Opnel5aKBz3489-dfkiu-2239-sdsd
+ is_tax_exempt:
+ description: 'Flag which defines if the client is exempt from taxes'
+ type: boolean
+ example: false
+ has_valid_vat_number:
+ description: 'Flag which defines if the client has a valid VAT number'
+ type: boolean
+ example: false
+ classification:
+ description: 'The classification of the client'
+ type: string
+ example: 'individual'
+ settings:
+ $ref: '#/components/schemas/ClientSettings'
+ type: object
+ PaymentTerm:
+ properties:
+ num_days:
+ description: 'The payment term length in days'
+ type: integer
+ example: '1'
+ name:
+ description: 'The payment term length in string format'
+ type: string
+ example: 'NET 1'
+ created_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ type: object
+ ClientContactRequest:
+ properties:
+ id:
+ description: 'The hashed if of the contact'
+ type: string
+ example: Opnel5aKBz
+ readOnly: true
+ first_name:
+ description: 'The first name of the contact'
+ type: string
+ example: John
+ last_name:
+ description: 'The last name of the contact'
+ type: string
+ example: Doe
+ phone:
+ description: 'The phone number of the contact'
+ type: string
+ example: 555-152-4524
+ custom_value1:
+ description: 'A Custom field value'
+ type: string
+ example: ''
+ custom_value2:
+ description: 'A Custom field value'
+ type: string
+ example: ''
+ custom_value3:
+ description: 'A Custom field value'
+ type: string
+ example: ''
+ custom_value4:
+ description: 'A Custom field value'
+ type: string
+ example: ''
+ email:
+ description: 'The email of the contact'
+ type: string
+ example: ''
+ password:
+ description: 'The hashed password of the contact'
+ type: string
+ example: '*****'
+ send_email:
+ description: 'Boolean value determines is this contact should receive emails'
+ type: boolean
+ example: true
+ type: object
+
+ GenericBulkAction:
+ properties:
+ action:
+ type: string
+ example: archive
+ description: 'The action to perform ie. archive / restore / delete'
+ ids:
+ type: array
+ items:
+ format: string
+ type: string
+ example: 2J234DFA,D2J234DFA,D2J234DFA
+ description: string array of client hashed ids
+ type: object
+ BankTransactionRule:
+ properties:
+ id:
+ description: 'The bank transaction rules hashed id'
+ type: string
+ example: AS3df3A
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: AS3df3A
+ name:
+ description: 'The name of the transaction'
+ type: string
+ example: 'Rule 1'
+ rules:
+ description: 'A mapped collection of the sub rules for the BankTransactionRule'
+ type: array
+ items:
+ $ref: '#/components/schemas/BTRules'
+ auto_convert:
+ description: 'Flags whether the rule converts the transaction automatically'
+ type: boolean
+ example: true
+ matches_on_all:
+ description: 'Flags whether all subrules are required for the match'
+ type: boolean
+ example: true
+ applies_to:
+ description: 'Flags whether the rule applies to a CREDIT or DEBIT'
+ type: string
+ example: CREDIT
+ client_id:
+ description: 'The client hashed id'
+ type: string
+ example: AS3df3A
+ vendor_id:
+ description: 'The vendor hashed id'
+ type: string
+ example: AS3df3A
+ category_id:
+ description: 'The category hashed id'
+ type: string
+ example: AS3df3A
+ type: object
Product:
type: object
properties:
@@ -20456,1068 +20419,1110 @@ components:
```
example: '1'
- ClientContactRequest:
+ RecurringQuote:
properties:
id:
- description: 'The hashed if of the contact'
+ description: 'The hashed id of the recurring quote'
+ type: string
+ example: Opnel5aKBz
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: Opnel5aKBz
+ assigned_user_id:
+ description: 'The assigned user hashed id'
+ type: string
+ example: Opnel5aKBz
+ client_id:
+ description: 'The client hashed id'
+ type: string
+ example: Opnel5aKBz
+ status_id:
+ description: 'The quote status variable'
+ type: string
+ example: '4'
+ frequency_id:
+ description: 'The recurring quote frequency'
+ type: number
+ example: '4'
+ remaining_cycles:
+ description: 'The number of quotes left to be generated'
+ type: number
+ example: '4'
+ number:
+ description: 'The recurringquote number - is a unique alpha numeric number per quote per company'
+ type: string
+ example: INV_101
+ po_number:
+ description: 'The purchase order associated with this recurring quote'
+ type: string
+ example: PO-1234
+ terms:
+ description: 'The quote terms'
+ type: string
+ example: 'These are quote terms'
+ public_notes:
+ description: 'The public notes of the quote'
+ type: string
+ example: 'These are some public notes'
+ private_notes:
+ description: 'The private notes of the quote'
+ type: string
+ example: 'These are some private notes'
+ footer:
+ description: 'The quote footer notes'
+ type: string
+ example: ''
+ custom_value1:
+ description: 'A custom field value'
+ type: string
+ example: '2022-10-01'
+ custom_value2:
+ description: 'A custom field value'
+ type: string
+ example: 'Something custom'
+ custom_value3:
+ description: 'A custom field value'
+ type: string
+ example: ''
+ custom_value4:
+ description: 'A custom field value'
+ type: string
+ example: ''
+ tax_name1:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_name2:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_rate1:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_rate2:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_name3:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_rate3:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ total_taxes:
+ description: 'The total taxes for the quote'
+ type: number
+ format: float
+ example: '10.00'
+ line_items:
+ description: 'An array of objects which define the line items of the quote'
+ type: object
+ example: ''
+ amount:
+ description: 'The quote amount'
+ type: number
+ format: float
+ example: '10.00'
+ balance:
+ description: 'The quote balance'
+ type: number
+ format: float
+ example: '10.00'
+ paid_to_date:
+ description: 'The amount paid on the quote to date'
+ type: number
+ format: float
+ example: '10.00'
+ discount:
+ description: 'The quote discount, can be an amount or a percentage'
+ type: number
+ format: float
+ example: '10.00'
+ partial:
+ description: 'The deposit/partial amount'
+ type: number
+ format: float
+ example: '10.00'
+ is_amount_discount:
+ description: 'Flag determining if the discount is an amount or a percentage'
+ type: boolean
+ example: true
+ is_deleted:
+ description: 'Defines if the quote has been deleted'
+ type: boolean
+ example: true
+ uses_inclusive_taxes:
+ description: 'Defines the type of taxes used as either inclusive or exclusive'
+ type: boolean
+ example: true
+ date:
+ description: 'The quote Date'
+ type: string
+ format: date
+ example: '1994-07-30'
+ last_sent_date:
+ description: 'The last date the quote was sent out'
+ type: string
+ format: date
+ example: '1994-07-30'
+ next_send_date:
+ description: 'The Next date for a reminder to be sent'
+ type: string
+ format: date
+ example: '1994-07-30'
+ partial_due_date:
+ description: 'The due date for the deposit/partial amount'
+ type: string
+ format: date
+ example: '1994-07-30'
+ due_date:
+ description: 'The due date of the quote'
+ type: string
+ format: date
+ example: '1994-07-30'
+ settings:
+ $ref: '#/components/schemas/CompanySettings'
+ last_viewed:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ custom_surcharge1:
+ description: 'First Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge2:
+ description: 'Second Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge3:
+ description: 'Third Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge4:
+ description: 'Fourth Custom Surcharge'
+ type: number
+ format: float
+ example: '10.00'
+ custom_surcharge_tax1:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax2:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax3:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ custom_surcharge_tax4:
+ description: 'Toggles charging taxes on custom surcharge amounts'
+ type: boolean
+ example: true
+ type: object
+ Paymentable:
+ properties:
+ id:
+ description: 'The paymentable hashed id'
+ type: string
+ example: AS3df3A
+ invoice_id:
+ description: 'The invoice hashed id'
+ type: string
+ example: AS3df3A
+ credit_id:
+ description: 'The credit hashed id'
+ type: string
+ example: AS3df3A
+ refunded:
+ description: 'The amount that has been refunded for this payment'
+ type: number
+ format: float
+ example: '10.00'
+ amount:
+ description: 'The amount that has been applied to the payment'
+ type: number
+ format: float
+ example: '10.00'
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ created_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ type: object
+ SystemLog:
+ properties:
+ id:
+ description: 'The account hashed id'
+ type: string
+ example: AS3df3A
+ user_id:
+ description: 'The user_id hashed id'
+ type: string
+ example: AS3df3A
+ client_id:
+ description: 'The client_id hashed id'
+ type: string
+ example: AS3df3A
+ event_id:
+ description: 'The Log Type ID'
+ type: integer
+ example: 1
+ category_id:
+ description: 'The Category Type ID'
+ type: integer
+ example: 1
+ type_id:
+ description: 'The Type Type ID'
+ type: integer
+ example: 1
+ log:
+ description: 'The json object of the error'
+ type: object
+ example: '{''key'':''value''}'
+ updated_at:
+ description: Timestamp
+ type: string
+ example: '2'
+ created_at:
+ description: Timestamp
+ type: string
+ example: '2'
+ type: object
+ BankTransaction:
+ properties:
+ id:
+ description: 'The bank integration hashed id'
+ type: string
+ example: AS3df3A
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: AS3df3A
+ transaction_id:
+ description: 'The id of the transaction rule'
+ type: integer
+ example: 343434
+ amount:
+ description: 'The transaction amount'
+ type: number
+ example: 10
+ currency_id:
+ description: 'The currency ID of the currency'
+ type: string
+ example: '1'
+ account_type:
+ description: 'The account type'
+ type: string
+ example: creditCard
+ description:
+ description: 'The description of the transaction'
+ type: string
+ example: 'Potato purchases for kevin'
+ category_id:
+ description: 'The category id'
+ type: integer
+ example: 1
+ category_type:
+ description: 'The category description'
+ type: string
+ example: Expenses
+ base_type:
+ description: 'Either CREDIT or DEBIT'
+ type: string
+ example: CREDIT
+ date:
+ description: 'The date of the transaction'
+ type: string
+ example: '2022-09-01'
+ bank_account_id:
+ description: 'The ID number of the bank account'
+ type: integer
+ example: '1'
+ type: object
+
+ ProductBulkAction:
+ required:
+ - action
+ - ids
+ properties:
+ action:
+ type: string
+ example: archive
+ description: 'The action to perform ie. archive / restore / delete / set_tax_id'
+ ids:
+ type: array
+ items:
+ format: string
+ type: string
+ example: 2J234DFA,D2J234DFA,D2J234DFA
+ description: string array of client hashed ids
+ tax_id:
+ type: string
+ example: '1'
+ description: |
+ The tax rate id to set on the list of products
+
+ The following constants are available (default = '1')
+
+ ```
+ PRODUCT_TYPE_PHYSICAL = '1'
+ PRODUCT_TYPE_SERVICE = '2'
+ PRODUCT_TYPE_DIGITAL = '3'
+ PRODUCT_TYPE_SHIPPING = '4'
+ PRODUCT_TYPE_EXEMPT = '5'
+ PRODUCT_TYPE_REDUCED_TAX = '6'
+ PRODUCT_TYPE_OVERRIDE_TAX = '7'
+ PRODUCT_TYPE_ZERO_RATED = '8'
+ PRODUCT_TYPE_REVERSE_TAX = '9'
+ ```
+ type: object
+ FillableInvoice:
+ properties:
+ assigned_user_id:
+ description: "The assigned user's hashed ID"
+ type: string
+ example: 'a1b2c3d4'
+ client_id:
+ description: "The client's hashed ID"
+ type: string
+ example: 'x1y2z3a4'
+ number:
+ description: "The unique alphanumeric invoice number for each invoice per company"
+ type: string
+ example: INV_101
+ po_number:
+ description: "The purchase order number associated with the invoice"
+ type: string
+ example: 'PO12345'
+ terms:
+ description: "The terms and conditions for the invoice"
+ type: string
+ example: 'Net 30'
+ public_notes:
+ description: "Public notes visible to the client on the invoice"
+ type: string
+ example: 'Thank you for your business.'
+ private_notes:
+ description: "Private notes for internal use only"
+ type: string
+ example: 'Client is a slow payer.'
+ footer:
+ description: "The footer text displayed on the invoice"
+ type: string
+ example: 'Authorized Signature'
+ custom_value1:
+ description: "First custom value for additional information"
+ type: string
+ example: 'Project ABC'
+ custom_value2:
+ description: "Second custom value for additional information"
+ type: string
+ example: 'Department XYZ'
+ custom_value3:
+ description: "Third custom value for additional information"
+ type: string
+ example: 'Location 123'
+ custom_value4:
+ description: "Fourth custom value for additional information"
+ type: string
+ example: 'Currency USD'
+ tax_name1:
+ description: "Name of the first tax applied to the invoice"
+ type: string
+ example: 'VAT'
+ tax_name2:
+ description: "Name of the second tax applied to the invoice"
+ type: string
+ example: 'GST'
+ tax_rate1:
+ description: "Rate of the first tax applied to the invoice"
+ type: number
+ example: 10.00
+ tax_rate2:
+ description: "Rate of the second tax applied to the invoice"
+ type: number
+ example: 5.00
+ tax_name3:
+ description: "Name of the third tax applied to the invoice"
+ type: string
+ example: 'PST'
+ tax_rate3:
+ description: "Rate of the third tax applied to the invoice"
+ type: number
+ example: 8.00
+ line_items:
+ type: array
+ description: 'An array of objects which define the line items of the invoice'
+ items:
+ $ref: '#/components/schemas/InvoiceItem'
+ discount:
+ description: "The discount applied to the invoice"
+ type: number
+ example: 10.00
+ partial:
+ description: "The partial amount applied to the invoice"
+ type: number
+ example: 20.00
+ is_amount_discount:
+ description: "Indicates whether the discount applied is a fixed amount or a percentage"
+ type: boolean
+ example: true
+ uses_inclusive_taxes:
+ description: "Indicates whether the tax rates applied to the invoice are inclusive or exclusive"
+ type: boolean
+ example: true
+ date:
+ description: "The date the invoice was issued"
+ type: string
+ example: '1994-07-30'
+ partial_due_date:
+ description: "The due date for the partial payment"
+ type: string
+ example: '1994-08-15'
+ due_date:
+ description: "The due date for the invoice"
+ type: string
+ example: '1994-08-30'
+ custom_surcharge1:
+ description: "First custom surcharge applied to the invoice"
+ type: number
+ example: 10.00
+ custom_surcharge2:
+ description: "Second custom surcharge applied to the invoice"
+ type: number
+ example: 15.00
+ custom_surcharge3:
+ description: "Third custom surcharge applied to the invoice"
+ type: number
+ example: 5.00
+ custom_surcharge4:
+ description: "Fourth custom surcharge applied to the invoice"
+ type: number
+ example: 20.00
+ type: object
+ CompanyGateway:
+ properties:
+ id:
+ description: 'The hashed id of the company gateway'
+ type: string
+ example: Opnel5aKBz
+ gateway_key:
+ description: 'The gateway key (hash)'
+ type: string
+ example: '2'
+ accepted_credit_cards:
+ description: 'Bitmask representation of cards'
+ type: integer
+ example: '32'
+ require_billing_address:
+ description: 'Determines if the the billing address is required prior to payment.'
+ type: boolean
+ example: true
+ require_shipping_address:
+ description: 'Determines if the the billing address is required prior to payment.'
+ type: boolean
+ example: true
+ config:
+ description: 'The configuration map for the gateway'
+ type: string
+ example: dfadsfdsafsafd
+ update_details:
+ description: 'Determines if the client details should be updated.'
+ type: boolean
+ example: true
+ fees_and_limits:
+ description: 'A mapped collection of the fees and limits for the configured gateway'
+ type: array
+ items:
+ $ref: '#/components/schemas/FeesAndLimits'
+ type: object
+
+
+ Activity:
+ properties:
+ id:
+ description: 'The id field of the activity'
+ type: string
+ example: Opnel5aKBz
+ activity_type_id:
+ description: 'The activity type id'
+ type: string
+ example: Opnel5aKBz
+ client_id:
+ description: 'The client hashed id'
+ type: string
+ example: Opnel5aKBz
+ company_id:
+ description: 'The company hashed id'
+ type: string
+ example: Opnel5aKBz
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: Opnel5aKBz
+ invoice_id:
+ description: 'The invoice hashed id'
+ type: string
+ example: Opnel5aKBz
+ payment_id:
+ description: 'The payment hashed id'
+ type: string
+ example: Opnel5aKBz
+ credit_id:
+ description: 'The credit hashed id'
+ type: string
+ example: Opnel5aKBz
+ updated_at:
+ description: 'Unixtimestamp the last time the record was updated'
+ type: integer
+ example: '343421434'
+ expense_id:
+ description: 'The expense hashed id'
+ type: string
+ example: Opnel5aKBz
+ is_system:
+ description: 'Defines is the activity was performed by the system'
+ type: boolean
+ example: true
+ contact_id:
+ description: 'The contact hashed id'
+ type: string
+ example: Opnel5aKBz
+ task_id:
+ description: 'The task hashed id'
+ type: string
+ example: Opnel5aKBz
+ notes:
+ description: 'Activity Notes'
+ type: string
+ example: Opnel5aKBz
+ token_id:
+ description: 'The hashed ID of the token who performed the action'
+ type: string
+ example: Opnel5aKBz
+ ip:
+ description: 'The IP Address of the user who performed the action'
+ type: string
+ example: 192.168.1.252
+ user:
+ $ref: '#/components/schemas/User'
+ client:
+ $ref: '#/components/schemas/Client'
+ contact:
+ $ref: '#/components/schemas/ClientContact'
+ recurring_invoice:
+ $ref: '#/components/schemas/RecurringInvoice'
+ invoice:
+ $ref: '#/components/schemas/Invoice'
+ credit:
+ $ref: '#/components/schemas/Credit'
+ quote:
+ $ref: '#/components/schemas/Quote'
+ payment:
+ $ref: '#/components/schemas/Payment'
+ expense:
+ $ref: '#/components/schemas/Expense'
+ task:
+ $ref: '#/components/schemas/Task'
+ purchase_order:
+ $ref: '#/components/schemas/PurchaseOrder'
+ vendor:
+ $ref: '#/components/schemas/Vendor'
+ vendor_contact:
+ $ref: '#/components/schemas/VendorContact'
+ type: object
+ User:
+ properties:
+ id:
+ description: 'The hashed id of the user'
type: string
example: Opnel5aKBz
readOnly: true
first_name:
- description: 'The first name of the contact'
+ description: 'The first name of the user'
type: string
- example: John
+ example: Brad
last_name:
- description: 'The last name of the contact'
+ description: 'The last name of the user'
type: string
- example: Doe
- phone:
- description: 'The phone number of the contact'
- type: string
- example: 555-152-4524
- custom_value1:
- description: 'A Custom field value'
- type: string
- example: ''
- custom_value2:
- description: 'A Custom field value'
- type: string
- example: ''
- custom_value3:
- description: 'A Custom field value'
- type: string
- example: ''
- custom_value4:
- description: 'A Custom field value'
- type: string
- example: ''
+ example: Pitt
email:
- description: 'The email of the contact'
+ description: 'The users email address'
type: string
- example: ''
- password:
- description: 'The hashed password of the contact'
+ example: brad@pitt.com
+ phone:
+ description: 'The users phone number'
type: string
- example: '*****'
- send_email:
- description: 'Boolean value determines is this contact should receive emails'
+ example: 555-1233-23232
+ signature:
+ description: 'The users sign off signature'
+ type: string
+ example: 'Have a nice day!'
+ avatar:
+ description: 'The users avatar'
+ type: string
+ example: 'https://url.to.your/avatar.png'
+ accepted_terms_version:
+ description: 'The version of the invoice ninja terms that has been accepted by the user'
+ type: string
+ example: 1.0.1
+ readOnly: true
+ oauth_user_id:
+ description: 'The provider id of the oauth entity'
+ type: string
+ example: jkhasdf789as6f675sdf768sdfs
+ readOnly: true
+ oauth_provider_id:
+ description: 'The oauth entity id'
+ type: string
+ example: google
+ readOnly: true
+ language_id:
+ description: 'The language id of the user'
+ type: string
+ example: 1
+ verified_phone_number:
+ description: 'Boolean flag if the user has their phone verified. Required to settings up 2FA'
type: boolean
example: true
+ readOnly: true
+ sms_verification_code:
+ description: 'The sms verification code for the user. Required to settings up 2FA'
+ type: string
+ example: '123456'
+ readOnly: true
+ oauth_user_token_expiry:
+ description: 'The expiry date of the oauth token'
+ type: string
+ example: '2022-10-10'
+ readOnly: true
+ has_password:
+ description: 'Boolean flag determining if the user has a password'
+ type: boolean
+ example: true
+ readOnly: true
+ last_confirmed_email_address:
+ description: 'The last confirmed email address of the user'
+ type: string
+ example: 'bob@gmail.com'
+ readOnly: true
+ custom_value1:
+ description: 'A custom value'
+ type: string
+ example: 'Custom value 1'
+ custom_value2:
+ description: 'A custom value'
+ type: string
+ example: '$1000'
+ custom_value3:
+ description: 'A custom value'
+ type: string
+ example: 'Custom value 3'
+ custom_value4:
+ description: 'A custom value'
+ type: string
+ example: 'Custom value 4'
+ is_deleted:
+ description: 'Boolean flag determining if the user has been deleted'
+ type: boolean
+ example: true
+ readOnly: true
+ google_2fa_secret:
+ description: 'The google 2fa secret for the user'
+ type: string
+ example: '123456'
+ readOnly: true
+ company_user:
+ $ref: '#/components/schemas/CompanyUserRef'
type: object
- ClientRequest:
- required:
- - contacts
- - country_id
+ UserRef:
properties:
id:
- description: 'The unique identifier of the client'
+ description: 'The hashed id of the user'
type: string
example: Opnel5aKBz
readOnly: true
- contacts:
- type: array
- description: 'A list of contacts associated with the client'
- items:
- $ref: '#/components/schemas/ClientContactRequest'
- name:
- description: 'The name of the client company or organization'
+ first_name:
+ description: 'The first name of the user'
type: string
- example: "Jim's Housekeeping"
- website:
- description: 'The website URL of the client company or organization'
+ example: Brad
+ last_name:
+ description: 'The last name of the user'
type: string
- example: 'https://www.jims-housekeeping.com'
- private_notes:
- description: 'Notes that are only visible to the user who created the client'
+ example: Pitt
+ email:
+ description: 'The users email address'
type: string
- example: 'Client prefers email communication over phone calls'
- industry_id:
- description: 'The unique identifier of the industry the client operates in'
- type: number
- example: '5'
- size_id:
- description: 'The unique identifier for the size category of the client company or organization'
- type: number
- example: '2'
- address1:
- description: "First line of the client's address"
- type: string
- example: '123 Main St'
- address2:
- description: "Second line of the client's address, if needed"
- type: string
- example: 'Apt 4B'
- city:
- description: 'The city the client is located in'
- type: string
- example: 'Beverly Hills'
- state:
- description: 'The state, province, or locality the client is located in'
- type: string
- example: 'California'
- postal_code:
- description: 'The postal code or ZIP code of the client'
- type: string
- example: '90210'
+ example: brad@pitt.com
phone:
- description: "The client's phone number"
+ description: 'The users phone number'
type: string
- example: '555-3434-3434'
- country_id:
- description: "The unique identifier of the client's country"
- type: number
- format: integer
- example: '1'
- custom_value1:
- description: 'A custom field for storing additional information'
+ example: 555-1233-23232
+ signature:
+ description: 'The users sign off signature'
type: string
- example: 'Preferred contact: Email'
- custom_value2:
- description: 'A custom field for storing additional information'
+ example: 'Have a nice day!'
+ avatar:
+ description: 'The users avatar'
type: string
- example: 'Account manager: John Doe'
- custom_value3:
- description: 'A custom field for storing additional information'
+ example: 'https://url.to.your/avatar.png'
+ accepted_terms_version:
+ description: 'The version of the invoice ninja terms that has been accepted by the user'
type: string
- example: 'VIP client: Yes'
- custom_value4:
- description: 'A custom field for storing additional information'
- type: string
- example: 'Annual contract value: $50,000'
- vat_number:
- description: "The client's VAT (Value Added Tax) number, if applicable"
- type: string
- example: 'VAT123456'
- id_number:
- description: 'A unique identification number for the client, such as a tax ID or business registration number'
- type: string
- number:
- description: 'A system-assigned unique number for the client, typically used for invoicing purposes'
- type: string
- example: 'CL-0001'
- shipping_address1:
- description: "First line of the client's shipping address"
- type: string
- example: '5 Wallaby Way'
- shipping_address2:
- description: "Second line of the client's shipping address, if needed"
- type: string
- example: 'Suite 5'
- shipping_city:
- description: "The city of the client's shipping address"
- type: string
- example: 'Perth'
- shipping_state:
- description: "The state, province, or locality of the client's shipping address"
- type: string
- example: 'Western Australia'
- shipping_postal_code:
- description: "The postal code or ZIP code of the client's shipping address"
- type: string
- example: '6110'
- shipping_country_id:
- description: "The unique identifier of the country for the client's shipping address"
- type: number
- format: integer
- example: '4'
- is_deleted:
- description: 'A boolean value indicating whether the client has been deleted or not'
- type: boolean
- example: false
+ example: 1.0.1
readOnly: true
- group_settings_id:
- description: 'The group settings assigned to the client'
+ oauth_user_id:
+ description: 'The provider id of the oauth entity'
+ type: string
+ example: jkhasdf789as6f675sdf768sdfs
+ readOnly: true
+ oauth_provider_id:
+ description: 'The oauth entity id'
+ type: string
+ example: google
+ readOnly: true
+ language_id:
+ description: 'The language id of the user'
+ type: string
+ example: 1
+ verified_phone_number:
+ description: 'Boolean flag if the user has their phone verified. Required to settings up 2FA'
+ type: boolean
+ example: true
+ readOnly: true
+ sms_verification_code:
+ description: 'The sms verification code for the user. Required to settings up 2FA'
+ type: string
+ example: '123456'
+ readOnly: true
+ oauth_user_token_expiry:
+ description: 'The expiry date of the oauth token'
+ type: string
+ example: '2022-10-10'
+ readOnly: true
+ has_password:
+ description: 'Boolean flag determining if the user has a password'
+ type: boolean
+ example: true
+ readOnly: true
+ last_confirmed_email_address:
+ description: 'The last confirmed email address of the user'
+ type: string
+ example: 'bob@gmail.com'
+ readOnly: true
+ custom_value1:
+ description: 'A custom value'
+ type: string
+ example: 'Custom value 1'
+ custom_value2:
+ description: 'A custom value'
+ type: string
+ example: '$1000'
+ custom_value3:
+ description: 'A custom value'
+ type: string
+ example: 'Custom value 3'
+ custom_value4:
+ description: 'A custom value'
+ type: string
+ example: 'Custom value 4'
+ is_deleted:
+ description: 'Boolean flag determining if the user has been deleted'
+ type: boolean
+ example: true
+ readOnly: true
+ google_2fa_secret:
+ description: 'The google 2fa secret for the user'
+ type: string
+ example: '123456'
+ readOnly: true
+ type: object
+ CompanyUser:
+ properties:
+ permissions:
+ description: 'The user permissionsfor this company in a comma separated list'
+ type: string
+ example: 'create_invoice,create_client,view_client'
+ settings:
+ description: 'Settings that are used for the flutter applications to store user preferences / metadata'
+ type: object
+ readOnly: true
+ react_settings:
+ description: 'Dedicated settings object for the react web application'
+ type: object
+ readOnly: true
+ is_owner:
+ description: 'Determines whether the user owns this company'
+ type: boolean
+ example: true
+ readOnly: true
+ is_admin:
+ description: 'Determines whether the user is the admin of this company'
+ type: boolean
+ example: true
+ readOnly: true
+ is_locked:
+ description: 'Determines whether the users access to this company has been locked'
+ type: boolean
+ example: true
+ readOnly: true
+ updated_at:
+ description: 'The last time the record was modified, format Unix Timestamp'
+ type: integer
+ example: '1231232312321'
+ deleted_at:
+ description: 'Timestamp when the user was archived, format Unix Timestamp'
+ type: integer
+ example: '12312312321'
+ account:
+ $ref: '#/components/schemas/Account'
+ company:
+ $ref: '#/components/schemas/Company'
+ user:
+ $ref: '#/components/schemas/UserRef'
+ token:
+ $ref: '#/components/schemas/CompanyToken'
+ type: object
+ CompanyUserRef:
+ properties:
+ permissions:
+ description: 'The user permissionsfor this company in a comma separated list'
+ type: string
+ example: 'create_invoice,create_client,view_client'
+ settings:
+ description: 'Settings that are used for the flutter applications to store user preferences / metadata'
+ type: object
+ readOnly: true
+ react_settings:
+ description: 'Dedicated settings object for the react web application'
+ type: object
+ readOnly: true
+ is_owner:
+ description: 'Determines whether the user owns this company'
+ type: boolean
+ example: true
+ readOnly: true
+ is_admin:
+ description: 'Determines whether the user is the admin of this company'
+ type: boolean
+ example: true
+ readOnly: true
+ is_locked:
+ description: 'Determines whether the users access to this company has been locked'
+ type: boolean
+ example: true
+ readOnly: true
+ updated_at:
+ description: 'The last time the record was modified, format Unix Timestamp'
+ type: integer
+ example: '1231232312321'
+ deleted_at:
+ description: 'Timestamp when the user was archived, format Unix Timestamp'
+ type: integer
+ example: '12312312321'
+ account:
+ $ref: '#/components/schemas/Account'
+ company:
+ $ref: '#/components/schemas/Company'
+ user:
+ $ref: '#/components/schemas/UserRef'
+ token:
+ $ref: '#/components/schemas/CompanyToken'
+ type: object
+ RecurringExpense:
+ properties:
+ id:
+ description: 'The hashed id of the recurring expense'
type: string
example: Opnel5aKBz
- routing_id:
- description: 'The routing address id for e-invoicing for this client'
+ user_id:
+ description: 'The hashed id of the user who created the recurring expense'
type: string
- example: Opnel5aKBz3489-dfkiu-2239-sdsd
- is_tax_exempt:
- description: 'Flag which defines if the client is exempt from taxes'
+ example: Opnel5aKBz
+ assigned_user_id:
+ description: 'The hashed id of the user assigned to this recurring expense'
+ type: string
+ example: Opnel5aKBz
+ client_id:
+ description: 'The hashed id of the client'
+ type: string
+ example: Opnel5aKBz
+ invoice_id:
+ description: 'The hashed id of the invoice'
+ type: string
+ example: Opnel5aKBz
+ bank_id:
+ description: 'The id of the bank associated with this recurring expense'
+ type: string
+ example: '22'
+ invoice_currency_id:
+ description: 'The currency id of the invoice associated with this recurring expense'
+ type: string
+ example: '1'
+ expense_currency_id:
+ description: 'The currency id of the expense associated with this recurring expense'
+ type: string
+ example: '1'
+ invoice_category_id:
+ description: 'The category id of the invoice'
+ type: string
+ example: '1'
+ payment_type_id:
+ description: 'The payment type id'
+ type: string
+ example: '1'
+ private_notes:
+ description: 'The recurring expense private notes'
+ type: string
+ example: 'Private and confidential'
+ public_notes:
+ description: 'The recurring expense public notes'
+ type: string
+ example: 'This is the best client in the world'
+ transaction_reference:
+ description: 'The recurring expense transaction reference'
+ type: string
+ example: EXP-1223-2333
+ transcation_id:
+ description: 'The transaction id of the recurring expense'
+ type: string
+ example: '1233312312'
+ custom_value1:
+ description: 'Custom value field'
+ type: string
+ example: $1000
+ custom_value2:
+ description: 'Custom value field'
+ type: string
+ example: '2022-10-10'
+ custom_value3:
+ description: 'Custom value field'
+ type: string
+ example: 'short text'
+ custom_value4:
+ description: 'Custom value field'
+ type: string
+ example: 'very long text'
+ tax_name1:
+ description: 'The tax name'
+ type: string
+ example: GST
+ tax_name2:
+ description: 'The tax name'
+ type: string
+ example: VAT
+ tax_rate1:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_rate2:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ tax_name3:
+ description: 'The tax name'
+ type: string
+ example: ''
+ tax_rate3:
+ description: 'The tax rate'
+ type: number
+ format: float
+ example: '10.00'
+ amount:
+ description: 'The total amount of the recurring expense'
+ type: number
+ format: float
+ example: '10.00'
+ frequency_id:
+ description: 'The frequency this recurring expense fires'
+ type: number
+ format: int
+ example: '1'
+ remaining_cycles:
+ description: 'The number of remaining cycles for this recurring expense'
+ type: number
+ format: int
+ example: '1'
+ foreign_amount:
+ description: 'The foreign currency amount of the recurring expense'
+ type: number
+ format: float
+ example: '10.00'
+ exchange_rate:
+ description: 'The exchange rate for the expernse'
+ type: number
+ format: float
+ example: '0.80'
+ date:
+ description: 'The date of the expense'
+ type: string
+ example: ''
+ payment_date:
+ description: 'The date the expense was paid'
+ type: string
+ example: ''
+ should_be_invoiced:
+ description: 'Boolean flag determining if the expense should be invoiced'
type: boolean
- example: false
- has_valid_vat_number:
- description: 'Flag which defines if the client has a valid VAT number'
+ example: true
+ is_deleted:
+ description: 'Boolean flag determining if the recurring expense is deleted'
type: boolean
- example: false
- readOnly: true
- classification:
- description: 'The classification of the client'
+ example: true
+ last_sent_date:
+ description: 'The Date it was sent last'
type: string
- example: 'individual'
- settings:
- $ref: '#/components/schemas/ClientSettings'
+ format: date
+ example: '1994-07-30'
+ next_send_date:
+ description: 'The next send date'
+ type: string
+ format: date
+ example: '1994-07-30'
+ invoice_documents:
+ description: 'Boolean flag determining if the documents associated with this expense should be passed onto the invoice if it is converted to an invoice'
+ type: boolean
+ example: true
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
type: object
- Error:
- properties:
- message:
- description: 'Something terrible went wrong'
- type: string
- example: 'Unexpected error'
- code:
- description: 'The HTTP error code, ie 5xx 4xx'
- type: integer
- example: '500'
- type: object
- BTRules:
- properties:
- data_key:
- description: 'The key to search'
- type: string
- example: 'description,amount'
- operator:
- description: 'The operator flag of the search'
- type: string
- example: '>'
- value:
- description: 'The value to search for'
- type: string
- example: bob
- type: object
- CompanySettings:
- required:
- - currency_id
- properties:
- currency_id:
- description: "The default currency id"
- type: string
- example: true
- timezone_id:
- description: "The timezone id"
- type: string
- example: "15"
- date_format_id:
- description: "The date format id"
- type: string
- example: "15"
- military_time:
- description: "Toggles 12/24 hour time"
- type: boolean
- example: true
- language_id:
- description: "The language id"
- type: string
- example: "1"
- show_currency_code:
- description: "Toggles whether the currency symbol or code is shown"
- type: boolean
- example: true
- payment_terms:
- description: "-1 sets no payment term, 0 sets payment due immediately, positive integers indicates payment terms in days"
- type: integer
- example: "1"
- company_gateway_ids:
- description: "A commad separate list of available gateways"
- type: string
- example: "1,2,3,4"
- custom_value1:
- description: "A Custom Label"
- type: string
- example: "Custom Label"
- custom_value2:
- description: "A Custom Label"
- type: string
- example: "Custom Label"
- custom_value3:
- description: "A Custom Label"
- type: string
- example: "Custom Label"
- custom_value4:
- description: "A Custom Label"
- type: string
- example: "Custom Label"
- default_task_rate:
- description: "The default task rate"
- type: number
- format: float
- example: "10.00"
- send_reminders:
- description: "Toggles whether reminders are sent"
- type: boolean
- example: true
- enable_client_portal_tasks:
- description: "Show/hide the tasks panel in the client portal"
- type: boolean
- example: true
- email_style:
- description: "options include plain,light,dark,custom"
- type: string
- example: light
- reply_to_email:
- description: "The reply to email address"
- type: string
- example: email@gmail.com
- bcc_email:
- description: "A comma separate list of BCC emails"
- type: string
- example: "email@gmail.com, contact@gmail.com"
- pdf_email_attachment:
- description: "Toggles whether to attach PDF as attachment"
- type: boolean
- example: true
- ubl_email_attachment:
- description: "Toggles whether to attach UBL as attachment"
- type: boolean
- example: true
- email_style_custom:
- description: "The custom template"
- type: string
- example: ""
- counter_number_applied:
- description: "enum when the invoice number counter is set, ie when_saved, when_sent, when_paid"
- type: string
- example: when_sent
- quote_number_applied:
- description: "enum when the quote number counter is set, ie when_saved, when_sent"
- type: string
- example: when_sent
- custom_message_dashboard:
- description: "A custom message which is displayed on the dashboard"
- type: string
- example: "Please pay invoices immediately"
- custom_message_unpaid_invoice:
- description: "A custom message which is displayed in the client portal when a client is viewing a unpaid invoice."
- type: string
- example: "Please pay invoices immediately"
- custom_message_paid_invoice:
- description: "A custom message which is displayed in the client portal when a client is viewing a paid invoice."
- type: string
- example: "Thanks for paying this invoice!"
- custom_message_unapproved_quote:
- description: "A custom message which is displayed in the client portal when a client is viewing a unapproved quote."
- type: string
- example: "Please approve quote"
- lock_invoices:
- description: "Toggles whether invoices are locked once sent and cannot be modified further"
- type: boolean
- example: true
- auto_archive_invoice:
- description: "Toggles whether a invoice is archived immediately following payment"
- type: boolean
- example: true
- auto_archive_quote:
- description: "Toggles whether a quote is archived after being converted to a invoice"
- type: boolean
- example: true
- auto_convert_quote:
- description: "Toggles whether a quote is converted to a invoice when approved"
- type: boolean
- example: true
- inclusive_taxes:
- description: "Boolean flag determining whether inclusive or exclusive taxes are used"
- type: boolean
- example: true
- translations:
- description: "JSON payload of customized translations"
- type: object
- example: ""
- task_number_pattern:
- description: "Allows customisation of the task number pattern"
- type: string
- example: "{$year}-{$counter}"
- task_number_counter:
- description: "The incrementing counter for tasks"
- type: integer
- example: "1"
- reminder_send_time:
- description: "Time from UTC +0 when the email will be sent to the client"
- type: integer
- example: "32400"
- expense_number_pattern:
- description: "Allows customisation of the expense number pattern"
- type: string
- example: "{$year}-{$counter}"
- expense_number_counter:
- description: "The incrementing counter for expenses"
- type: integer
- example: "1"
- vendor_number_pattern:
- description: "Allows customisation of the vendor number pattern"
- type: string
- example: "{$year}-{$counter}"
- vendor_number_counter:
- description: "The incrementing counter for vendors"
- type: integer
- example: "1"
- ticket_number_pattern:
- description: "Allows customisation of the ticket number pattern"
- type: string
- example: "{$year}-{$counter}"
- ticket_number_counter:
- description: "The incrementing counter for tickets"
- type: integer
- example: "1"
- payment_number_pattern:
- description: "Allows customisation of the payment number pattern"
- type: string
- example: "{$year}-{$counter}"
- payment_number_counter:
- description: "The incrementing counter for payments"
- type: integer
- example: "1"
- invoice_number_pattern:
- description: "Allows customisation of the invoice number pattern"
- type: string
- example: "{$year}-{$counter}"
- invoice_number_counter:
- description: "The incrementing counter for invoices"
- type: integer
- example: "1"
- quote_number_pattern:
- description: "Allows customisation of the quote number pattern"
- type: string
- example: "{$year}-{$counter}"
- quote_number_counter:
- description: "The incrementing counter for quotes"
- type: integer
- example: "1"
- client_number_pattern:
- description: "Allows customisation of the client number pattern"
- type: string
- example: "{$year}-{$counter}"
- client_number_counter:
- description: "The incrementing counter for clients"
- type: integer
- example: "1"
- credit_number_pattern:
- description: "Allows customisation of the credit number pattern"
- type: string
- example: "{$year}-{$counter}"
- credit_number_counter:
- description: "The incrementing counter for credits"
- type: integer
- example: "1"
- recurring_invoice_number_prefix:
- description: "This string is prepended to the recurring invoice number"
- type: string
- example: R
- reset_counter_frequency_id:
- description: "CONSTANT which is used to apply the frequency which the counters are reset"
- type: integer
- example: "1"
- reset_counter_date:
- description: "The explicit date which is used to reset counters"
- type: string
- example: "2019-01-01"
- counter_padding:
- description: "Pads the counter with leading zeros"
- type: integer
- example: "1"
- shared_invoice_quote_counter:
- description: "Flags whether to share the counter for invoices and quotes"
- type: boolean
- example: true
- update_products:
- description: "Determines if client fields are updated from third party APIs"
- type: boolean
- example: true
- convert_products:
- description: ""
- type: boolean
- example: true
- fill_products:
- description: "Automatically fill products based on product_key"
- type: boolean
- example: true
- invoice_terms:
- description: "The default invoice terms"
- type: string
- example: "Invoice Terms are..."
- quote_terms:
- description: "The default quote terms"
- type: string
- example: "Quote Terms are..."
- invoice_taxes:
- description: "Taxes can be applied to the invoice"
- type: number
- example: "1"
- invoice_design_id:
- description: "The default design id (invoice, quote etc)"
- type: string
- example: "1"
- quote_design_id:
- description: "The default design id (invoice, quote etc)"
- type: string
- example: "1"
- invoice_footer:
- description: "The default invoice footer"
- type: string
- example: "1"
- invoice_labels:
- description: "JSON string of invoice labels"
- type: string
- example: "1"
- tax_rate1:
- description: "The tax rate (float)"
- type: number
- example: "10"
- tax_name1:
- description: "The tax name"
- type: string
- example: GST
- tax_rate2:
- description: "The tax rate (float)"
- type: number
- example: "10"
- tax_name2:
- description: "The tax name"
- type: string
- example: GST
- tax_rate3:
- description: "The tax rate (float)"
- type: number
- example: "10"
- tax_name3:
- description: "The tax name"
- type: string
- example: GST
- payment_type_id:
- description: "The default payment type id"
- type: string
- example: "1"
- custom_fields:
- description: "JSON string of custom fields"
- type: string
- example: "{}"
- email_footer:
- description: "The default email footer"
- type: string
- example: "A default email footer"
- email_sending_method:
- description: "The email driver to use to send email, options include default, gmail, client_postmark, client_mailgun, client_brevo, office365"
- type: string
- example: default
- gmail_sending_user_id:
- description: "The hashed_id of the user account to send email from"
- type: string
- example: F76sd34D
- email_subject_invoice:
- description: ""
- type: string
- example: "Your Invoice Subject"
- email_subject_quote:
- description: ""
- type: string
- example: "Your Quote Subject"
- email_subject_payment:
- description: ""
- type: string
- example: "Your Payment Subject"
- email_template_invoice:
- description: "The full template for invoice emails"
- type: string
- example: ""
- email_template_quote:
- description: "The full template for quote emails"
- type: string
- example: ""
- email_template_payment:
- description: "The full template for payment emails"
- type: string
- example: ""
- email_subject_reminder1:
- description: "Email subject for Reminder"
- type: string
- example: ""
- email_subject_reminder2:
- description: "Email subject for Reminder"
- type: string
- example: ""
- email_subject_reminder3:
- description: "Email subject for Reminder"
- type: string
- example: ""
- email_subject_reminder_endless:
- description: "Email subject for endless reminders"
- type: string
- example: ""
- email_template_reminder1:
- description: "The full template for Reminder 1"
- type: string
- example: ""
- email_template_reminder2:
- description: "The full template for Reminder 2"
- type: string
- example: ""
- email_template_reminder3:
- description: "The full template for Reminder 3"
- type: string
- example: ""
- email_template_reminder_endless:
- description: "The full template for enless reminders"
- type: string
- example: ""
- enable_portal_password:
- description: "Toggles whether a password is required to log into the client portal"
- type: boolean
- example: true
- show_accept_invoice_terms:
- description: "Toggles whether the terms dialogue is shown to the client"
- type: boolean
- example: true
- show_accept_quote_terms:
- description: "Toggles whether the terms dialogue is shown to the client"
- type: boolean
- example: true
- require_invoice_signature:
- description: "Toggles whether a invoice signature is required"
- type: boolean
- example: true
- require_quote_signature:
- description: "Toggles whether a quote signature is required"
- type: boolean
- example: true
- name:
- description: "The company name"
- type: string
- example: "Acme Co"
- company_logo:
- description: "The company logo file"
- type: object
- example: logo.png
- website:
- description: "The company website URL"
- type: string
- example: www.acme.com
- address1:
- description: "The company address line 1"
- type: string
- example: "Suite 888"
- address2:
- description: "The company address line 2"
- type: string
- example: "5 Jimbo Way"
- city:
- description: "The company city"
- type: string
- example: Sydney
- state:
- description: "The company state"
- type: string
- example: Florisa
- postal_code:
- description: "The company zip/postal code"
- type: string
- example: "90210"
- phone:
- description: "The company phone"
- type: string
- example: 555-213-3948
- email:
- description: "The company email"
- type: string
- example: joe@acme.co
- country_id:
- description: "The country ID"
- type: string
- example: "1"
- vat_number:
- description: "The company VAT/TAX ID number"
- type: string
- example: "32 120 377 720"
- page_size:
- description: "The default page size"
- type: string
- example: A4
- font_size:
- description: "The font size"
- type: number
- example: "9"
- primary_font:
- description: "The primary font"
- type: string
- example: roboto
- secondary_font:
- description: "The secondary font"
- type: string
- example: roboto
- hide_paid_to_date:
- description: "Flags whether to hide the paid to date field"
- type: boolean
- example: false
- embed_documents:
- description: "Toggled whether to embed documents in the PDF"
- type: boolean
- example: false
- all_pages_header:
- description: "The header for the PDF"
- type: boolean
- example: false
- all_pages_footer:
- description: "The footer for the PDF"
- type: boolean
- example: false
- document_email_attachment:
- description: "Toggles whether to attach documents in the email"
- type: boolean
- example: false
- enable_client_portal_password:
- description: "Toggles password protection of the client portal"
- type: boolean
- example: false
- enable_email_markup:
- description: "Toggles the use of markdown in emails"
- type: boolean
- example: false
- enable_client_portal_dashboard:
- description: "Toggles whether the client dashboard is shown in the client portal"
- type: boolean
- example: false
- enable_client_portal:
- description: "Toggles whether the entire client portal is displayed to the client, or only the context"
- type: boolean
- example: false
- email_template_statement:
- description: "The body of the email for statements"
- type: string
- example: "template matter"
- email_subject_statement:
- description: "The subject of the email for statements"
- type: string
- example: "subject matter"
- signature_on_pdf:
- description: "Toggles whether the signature (if available) is displayed on the PDF"
- type: boolean
- example: false
- quote_footer:
- description: "The default quote footer"
- type: string
- example: "the quote footer"
- email_subject_custom1:
- description: "Custom reminder template subject"
- type: string
- example: "Custom Subject 1"
- email_subject_custom2:
- description: "Custom reminder template subject"
- type: string
- example: "Custom Subject 2"
- email_subject_custom3:
- description: "Custom reminder template subject"
- type: string
- example: "Custom Subject 3"
- email_template_custom1:
- description: "Custom reminder template body"
- type: string
- example: ""
- email_template_custom2:
- description: "Custom reminder template body"
- type: string
- example: ""
- email_template_custom3:
- description: "Custom reminder template body"
- type: string
- example: ""
- enable_reminder1:
- description: "Toggles whether this reminder is enabled"
- type: boolean
- example: false
- enable_reminder2:
- description: "Toggles whether this reminder is enabled"
- type: boolean
- example: false
- enable_reminder3:
- description: "Toggles whether this reminder is enabled"
- type: boolean
- example: false
- num_days_reminder1:
- description: "The Reminder interval"
- type: number
- example: "9"
- num_days_reminder2:
- description: "The Reminder interval"
- type: number
- example: "9"
- num_days_reminder3:
- description: "The Reminder interval"
- type: number
- example: "9"
- schedule_reminder1:
- description: "(enum: after_invoice_date, before_due_date, after_due_date)"
- type: string
- example: after_invoice_date
- schedule_reminder2:
- description: "(enum: after_invoice_date, before_due_date, after_due_date)"
- type: string
- example: after_invoice_date
- schedule_reminder3:
- description: "(enum: after_invoice_date, before_due_date, after_due_date)"
- type: string
- example: after_invoice_date
- late_fee_amount1:
- description: "The late fee amount for reminder 1"
- type: number
- example: 10
- late_fee_amount2:
- description: "The late fee amount for reminder 2"
- type: number
- example: 20
- late_fee_amount3:
- description: "The late fee amount for reminder 2"
- type: number
- example: 100
- endless_reminder_frequency_id:
- description: "The frequency id of the endless reminder"
- type: string
- example: "1"
- client_online_payment_notification:
- description: "Determines if a client should receive the notification for a online payment"
- type: boolean
- example: false
- client_manual_payment_notification:
- description: "Determines if a client should receive the notification for a manually entered payment"
- type: boolean
- example: false
- enable_e_invoice:
- description: "Determines if e-invoicing is enabled"
- type: boolean
- example: false
- default_expense_payment_type_id:
- description: "The default payment type for expenses"
- type: string
- example: "0"
- e_invoice_type:
- description: "The e-invoice type"
- type: string
- example: "EN16931"
- mailgun_endpoint:
- description: "The mailgun endpoint - used to determine whether US or EU endpoints are used"
- type: string
- example: "api.mailgun.net or api.eu.mailgun.net"
- client_initiated_payments:
- description: "Determines if clients can initiate payments directly from the client portal"
- type: boolean
- example: false
- client_initiated_payments_minimum:
- description: "The minimum amount a client can pay"
- type: number
- example: 10
- sync_invoice_quote_columns:
- description: "Determines if invoice and quote columns are synced for the PDF rendering, or if they use their own columns"
- type: boolean
- example: false
- show_task_item_description:
- description: "Determines if the task item description is shown on the invoice"
- type: boolean
- example: false
- allow_billable_task_items:
- description: "Determines if task items can be marked as billable"
- type: boolean
- example: false
- accept_client_input_quote_approval:
- description: "Determines if clients can approve quotes and also pass through a PO Number reference"
- type: boolean
- example: false
- custom_sending_email:
- description: "When using Mailgun or Postmark, the FROM email address can be customized using this setting."
- type: string
- example: "bob@gmail.com"
- show_paid_stamp:
- description: "Determines if the PAID stamp is shown on the invoice"
- type: boolean
- example: false
- show_shipping_address:
- description: "Determines if the shipping address is shown on the invoice"
- type: boolean
- example: false
- company_logo_size:
- description: "The size of the company logo on the PDF - percentage value between 0 and 100"
- type: number
- example: 100
- show_email_footer:
- description: "Determines if the email footer is shown on emails"
- type: boolean
- example: false
- email_alignment:
- description: "The alignment of the email body text, options include left / center / right"
- type: string
- example: "left"
- auto_bill_standard_invoices:
- description: "Determines if standard invoices are automatically billed when they are created or due"
- type: boolean
- example: false
- postmark_secret:
- description: "The Postmark secret API key"
- type: string
- example: "123456"
- mailgun_secret:
- description: "The Mailgun secret API key"
- type: string
- example: "123456"
- mailgun_domain:
- description: "The Mailgun domain"
- type: string
- example: "sandbox123456.mailgun.org"
- send_email_on_mark_paid:
- description: "Determines if an email is sent when an invoice is marked as paid"
- type: boolean
- example: false
- vendor_portal_enable_uploads:
- description: "Determines if vendors can upload files to the portal"
- type: boolean
- example: false
- besr_id:
- description: "The BESR ID"
- type: string
- example: "123456"
- qr_iban:
- description: "The IBAN for the QR code"
- type: string
- example: "CH123456"
- email_subject_purchase_order:
- description: "The email subject for purchase orders"
- type: string
- example: "Purchase Order"
- email_template_purchase_order:
- description: "The email template for purchase orders"
- type: string
- example: "Please see attached your purchase order."
- require_purchase_order_signature:
- description: "Determines if a signature is required on purchase orders"
- type: boolean
- example: false
- purchase_order_public_notes:
- description: "The public notes for purchase orders"
- type: string
- example: "Please see attached your purchase order."
- purchase_order_terms:
- description: "The terms for purchase orders"
- type: string
- example: "Please see attached your purchase order."
- purchase_order_footer:
- description: "The footer for purchase orders"
- type: string
- example: "Please see attached your purchase order."
- purchase_order_design_id:
- description: "The design id for purchase orders"
- type: string
- example: "hd677df"
- purchase_order_number_pattern:
- description: "The pattern for purchase order numbers"
- type: string
- example: "PO-000000"
- purchase_order_number_counter:
- description: "The counter for purchase order numbers"
- type: number
- example: 1
- page_numbering_alignment:
- description: "The alignment for page numbering: options include left / center / right"
- type: string
- example: "left"
- page_numbering:
- description: "Determines if page numbering is enabled on Document PDFs"
- type: boolean
- example: false
- auto_archive_invoice_cancelled:
- description: "Determines if invoices are automatically archived when they are cancelled"
- type: boolean
- example: false
- email_from_name:
- description: "The FROM name for emails when using Custom emailers"
- type: string
- example: "Bob Smith"
- show_all_tasks_client_portal:
- description: "Determines if all tasks are shown on the client portal"
- type: boolean
- example: false
- entity_send_time:
- description: "The time that emails are sent. The time is localized to the clients locale, integer values from 1 - 24"
- type: integer
- example: 9
- shared_invoice_credit_counter:
- description: "Determines if the invoice and credit counter are shared"
- type: boolean
- example: false
- reply_to_name:
- description: "The reply to name for emails"
- type: string
- example: "Bob Smith"
- hide_empty_columns_on_pdf:
- description: "Determines if empty columns are hidden on PDFs"
- type: boolean
- example: false
- enable_reminder_endless:
- description: "Determines if endless reminders are enabled"
- type: boolean
- example: false
- use_credits_payment:
- description: "Determines if credits can be used as a payment method"
- type: boolean
- example: false
- recurring_invoice_number_pattern:
- description: "The pattern for recurring invoice numbers"
- type: string
- example: "R-000000"
- recurring_invoice_number_counter:
- description: "The counter for recurring invoice numbers"
- type: number
- example: 1
- client_portal_under_payment_minimum:
- description: "The minimum payment payment"
- type: number
- example: 10
- auto_bill_date:
- description: "Determines when the invoices are auto billed, options are on_send_date (when the invoice is sent) or on_due_date (when the invoice is due))"
- type: string
- example: "on_send_date"
- primary_color:
- description: "The primary color for the client portal / document highlights"
- type: string
- example: "#ffffff"
- secondary_color:
- description: "The secondary color for the client portal / document highlights"
- type: string
- example: "#ffffff"
- client_portal_allow_under_payment:
- description: "Determines if clients can pay invoices under the invoice amount due"
- type: boolean
- example: false
- client_portal_allow_over_payment:
- description: "Determines if clients can pay invoices over the invoice amount"
- type: boolean
- example: false
- auto_bill:
- description: "Determines how autobilling is applied for recurring invoices. off (no auto billed), always (always auto bill), optin (The user must opt in to auto billing), optout (The user must opt out of auto billing"
- type: string
- example: "off"
- client_portal_terms:
- description: "The terms which are displayed on the client portal"
- type: string
- example: "Please see attached your invoice."
- client_portal_privacy_policy:
- description: "The privacy policy which is displayed on the client portal"
- type: string
- example: "These are the terms of use for using the client portal."
- client_can_register:
- description: "Determines if clients can register on the client portal"
- type: boolean
- example: false
- portal_design_id:
- description: "The design id for the client portal"
- type: string
- example: "hd677df"
- late_fee_endless_percent:
- description: "The late fee percentage for endless late fees"
- type: number
- example: 10
- late_fee_endless_amount:
- description: "The late fee amount for endless late fees"
- type: number
- example: 10
- auto_email_invoice:
- description: "Determines if invoices are automatically emailed when they are created"
- type: boolean
- example: false
- email_signature:
- description: "The email signature for emails"
- type: string
- example: "Bob Smith"
- classification:
- description: "The classification for the company"
- type: string
- example: "individual"
- type: object
-
ClientContact:
properties:
id:
@@ -21644,6 +21649,275 @@ components:
example: '134341234234'
readOnly: true
type: object
+ Expense:
+ properties:
+ id:
+ description: 'The expense hashed id'
+ type: string
+ example: 'Opnel5aKBz'
+ user_id:
+ description: 'The user hashed id'
+ type: string
+ example: 'Opnel5aKBz'
+ assigned_user_id:
+ description: 'The assigned user hashed id'
+ type: string
+ example: 'Opnel5aKBz'
+ project_id:
+ description: 'The associated project_id'
+ type: string
+ example: 'Opnel5aKBz'
+ client_id:
+ description: 'The client hashed id'
+ type: string
+ example: 'Opnel5aKBz'
+ invoice_id:
+ description: 'The related invoice hashed id'
+ type: string
+ example: 'Opnel5aKBz'
+ bank_id:
+ description: 'The bank id related to this expense'
+ type: string
+ example: ''
+ invoice_currency_id:
+ description: 'The currency id of the related invoice'
+ type: string
+ example: '1'
+ currency_id:
+ description: 'The currency id of the expense'
+ type: string
+ example: '2'
+ invoice_category_id:
+ description: 'The invoice category id'
+ type: string
+ example: 'Opnel5aKBz'
+ payment_type_id:
+ description: 'The payment type id'
+ type: string
+ example: ''
+ recurring_expense_id:
+ description: 'The related recurring expense this expense was created from'
+ type: string
+ example: 'Opnel5aKBz'
+ private_notes:
+ description: 'The private notes of the expense'
+ type: string
+ example: ''
+ public_notes:
+ description: 'The public notes of the expense'
+ type: string
+ example: ''
+ transaction_reference:
+ description: 'The transaction references of the expense'
+ type: string
+ example: ''
+ transcation_id:
+ description: 'The transaction id of the expense'
+ type: string
+ example: ''
+ custom_value1:
+ description: 'A custom value'
+ type: string
+ example: ''
+ custom_value2:
+ description: 'A custom value'
+ type: string
+ example: ''
+ custom_value3:
+ description: 'A custom value'
+ type: string
+ example: ''
+ custom_value4:
+ description: 'A custom value'
+ type: string
+ example: ''
+ tax_amount:
+ description: 'The tax amount'
+ type: number
+ example: 10.00
+ tax_name1:
+ description: 'Tax Name 1'
+ type: string
+ example: 'GST'
+ tax_name2:
+ description: 'Tax Name 2'
+ type: string
+ example: 'VAT'
+ tax_name3:
+ description: 'Tax Name 3'
+ type: string
+ example: 'IVA'
+ tax_rate1:
+ description: 'Tax rate 1'
+ type: number
+ format: float
+ example: '10.00'
+ tax_rate2:
+ description: 'Tax rate 2'
+ type: number
+ format: float
+ example: '10.00'
+ tax_rate3:
+ description: 'Tax rate 3'
+ type: number
+ format: float
+ example: '10.00'
+ amount:
+ description: 'The total expense amont'
+ type: number
+ format: float
+ example: '10.00'
+ foreign_amount:
+ description: 'The total foreign amount of the expense'
+ type: number
+ format: float
+ example: '10.00'
+ exchange_rate:
+ description: 'The exchange rate at the time of the expense'
+ type: number
+ format: float
+ example: '0.80'
+ date:
+ description: 'The expense date format Y-m-d'
+ type: string
+ example: '2022-12-01'
+ payment_date:
+ description: 'The date of payment for the expense, format Y-m-d'
+ type: string
+ example: '2022-12-01'
+ should_be_invoiced:
+ description: 'Flag whether the expense should be invoiced'
+ type: boolean
+ example: true
+ is_deleted:
+ description: 'Boolean determining whether the expense has been deleted'
+ type: boolean
+ example: true
+ invoice_documents:
+ description: 'Passing the expense documents over to the invoice'
+ type: boolean
+ example: true
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ type: object
+ Task:
+ properties:
+ id:
+ description: 'The hashed id of the task'
+ type: string
+ example: Opnel5aKBz
+ user_id:
+ description: 'The hashed id of the user who created the task'
+ type: string
+ example: Opnel5aKBz
+ assigned_user_id:
+ description: 'The assigned user of the task'
+ type: string
+ example: Opnel5aKBz
+ client_id:
+ description: 'The hashed if of the client'
+ type: string
+ example: Opnel5aKBz
+ invoice_id:
+ description: 'The hashed id of the invoice associated with the task'
+ type: string
+ example: Opnel5aKBz
+ project_id:
+ description: 'The hashed id of the project associated with the task'
+ type: string
+ example: Opnel5aKBz
+ number:
+ description: 'The number of the task'
+ type: string
+ example: TASK-123
+ time_log:
+ description: 'An array of unix time stamps defining the start and end times of the task'
+ type: string
+ example: '[[1,2],[3,4]]'
+ is_running:
+ description: 'Determines if the task is still running'
+ type: boolean
+ example: true
+ is_deleted:
+ description: 'Boolean flag determining if the task has been deleted'
+ type: boolean
+ example: true
+ task_status_id:
+ description: 'The hashed id of the task status'
+ type: string
+ example: Opnel5aKBz
+ description:
+ description: 'The task description'
+ type: string
+ example: 'A wonder task to work on'
+ duration:
+ description: 'The task duration in seconds'
+ type: integer
+ example: '3600'
+ task_status_order:
+ description: 'The order of the task'
+ type: integer
+ example: '4'
+ rate:
+ description: 'The task rate'
+ type: number
+ example: 10.00
+ custom_value1:
+ description: 'A custom value'
+ type: string
+ example: '2022-10-10'
+ custom_value2:
+ description: 'A custom value'
+ type: string
+ example: $1100
+ custom_value3:
+ description: 'A custom value'
+ type: string
+ example: 'I need help'
+ custom_value4:
+ description: 'A custom value'
+ type: string
+ example: INV-3343
+ is_date_based:
+ description: 'Boolean flag determining if the task is date based'
+ type: boolean
+ example: true
+ calculated_start_date:
+ description: 'The calculated start date of the task'
+ type: string
+ example: '2022-10-10'
+ readOnly: true
+ invoice_documents:
+ description: "Boolean flags which determines whether to include the task documents on the invoice"
+ type: boolean
+ example: true
+ created_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ updated_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ archived_at:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '1434342123'
+ readOnly: true
+ type: object
FeesAndLimits:
properties:
@@ -21702,339 +21976,160 @@ components:
type: boolean
example: true
type: object
- Account:
+ Vendor:
properties:
id:
- description: 'The account hashed id'
+ description: 'The hashed id of the vendor. This is a unique identifier for the vendor.'
type: string
- example: AS3df3A
- account_sms_verified:
- description: 'Boolean flag if the account has been verified by sms'
- type: string
- example: true
- type: object
- BankTransactionRule:
- properties:
- id:
- description: 'The bank transaction rules hashed id'
- type: string
- example: AS3df3A
+ example: Opnel5aKBz
+ readOnly: true
user_id:
- description: 'The user hashed id'
+ description: 'The hashed id of the user who created the vendor. This is a unique identifier for the user.'
type: string
- example: AS3df3A
- name:
- description: 'The name of the transaction'
+ example: Opnel5aKBz
+ assigned_user_id:
+ description: 'The hashed id of the assigned user to this vendor. This is a unique identifier for the user.'
type: string
- example: 'Rule 1'
- rules:
- description: 'A mapped collection of the sub rules for the BankTransactionRule'
+ example: Opnel5aKBz
+ contacts:
type: array
items:
- $ref: '#/components/schemas/BTRules'
- auto_convert:
- description: 'Flags whether the rule converts the transaction automatically'
- type: boolean
- example: true
- matches_on_all:
- description: 'Flags whether all subrules are required for the match'
- type: boolean
- example: true
- applies_to:
- description: 'Flags whether the rule applies to a CREDIT or DEBIT'
- type: string
- example: CREDIT
- client_id:
- description: 'The client hashed id'
- type: string
- example: AS3df3A
- vendor_id:
- description: 'The vendor hashed id'
- type: string
- example: AS3df3A
- category_id:
- description: 'The category hashed id'
- type: string
- example: AS3df3A
- type: object
- CompanyToken:
- properties:
+ $ref: '#/components/schemas/VendorContact'
+ description: 'An array of contacts associated with the vendor.'
name:
- description: 'The token name'
+ description: 'The name of the vendor.'
type: string
- example: 'Token Name'
- token:
- description: 'The token value'
+ example: 'Harry cafe de wheels'
+ classification:
+ description: 'The classification of the vendor.'
type: string
- example: AS3df3jUUH765fhfd9KJuidj3JShjA
- is_system:
- description: 'Determines whether the token is created by the system rather than a user'
- type: boolean
- example: 'true'
- type: object
- CompanyUser:
- properties:
- permissions:
- description: 'The user permissionsfor this company in a comma separated list'
+ example: 'individual'
+ website:
+ description: 'The website of the vendor.'
type: string
- example: 'create_invoice,create_client,view_client'
- settings:
- description: 'Settings that are used for the flutter applications to store user preferences / metadata'
- type: object
- readOnly: true
- react_settings:
- description: 'Dedicated settings object for the react web application'
- type: object
- readOnly: true
- is_owner:
- description: 'Determines whether the user owns this company'
- type: boolean
- example: true
- readOnly: true
- is_admin:
- description: 'Determines whether the user is the admin of this company'
- type: boolean
- example: true
- readOnly: true
- is_locked:
- description: 'Determines whether the users access to this company has been locked'
- type: boolean
- example: true
- readOnly: true
- updated_at:
- description: 'The last time the record was modified, format Unix Timestamp'
- type: integer
- example: '1231232312321'
- deleted_at:
- description: 'Timestamp when the user was archived, format Unix Timestamp'
- type: integer
- example: '12312312321'
- account:
- $ref: '#/components/schemas/Account'
- company:
- $ref: '#/components/schemas/Company'
- user:
- $ref: '#/components/schemas/UserRef'
- token:
- $ref: '#/components/schemas/CompanyToken'
- type: object
- CompanyUserRef:
- properties:
- permissions:
- description: 'The user permissionsfor this company in a comma separated list'
+ example: www.harry.com
+ private_notes:
+ description: 'The private notes of the vendor. These notes are only visible to users with appropriate permissions.'
type: string
- example: 'create_invoice,create_client,view_client'
- settings:
- description: 'Settings that are used for the flutter applications to store user preferences / metadata'
- type: object
- readOnly: true
- react_settings:
- description: 'Dedicated settings object for the react web application'
- type: object
- readOnly: true
- is_owner:
- description: 'Determines whether the user owns this company'
- type: boolean
- example: true
- readOnly: true
- is_admin:
- description: 'Determines whether the user is the admin of this company'
- type: boolean
- example: true
- readOnly: true
- is_locked:
- description: 'Determines whether the users access to this company has been locked'
- type: boolean
- example: true
- readOnly: true
- updated_at:
- description: 'The last time the record was modified, format Unix Timestamp'
- type: integer
- example: '1231232312321'
- deleted_at:
- description: 'Timestamp when the user was archived, format Unix Timestamp'
- type: integer
- example: '12312312321'
- account:
- $ref: '#/components/schemas/Account'
- company:
- $ref: '#/components/schemas/Company'
- user:
- $ref: '#/components/schemas/UserRef'
- token:
- $ref: '#/components/schemas/CompanyToken'
- type: object
- InvoiceInvitationRequest:
- required:
- - client_contact_id
- properties:
- id:
- description: 'The entity invitation hashed id'
+ example: 'Shhh, do not tell the vendor'
+ industry_id:
+ description: 'The industry id of the vendor. This is a unique identifier for the industry.'
type: string
- example: Opnel5aKBz
- readOnly: true
- client_contact_id:
- description: 'The client contact hashed id'
+ example: '1'
+ size_id:
+ description: 'The size id of the vendor. This is a unique identifier for the size of the vendor.'
type: string
- example: Opnel5aKBz
- key:
- description: 'The invitation key'
+ example: ''
+ address1:
+ description: 'The first line of the vendor''s address.'
type: string
- example: Opnel5aKBz4343343566236gvbb
- readOnly: true
- link:
- description: 'The invitation link'
+ example: ''
+ address2:
+ description: 'The second line of the vendor''s address.'
type: string
- example: 'https://www.example.com/invitations/Opnel5aKBz4343343566236gvbb'
- readOnly: true
- sent_date:
- description: 'The invitation sent date'
+ example: ''
+ city:
+ description: 'The city of the vendor''s address.'
type: string
- format: date-time
- readOnly: true
- viewed_date:
- description: 'The invitation viewed date'
+ example: ''
+ state:
+ description: 'The state of the vendor''s address.'
type: string
- format: date-time
- readOnly: true
- opened_date:
- description: 'The invitation opened date'
+ example: ''
+ postal_code:
+ description: 'The postal code of the vendor''s address.'
type: string
- format: date-time
- readOnly: true
- updated_at:
- description: 'Timestamp'
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- archived_at:
- description: 'Timestamp'
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- email_error:
- description: 'The email error'
+ example: ''
+ phone:
+ description: 'The phone number of the vendor.'
type: string
- example: 'The email error'
- readOnly: true
- email_status:
- description: 'The email status'
+ example: 555-3434-3434
+ country_id:
+ description: 'The country id of the vendor. This is a unique identifier for the country.'
type: string
- readOnly: true
-
- InvoiceInvitation:
- properties:
- id:
- description: 'The entity invitation hashed id'
+ example: ''
+ currency_id:
+ description: 'The currency id of the vendor. This is a unique identifier for the currency.'
type: string
- example: Opnel5aKBz
- readOnly: true
- client_contact_id:
- description: 'The client contact hashed id'
+ example: '4'
+ custom_value1:
+ description: 'The value of the first custom field for the vendor.'
type: string
- example: Opnel5aKBz
- key:
- description: 'The invitation key'
+ example: ''
+ custom_value2:
+ description: 'The value of the second custom field for the vendor.'
type: string
- example: Opnel5aKBz4343343566236gvbb
- readOnly: true
- link:
- description: 'The invitation link'
+ example: ''
+ custom_value3:
+ description: 'The value of the third custom field for the vendor.'
type: string
- example: 'https://www.example.com/invitations/Opnel5aKBz4343343566236gvbb'
- readOnly: true
- sent_date:
- description: 'The invitation sent date'
+ example: ''
+ custom_value4:
+ description: 'The value of the fourth custom field for the vendor.'
type: string
- format: date-time
- readOnly: true
- viewed_date:
- description: 'The invitation viewed date'
+ example: ''
+ vat_number:
+ description: 'The VAT number of the vendor.'
type: string
- format: date-time
- readOnly: true
- opened_date:
- description: 'The invitation opened date'
+ example: ''
+ id_number:
+ description: 'The ID number of the vendor.'
type: string
- format: date-time
- readOnly: true
- updated_at:
- description: 'Timestamp'
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- archived_at:
- description: 'Timestamp'
- type: number
- format: integer
- example: '1434342123'
- readOnly: true
- email_error:
- description: 'The email error'
+ example: ''
+ number:
+ description: 'The number of the vendor'
type: string
- example: 'The email error'
- readOnly: true
- email_status:
- description: 'The email status'
- type: string
- readOnly: true
-
- Design:
- properties:
- id:
- description: 'The design hashed id'
- type: string
- example: AS3df3A
- name:
- description: 'The design name'
- type: string
- example: Beauty
- design:
- description: 'The design HTML'
- type: string
- example: ''
- is_custom:
- description: 'Flag to determine if the design is a custom user design'
- type: boolean
- example: true
- is_active:
- description: 'Flag to determine if the design is available for use'
- type: boolean
- example: true
+ example: '11234'
is_deleted:
- description: 'Flag to determine if the design is deleted'
+ description: 'Boolean flag determining if the vendor has been deleted'
type: boolean
example: true
+ language_id:
+ description: 'The language id of the vendor. This is a unique identifier for the language.'
+ type: string
+ example: '1'
+ vendor_hash:
+ description: 'The vendor hash of the vendor. This is a unique identifier for the vendor.'
+ type: string
+ example: 'aaa-sss-www'
+ readOnly: true
+ transaction_name:
+ description: 'The transaction name of the vendor.'
+ type: string
+ example: 'aaa-sss-www'
+ last_login:
+ description: Timestamp
+ type: number
+ format: integer
+ example: '134341234234'
+ readOnly: true
created_at:
description: Timestamp
type: number
format: integer
example: '134341234234'
+ readOnly: true
updated_at:
description: Timestamp
type: number
format: integer
example: '134341234234'
- deleted_at:
- description: Timestamp
- type: number
- format: integer
- example: '134341234234'
+ readOnly: true
+ display_name:
+ description: 'The display name of the vendor.'
+ type: string
+ example: 'Bob the vendor'
+ readOnly: true
type: object
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"
+ # description: |
+ # Attempts to authenticate with the API using a email/password combination.
+
- name: clients
- x-tag-expanded: true
- description: |
- Endpoint definitions for interacting with clients.
+ x-tag-expanded: false
+ # description: |
+ # Endpoint definitions for interacting with clients.
- name: products
description: |
Endpoint definitions for interacting with products.
diff --git a/openapi/components/schemas/client_request.yaml b/openapi/components/schemas/client_request.yaml
index 6866d5ee49..5b3fd1fdab 100644
--- a/openapi/components/schemas/client_request.yaml
+++ b/openapi/components/schemas/client_request.yaml
@@ -135,7 +135,6 @@
description: 'Flag which defines if the client has a valid VAT number'
type: boolean
example: false
- readOnly: true
classification:
description: 'The classification of the client'
type: string
diff --git a/openapi/components/schemas/company.yaml b/openapi/components/schemas/company.yaml
index 01388dddad..0e627825ef 100644
--- a/openapi/components/schemas/company.yaml
+++ b/openapi/components/schemas/company.yaml
@@ -360,7 +360,82 @@
description: "A flag determining whether to include the item description on invoices by default"
type: boolean
example: true
-
+
+ expense_mailbox:
+ description: "The email address for the expense mailbox"
+ type: string
+ example: "expenses@company.com"
+
+ expense_mailbox_active:
+ description: "Whether the expense mailbox is active"
+ type: boolean
+ example: true
+
+ inbound_mailbox_allow_company_users:
+ description: "Whether company users are allowed to use the inbound mailbox"
+ type: boolean
+ example: true
+
+ inbound_mailbox_allow_vendors:
+ description: "Whether vendors are allowed to use the inbound mailbox"
+ type: boolean
+ example: false
+
+ inbound_mailbox_allow_clients:
+ description: "Whether clients are allowed to use the inbound mailbox"
+ type: boolean
+ example: true
+
+ inbound_mailbox_allow_unknown:
+ description: "Whether unknown senders are allowed to use the inbound mailbox"
+ type: boolean
+ example: false
+
+ inbound_mailbox_whitelist:
+ description: "Comma-separated list of whitelisted email addresses for the inbound mailbox"
+ type: string
+ example: "user1@example.com,user2@example.com"
+
+ inbound_mailbox_blacklist:
+ description: "Comma-separated list of blacklisted email addresses for the inbound mailbox"
+ type: string
+ example: "spam@example.com,unwanted@example.com"
+
+ smtp_host:
+ description: "The SMTP host for sending emails"
+ type: string
+ example: "smtp.gmail.com"
+
+ smtp_port:
+ description: "The SMTP port for sending emails"
+ type: integer
+ example: 587
+
+ smtp_encryption:
+ description: "The encryption method for SMTP"
+ type: string
+ enum: [tls, ssl, null]
+ example: "tls"
+
+ smtp_local_domain:
+ description: "The local domain for SMTP"
+ type: string
+ example: "company.com"
+
+ smtp_verify_peer:
+ description: "Whether to verify the SMTP peer"
+ type: boolean
+ example: true
+
+ e_invoice:
+ description: "E-invoice settings for the company"
+ type: object
+ additionalProperties: true
+
+ legal_entity_id:
+ description: "The ID of the legal entity associated with the company"
+ type: integer
+ example: 1234
settings:
$ref: '#/components/schemas/CompanySettings'
type: object
\ No newline at end of file
diff --git a/openapi/components/schemas/company_settings.yaml b/openapi/components/schemas/company_settings.yaml
index f04eab09d7..03052a6c5c 100644
--- a/openapi/components/schemas/company_settings.yaml
+++ b/openapi/components/schemas/company_settings.yaml
@@ -113,8 +113,9 @@
example: "Please approve quote"
lock_invoices:
description: "Toggles whether invoices are locked once sent and cannot be modified further"
- type: boolean
- example: true
+ type: enum
+ enum: [off, when_sent, when_paid, end_of_month]
+ example: 'off'
auto_archive_invoice:
description: "Toggles whether a invoice is archived immediately following payment"
type: boolean
@@ -252,7 +253,7 @@
type: string
example: "Quote Terms are..."
invoice_taxes:
- description: "Taxes can be applied to the invoice"
+ description: "The number of Taxes that can be applied to the invoice"
type: number
example: "1"
invoice_design_id:
@@ -310,7 +311,8 @@
email_sending_method:
description: "The email driver to use to send email, options include default, gmail, client_postmark, client_mailgun, client_brevo, office365"
type: string
- example: default
+ enum: [default, gmail, office365, client_postmark, client_mailgun, mailgun, client_brevo]
+ example: 'default'
gmail_sending_user_id:
description: "The hashed_id of the user account to send email from"
type: string
@@ -839,4 +841,13 @@
description: "The classification for the company"
type: string
example: "individual"
+ valid_until:
+ description: 'Default validity period for quotes'
+ type: string
+ credit_terms:
+ description: 'Default terms for credit notes'
+ type: string
+ credit_footer:
+ description: 'Default footer for credit notes'
+ type: string
type: object
diff --git a/openapi/info.yaml b/openapi/info.yaml
index 00a0c955c3..035a07787d 100644
--- a/openapi/info.yaml
+++ b/openapi/info.yaml
@@ -3,53 +3,46 @@ info:
title: 'Invoice Ninja API Reference.'
description: |
---
+ ![Invoice Ninja](https://invoicing.co/images/new_logo.png)
## Introduction
Welcome to the Invoice Ninja API documentation, your comprehensive guide to integrating Invoice Ninja's powerful features into your applications. Whether you're building a custom client, automating workflows, or integrating with other systems, our API provides the tools you need to streamline your invoicing and billing processes.
-
- ## What is Invoice Ninja?
+ ### What is Invoice Ninja?
Invoice Ninja is a robust source-available platform designed to simplify invoicing, billing, and payment management for freelancers, small businesses, and enterprises alike. With a user-friendly interface, customizable templates, and a suite of powerful features, Invoice Ninja empowers businesses to create professional invoices, track expenses, manage clients, and get paid faster.
-
- ## Why use the Invoice Ninja API?
+ ### Why use the Invoice Ninja API?
The Invoice Ninja API allows developers to extend the functionality of Invoice Ninja by programmatically accessing and manipulating data within their Invoice Ninja accounts. With the API, you can automate repetitive tasks, integrate with third-party services, and build custom solutions tailored to your specific business needs.
-
- ## Getting Started
+ ### Getting Started
To get started with the Invoice Ninja API, you'll need an active Invoice Ninja account (or your own self hosted installation) and API credentials. If you haven't already done so, sign up for an account at Invoice Ninja and generate your API keys from the settings section.
Once you have your API credentials, you can start exploring the API endpoints, authentication methods, request and response formats, and more using the documentation provided here.
-
- ## Explore the Documentation
+ ### Explore the Documentation
This documentation is organized into sections to help you navigate and understand the various aspects of the Invoice Ninja API:
- Authentication: Learn how to authenticate your requests to the API using API tokens.
- Endpoints: Explore the available API endpoints for managing invoices, clients, payments, expenses, and more.
- Request and Response Formats: Understand the structure of API requests and responses, including parameters, headers, and payloads.
- Error Handling: Learn about error codes, status messages, and best practices for handling errors gracefully.
- Code Examples: Find code examples and tutorials to help you get started with integrating the Invoice Ninja API into your applications.
-
- ## Need Help?
+ - Authentication: Learn how to authenticate your requests to the API using API tokens.
+ - Endpoints: Explore the available API endpoints for managing invoices, clients, payments, expenses, and more.
+ - Request and Response Formats: Understand the structure of API requests and responses, including parameters, headers, and payloads.
+ - Error Handling: Learn about error codes, status messages, and best practices for handling errors gracefully.
+ - Code Examples: Find code examples and tutorials to help you get started with integrating the Invoice Ninja API into your applications.
+ ### Need Help?
If you have any questions, encounter any issues, or need assistance with using the Invoice Ninja API, don't hesitate to reach out to our support team or join our community forums. We're here to help you succeed with Invoice Ninja and make the most of our API.
Let's start building together!
-
- ## Endpoints
+ ### Endpoints
Production: https://invoicing.co
Demo: https://demo.invoiceninja.com
- ## Client Libraries
+ ### Client Libraries
PHP SDK can be found [here](https://github.com/invoiceninja/sdk-php)
-
- ## Authentication:
+ ### Authentication:
Invoice Ninja uses API tokens to authenticate requests. You can view and manage your API keys in Settings > Account Management > Integrations > API tokens
API requests must be made over HTTPS. Calls made to HTTP will fail.
-
- ## Errors:
+ ### Errors:
Invoice Ninja uses standard HTTP response codes to indicate the success or failure of a request. below is a table of standard status codes and responses
@@ -67,10 +60,9 @@ info:
| 422 | Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors. |
| 429 | Too Many Requests: The user has sent too many requests in a given amount of time ("rate limiting"). |
| 500 | Internal Server Error: A generic error message, given when an unexpected condition was encountered and no more specific message is suitable. |
+ ### Pagination
- ## Pagination
-
- When using index routes to retrieve lists of data, by default we limit the number of records returned to 20. You can using standard pagination to paginate results, ie:
+ When using index routes to retrieve lists of data, by default we limit the number of records returned to 20. You can using standard pagination to paginate results, ie: ?per_page=50
termsOfService: 'https://invoiceninja.github.io/docs/legal/terms_of_service/#page-content'
contact:
email: contact@invoiceninja.com
@@ -79,7 +71,7 @@ info:
license:
name: 'Elastic License'
url: 'https://www.elastic.co/licensing/elastic-license'
- version: 5.9.2
+ version: 5.10.31
servers:
- url: 'https://demo.invoiceninja.com'
description: |
diff --git a/openapi/misc/misc.yaml b/openapi/misc/misc.yaml
index c7c101693e..43a10765e4 100644
--- a/openapi/misc/misc.yaml
+++ b/openapi/misc/misc.yaml
@@ -1,14 +1,12 @@
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"
+ # description: |
+ # Attempts to authenticate with the API using a email/password combination.
+
- name: clients
- x-tag-expanded: true
- description: |
- Endpoint definitions for interacting with clients.
+ x-tag-expanded: false
+ # description: |
+ # Endpoint definitions for interacting with clients.
- name: products
description: |
Endpoint definitions for interacting with products.
diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml
index c71bad4053..3f262e86df 100644
--- a/openapi/paths/clients.yaml
+++ b/openapi/paths/clients.yaml
@@ -3,17 +3,19 @@
tags:
- clients
summary: 'List clients'
- x-code-samples:
- - lang: go
+ x-codeSamples:
+ - lang: php
label: php
source: |
$ninja = new InvoiceNinja("your_token");
$invoices = $ninja->clients->all();
- x-custom-element:
- type: markdown
- value: |
- ### Custom Response Description
- This is a custom description for the response returned by the `/example` endpoint.
+ - lang: curl
+ label: curl
+ source: |
+ curl --request GET \
+ --url 'https://invoicing.co/api/v1/clients?per_page=10&page=1&sort=name&sort_dir=asc' \
+ --header 'X-API-TOKEN: YOUR_API_TOKEN_HERE' \
+ --header 'Accept: application/json'
description: |
When retrieving a list of clients you can also chain query parameters in order to filter the dataset that is returned. For example, you can send a request to the following URL to retrieve clients that have a balance greater than 1000:\
@@ -128,20 +130,8 @@
$ref: '#/components/headers/X-RateLimit-Limit'
content:
application/json:
- schema:
- type: object
- properties:
- data:
- type: array
- items:
- $ref: '#/components/schemas/Client'
- example:
- $ref: '#/components/schemas/Client'
- meta:
- type: object
- $ref: '#/components/schemas/Meta'
- example:
- $ref: '#/components/schemas/Meta'
+ schema:
+ $ref: '#/components/schemas/Client'
401:
$ref: '#/components/responses/401'
403:
@@ -410,7 +400,43 @@
tags:
- clients
summary: 'Bulk client actions'
- description: 'Archive / Restore / Delete in bulk'
+ description: |
+ Bulk actions allow to make changes to multiple clients in a single request the following actions are supported
+
+ - archive
+ - restore
+ - delete
+ - template _requires template,template_id properties also_
+ - assign_group _requires group_settings_id also_
+ - bulk_update _ requires column,new_value also_
+
+ All of these actions require an array of client ids to perform the requested action on ie.
+
+ "ids":['id1','id2']
+
+ actions such as template, assign_group and bulk_update also require additional properties to be passed in the request
+
+ - template
+
+ The template bulk action allows the creation of a custom template using the provided template_id to be run against the array of clients provided.
+
+ - assign_group
+
+ Allows the setting of multiple clients to a single group
+
+ - bulk_update
+
+ Allows updating certain columns on the client model in bulk. the current list of supported columns that can be updated archived_at:
+
+ - public_notes
+ - industry_id
+ - size_id
+ - country_id
+ - custom_value1
+ - custom_value2
+ - custom_value3
+ - custom_value4
+
operationId: bulkClients
parameters:
- $ref: '#/components/parameters/X-API-TOKEN'
@@ -426,7 +452,7 @@
responses:
200:
- description: 'The Client listresponse'
+ description: 'The Client list Response of the updated clients that were bulk updated'
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION'
@@ -511,7 +537,7 @@
- clients
summary: 'Purge client'
description: |
- Handles purging a clients.
+ Handles purging a client.
Please note this is a destructive action.
diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml
index e91e291992..a270cde27b 100644
--- a/openapi/paths/products.yaml
+++ b/openapi/paths/products.yaml
@@ -3,7 +3,7 @@
tags:
- products
summary: "List products"
- x-code-samples:
+ x-codeSamples:
- lang: curl
label: Curl
source: |
@@ -96,7 +96,7 @@
tags:
- products
summary: "Create Product"
- x-code-samples:
+ x-codeSamples:
- lang: curl
label: Curl
source: |
@@ -159,7 +159,7 @@
tags:
- products
summary: "Show product"
- x-code-samples:
+ x-codeSamples:
- lang: curl
label: Curl
source: |
@@ -215,7 +215,7 @@
tags:
- products
summary: "Update product"
- x-code-samples:
+ x-codeSamples:
- lang: curl
label: Curl
source: |
@@ -287,7 +287,7 @@
tags:
- products
summary: "Delete product"
- x-code-samples:
+ x-codeSamples:
- lang: curl
label: Curl
source: |
@@ -340,7 +340,7 @@
tags:
- products
summary: "Edit product"
- x-code-samples:
+ x-codeSamples:
- lang: curl
label: Curl
source: |
@@ -435,7 +435,7 @@
tags:
- products
summary: "Bulk product actions"
- x-code-samples:
+ x-codeSamples:
- lang: curl
label: Curl
source: |