Preparing search index...
The search index is not available
InvoiceDesk | @invoicedesk/client - v1.3.0
@invoicedesk/client
InvoiceDesk
Class InvoiceDesk
Hierarchy
InvoiceDesk
Index
Constructors
constructor
Accessors
accounts
clients
companies
invoices
products
profile
projects
tags
teams
Methods
set
Auth
Token
Constructors
constructor
new
Invoice
Desk
(
__namedParameters
)
:
InvoiceDesk
Parameters
__namedParameters
:
Config
Returns
InvoiceDesk
Accessors
accounts
get
accounts
(
)
:
AccountAPI
Returns
AccountAPI
clients
get
clients
(
)
:
ClientAPI
Returns
ClientAPI
companies
get
companies
(
)
:
CompanyAPI
Returns
CompanyAPI
invoices
get
invoices
(
)
:
InvoiceAPI
Returns
InvoiceAPI
products
get
products
(
)
:
ProductAPI
Returns
ProductAPI
profile
get
profile
(
)
:
UserProfileAPI
Returns
UserProfileAPI
projects
get
projects
(
)
:
ProjectAPI
Returns
ProjectAPI
tags
get
tags
(
)
:
TagsAPI
Returns
TagsAPI
teams
get
teams
(
)
:
TeamAPI
Returns
TeamAPI
Methods
set
Auth
Token
set
Auth
Token
(
token
)
:
void
Set the auth token to be used for all requests.
Parameters
token
:
string
Returns
void
Throws
if token is empty
On This Page
constructor
accounts
clients
companies
invoices
products
profile
projects
tags
teams
set
Auth
Token
@invoicedesk/client -
v1.3.0
Create
Invoice
Payload
discount
Type
Type of discount to apply to the invoice
Create
Product
Payload
type
Type of the product (goods/services)
Create
Timesheet
Pay
Load
priority
Priority of the task
status
Status of the task being created
Invoice
discount
Type
The treatment of discount value. Either flat rate or percentage
payment
Status
The payment status of the invoice
Invoice
Line
Item
type
Type of line item.
Line
Item
type
The type of entity being invoiced
Project
status
The current status of the project
Tag
Entities
Request
Body
taggable
Type
Type of entity being tagged.
Update
Invoice
Request
Body
discount
Type
Type of discount
status
Status of the invoice
Update
Product
Payload
type
Type of the product (goods/services)
Update
Project
Payload
status
Status of the project
AccountAPI
Api
Error
Base
Http
Request
Cancel
Error
Cancelable
Promise
ClientAPI
CompanyAPI
Company
SettingsAPI
DashboardAPI
InvoiceAPI
Invoice
Desk
Invoice
Desk
Client
Invoice
PaymentsAPI
MediaAPI
ProductAPI
ProjectAPI
RoleAPI
Static
DataAPI
SubscriptionAPI
Subscription
V2API
TaggablesAPI
TagsAPI
TeamAPI
TimesheetAPI
User
ProfileAPI
WebhooksAPI
APIResponse
Account
Api
Token
Client
Company
Company
Contact
Info
Company
Response
Complete
Invite
Flow
Body
Complete
Invite
Flow
Response
Config
Contact
Info
Create
Account
Request
Create
Account
Response
Create
Api
Token
Response
Create
Client
Payload
Create
Client
Response
Create
Company
Data
Create
Company
Response
Create
Invoice
Payload
Create
Invoice
Response
Create
Product
Payload
Create
Product
Response
Create
Project
Pay
Load
Create
Project
Response
Create
Subscription
Order
Response
Create
Tag
Request
Body
Create
Tag
Response
Create
Tax
Settings
Request
Create
Tax
Settings
Response
Create
Timesheet
Pay
Load
Create
Timesheet
Response
Create
Token
Payload
Current
Subscription
Response
Dashboard
Data
Dashboard
Response
Delete
Client
Response
Delete
Media
Response
Delete
Product
Payload
Delete
Product
Response
Delete
Project
Response
Delete
Team
Member
Response
Delivery
Options
Email
Delivery
Options
Exchange
Token
For
Details
Response
Get
Account
Details
Response
Get
Client
Response
Get
Company
Payments
Response
Get
Company
Query
Params
Get
Company
Response
Get
Invoice
Payments
Response
Get
Invoice
Response
Get
Media
Response
Get
Project
Response
Get
Tag
Response
Identity
Response
Import
Invoice
Item
Import
Invoices
Payload
Import
Invoices
Response
Invitation
Detail
Invite
Team
Member
Request
Body
Invoice
Invoice
Line
Item
Invoice
Settings
Invoice
Settings
Response
Invoice
Status
Counts
Line
Item
List
Cities
Response
List
Clients
Response
List
Companies
Response
List
Countries
Response
List
Currencies
Response
List
Invoice
Response
List
Media
Response
List
Products
Response
List
Projects
Response
List
Roles
Response
List
States
Response
List
Subscription
Invoices
Response
List
Subscription
Plans
Response
List
Subscription
Plans
V2
Response
List
Tags
Response
List
Team
Members
Response
List
Time
Entries
Response
Media
Monthly
Invoice
Stats
Monthly
Revenue
OpenAPIConfig
Pagination
Pagination
Meta
Payment
Product
Project
Project
Team
Member
Record
Payment
Request
Body
Record
Payment
Response
Resend
Invite
Request
Body
Role
Role
Detail
Send
Invoice
Request
Body
Subscription
Invoice
Subscription
Plan
V2
Response
Success
Response
Tag
Tag
Entities
Request
Body
Tag
Entities
Response
Tag
Response
Taggable
Response
Tax
Registration
Tax
Settings
Team
Invite
Response
Team
Member
Time
Sheet
Update
Account
Request
Body
Update
Client
Data
Update
Client
Response
Update
Company
Data
Update
Company
Response
Update
Invoice
Request
Body
Update
Media
Request
Body
Update
Media
Response
Update
Product
Payload
Update
Product
Response
Update
Project
Payload
Update
Project
Response
Update
Tag
Response
Update
Team
Member
Request
Body
Update
Team
Member
Response
Update
Timesheet
Request
Body
Update
Timesheet
Response
Update
User
Profile
Request
Upload
Media
Request
Body
Upload
Media
Response
User
Verify
Subscription
Payment
Request
OpenAPI
Set the auth token to be used for all requests.