{
"date_updated": "datetime",
"date_created": "datetime",
"id": "int",
"title": "string"
}
{
"billing_address": "string",
"group": "int",
"billing_email": "unknown",
"title": "string",
"web_site": "unknown",
"country": "string",
"billing_cycle_days": "int",
"vat_no": "string",
"telephone_number": "string",
"fax_number": "string",
"id": "int",
"currency": "string",
"date_updated": "datetime",
"timezone": "unknown",
"logo": "image file",
"date_created": "datetime",
"next_billing_date": "datetime",
"is_active": "boolean",
"slug": "unknown",
"suspension_warning": "boolean"
}
Provides the ability for a user within a company to view the details, ability for the owner to update the details.
{
"billing_address": "string",
"group": "int",
"billing_email": "unknown",
"title": "string",
"web_site": "unknown",
"country": "string",
"billing_cycle_days": "int",
"vat_no": "string",
"telephone_number": "string",
"fax_number": "string",
"id": "int",
"currency": "string",
"date_updated": "datetime",
"timezone": "unknown",
"logo": "image file",
"date_created": "datetime",
"next_billing_date": "datetime",
"is_active": "boolean",
"slug": "unknown",
"suspension_warning": "boolean"
}
Provides ability to view and update the current user's account.
{
"billing_address": "string",
"group": "int",
"billing_email": "unknown",
"title": "string",
"web_site": "unknown",
"country": "string",
"billing_cycle_days": "int",
"vat_no": "string",
"telephone_number": "string",
"fax_number": "string",
"id": "int",
"currency": "string",
"date_updated": "datetime",
"timezone": "unknown",
"logo": "image file",
"date_created": "datetime",
"next_billing_date": "datetime",
"is_active": "boolean",
"slug": "unknown",
"suspension_warning": "boolean"
}
gets countries, currencies and timezones
{}
Allows an account admin to close their company account.
Will only disable if {"confirmed": true} is received in a delete. Returns {"disabled": True} or {"disabled": False} depending on the success of the operation.
{}
Allows an account admin to close their company account.
Will only disable if {"confirmed": true} is received in a delete. Returns {"disabled": True} or {"disabled": False} depending on the success of the operation.
{}
Provides the ability to any user to list all other users within his/her company and allows a company owner to create more users within that company.
{
"first_name": "string",
"last_name": "string",
"is_staff": "boolean",
"use_as_company": "int",
"user_is_active": "boolean",
"company": "int",
"is_imported": "boolean",
"power_pack": "int",
"id": "int",
"is_superuser": "boolean",
"email": "unknown",
"last_login": "datetime",
"view_group": "boolean",
"is_admin": "boolean",
"password": "string",
"slug": "unknown"
}
Provides ability to view and update the current user's account.
{
"first_name": "string",
"last_name": "string",
"is_staff": "boolean",
"use_as_company": "int",
"user_is_active": "boolean",
"company": "int",
"is_imported": "boolean",
"power_pack": "int",
"id": "int",
"is_superuser": "boolean",
"email": "unknown",
"last_login": "datetime",
"view_group": "boolean",
"is_admin": "boolean",
"password": "string",
"slug": "unknown"
}
Provides ability to view and update the current user's account.
{
"first_name": "string",
"last_name": "string",
"is_staff": "boolean",
"use_as_company": "int",
"user_is_active": "boolean",
"company": "int",
"is_imported": "boolean",
"power_pack": "int",
"id": "int",
"is_superuser": "boolean",
"email": "unknown",
"last_login": "datetime",
"view_group": "boolean",
"is_admin": "boolean",
"password": "string",
"slug": "unknown"
}
Provides the ability to any user to retrieve details on any other user within his/her company, company owners are allowed to update or destroy those users.
{
"first_name": "string",
"last_name": "string",
"is_staff": "boolean",
"use_as_company": "int",
"user_is_active": "boolean",
"company": "int",
"is_imported": "boolean",
"power_pack": "int",
"id": "int",
"is_superuser": "boolean",
"email": "unknown",
"last_login": "datetime",
"view_group": "boolean",
"is_admin": "boolean",
"password": "string",
"slug": "unknown"
}
Allows an account admin to disable a user's account
Returns {"disabled": True} or {"disabled": False} depending on the success of the operation.
{}
Allows an account admin to enable a user's account
Returns {"enabled": True} or {"enabled": False} depending on the success of the operation.
{}
Allows resetting of a user's password
Will only reset if {"confirmed": true} is received in a delete. Returns {"disabled": True} or {"disabled": False} depending on the success of the operation.
{}
Returns a list of all the Activity objects available to the currently logged in user.
{
"date_created": "datetime",
"user": "int",
"max_pos": "int",
"title": "string",
"cur_pos": "int",
"company": "int",
"issue": "string",
"id": "int",
"activity_type": "int"
}
{
"date_created": "datetime",
"user": "int",
"max_pos": "int",
"title": "string",
"cur_pos": "int",
"company": "int",
"issue": "string",
"id": "int",
"activity_type": "int"
}
{
"date_sent": "datetime",
"date_read": "datetime",
"user": "int",
"read": "boolean",
"text": "string",
"type": "int",
"id": "int",
"subject": "string"
}
{
"date_sent": "datetime",
"date_read": "datetime",
"user": "int",
"read": "boolean",
"text": "string",
"type": "int",
"id": "int",
"subject": "string"
}
Provides the ability to list Packages eg. Basic, Pro, Enterprise
{
"credits": "int",
"slug": "unknown",
"id": "int",
"title": "string"
}
Provides the ability to view details on an individual package.
{
"credits": "int",
"slug": "unknown",
"id": "int",
"title": "string"
}
Provides the ability to list Package prices within the users company / country scope
{
"currency": "string",
"country": "string",
"price": "unknown",
"id": "int",
"package": "int"
}
Provides the ability to view details on an individual package price.
{
"currency": "string",
"country": "string",
"price": "unknown",
"id": "int",
"package": "int"
}
Provides the ability to view the current package for the user's company
{}
Provides the ability to retrieve details on an individual power pack
{
"tier": "int",
"slug": "unknown",
"id": "int",
"title": "string"
}
Provides the ability to list role power packs
{
"tier": "int",
"slug": "unknown",
"id": "int",
"title": "string"
}
Allows a user within a company to view the company wallet
{
"packaged_credits": "int",
"purchased_credits": "int",
"date_updated": "datetime",
"date_created": "datetime",
"company": "unknown",
"send_without_credits": "boolean",
"id": "int"
}
Allows a user within a company to create credit requests.
{
"credits": "int",
"approved_by": "int",
"updated_by": "int",
"date_updated": "datetime",
"date_created": "datetime",
"company": "int",
"id": "int",
"created_by": "int"
}
Allows a user within a company to view the company's transactions
{
"updated_by": "int",
"date_updated": "datetime",
"object_pk": "int",
"created_by": "int",
"wallet": "int",
"reason": "int",
"packaged_credits": "int",
"content_type": "int",
"date_created": "datetime",
"purchased_credits": "int",
"id": "int"
}
Allows a user within a company to view an individual company transaction
{
"updated_by": "int",
"date_updated": "datetime",
"object_pk": "int",
"created_by": "int",
"wallet": "int",
"reason": "int",
"packaged_credits": "int",
"content_type": "int",
"date_created": "datetime",
"purchased_credits": "int",
"id": "int"
}
Allows a user within a company to set credits threshold.
{
"email_sent_date": "datetime",
"credit_threshold": "int",
"updated_by": "int",
"date_updated": "datetime",
"date_created": "datetime",
"company": "unknown",
"id": "int",
"created_by": "int"
}