Reckon One API v2
API change historyThis is version 2 of the Reckon One API.
Gets a list of roles.
See here for details of paging, filtering, sorting and selecting.
Get a paged list of roles for the specified book.
GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/roles
Get a specific page of roles. Find out more about paging.
GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/roles?page=2&perpage=2
Get just the required fields, e.g. id and name. Find out more about selecting.
GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/roles?select=id,name
Filter the results to return just the roles you want. Find out more about filtering.
GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/roles?filter=name eq "Administrator"
Sort in the required order, e.g. by systemRole and then by name. Find out more about sorting.
GET /e7e3ba02-05e2-4bea-9348-85876c9952ba/roles?orderby=systemRole,name
Request
Request URL
Request parameters
-
string
Format - guid. The book's id.
-
(optional)integer
Format - int32. The page to retrieve.
-
(optional)integer
Format - int32. The number of roles per page.
Request headers
Request body
Responses
200 OK
A paged list of roles for the specified book.
Representations
{
"list": [
{
"id": 1532,
"name": "Administrator",
"description": "These users have full access to the book. Owners of a book are automatically assigned to this role.",
"systemRole": true,
"permissions": {
"accountEnquiryReport": {
"view": true,
"export": false
},
"accountListReport": {
"view": true,
"export": false
},
"accounts": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"activityStatements": {
"email": true,
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"lodge": true
},
"agedCreditorsSummaryReport": {
"view": true,
"export": false
},
"agedCreditorsTransactionsReport": {
"view": true,
"export": false
},
"agedDebtorsSummaryReport": {
"view": true,
"export": false
},
"agedDebtorsTransactionsReport": {
"view": true,
"export": false
},
"balanceSheetReport": {
"view": true,
"export": false
},
"bankAccounts": {
"view": true,
"create": true,
"edit": true,
"delete": false,
"import": true,
"reconcile": false
},
"bankPayments": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"bankReconciliationReport": {
"view": true,
"export": false
},
"bankStatementReport": {
"view": true,
"export": false
},
"bankTransfers": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"billListReport": {
"view": true,
"export": false
},
"bills": {
"email": true,
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"approve": false
},
"bookSettings": {
"view": true,
"edit": true
},
"budgets": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"budgetsReport": {
"view": true,
"export": false
},
"classifications": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"contactDetailTypes": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"contacts": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"creditNotes": {
"email": true,
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"approve": false
},
"customerListReport": {
"view": true,
"export": false
},
"customers": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"customerStatements": {
"create": true
},
"customerTransactionsReport": {
"view": true,
"export": false
},
"departments": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"documentStorage": {
"upload": false,
"download": true,
"delete": false
},
"emails": {
"viewHistory": false,
"resend": true
},
"emailSettings": {
"view": true,
"edit": true
},
"employees": {
"view": true,
"create": true,
"edit": true,
"delete": false,
"managePayrollEmployeeDetails": false,
"viewOwnDetails": true,
"editOwnDetails": true
},
"employeeListReport": {
"view": true,
"export": false
},
"estimateListReport": {
"view": true,
"export": false
},
"estimates": {
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"email": true
},
"expenseClaimListReport": {
"view": true,
"export": false
},
"expenseClaims": {
"approve": false,
"email": true,
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"manage": false
},
"expenseClaimSettings": {
"view": true,
"edit": true
},
"expenseClaimTransactionsReport": {
"view": true,
"export": false
},
"gstSummaryReport": {
"view": true,
"export": false
},
"invoiceListReport": {
"view": true,
"export": false
},
"invoices": {
"email": true,
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"approve": false
},
"itemListReport": {
"view": true,
"export": false
},
"items": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"journalListReport": {
"view": true,
"export": false
},
"journals": {
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"approve": false
},
"ledgerTransactionsReport": {
"view": true,
"export": false
},
"moneyInSettings": {
"view": true,
"edit": true
},
"moneyOutSettings": {
"view": true,
"edit": true
},
"paymentListReport": {
"view": true,
"export": false
},
"payments": {
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"email": true
},
"payrollAdjustments": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"payrollDetailReport": {
"view": true,
"export": false
},
"payrollEmployeeListReport": {
"view": true,
"export": false
},
"payrollItems": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"payrollLeaveBalancesReport": {
"view": true,
"export": false
},
"payrollPayments": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"payrollPaymentScheduleReport": {
"view": true,
"export": false
},
"payrollSettings": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"payrollSummaryReport": {
"view": true,
"export": false
},
"payrollTransactionSummaryReport": {
"view": true,
"export": false
},
"payrollPaymentSummaries": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"payruns": {
"view": true,
"create": true,
"edit": true,
"delete": false,
"approve": false,
"manage": false
},
"paySlips": {
"view": true,
"manage": true,
"print": true,
"email": true
},
"profitAndLossReport": {
"view": true,
"export": false
},
"projectListReport": {
"view": true,
"export": false
},
"projects": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"receiptListReport": {
"view": true,
"export": false
},
"receipts": {
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"email": true
},
"recurringTransactions": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"reportSettings": {
"view": true,
"edit": true
},
"restHooks": {
"modify": false
},
"roles": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"salesByItemReport": {
"view": true,
"export": false
},
"singleTouchPayroll": {
"view": true,
"create": true,
"edit": true,
"send": false
},
"statementSettings": {
"view": true,
"edit": true
},
"superContributionsByEmployeeReport": {
"view": true,
"export": false
},
"superFunds": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"superStream": {
"view": true,
"create": true,
"edit": true,
"delete": false,
"canLodge": true
},
"superTransactionsReport": {
"view": true,
"export": false
},
"supplierCreditNotes": {
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"approve": false
},
"supplierListReport": {
"view": true,
"export": false
},
"suppliers": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"supplierTransactionsReport": {
"view": true,
"export": false
},
"taxCodeExceptionReport": {
"view": true,
"export": false
},
"taxCodeListReport": {
"view": true,
"export": false
},
"taxCodeTransactionsReport": {
"view": true,
"export": false
},
"taxSettings": {
"view": true,
"edit": true,
"canDeleteCodeGroup": true
},
"terms": {
"view": true,
"create": true,
"edit": true,
"delete": false
},
"timeEntries": {
"approve": false,
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"manage": false,
"assignPayItem": true
},
"timeEntriesReport": {
"view": true,
"export": false
},
"timeSettings": {
"view": true,
"edit": true
},
"topCustomersReport": {
"view": true,
"export": false
},
"topExpenseAccountsReport": {
"view": true,
"export": false
},
"topIncomeAccountsReport": {
"view": true,
"export": false
},
"topSuppliersReport": {
"view": true,
"export": false
},
"tpar": {
"email": true,
"print": true,
"view": true,
"create": true,
"edit": true,
"delete": false,
"lodge": true
},
"transactionLineItemsReport": {
"view": true,
"export": false
},
"trialBalanceReport": {
"view": true,
"export": false
},
"uninvoicedAmountsByCustomerReport": {
"view": true,
"export": false
},
"uninvoicedAmountsByProjectReport": {
"view": true,
"export": false
},
"uninvoicedTransactionsByCustomerReport": {
"view": true,
"export": false
},
"uninvoicedTransactionsByProjectReport": {
"view": true,
"export": false
},
"users": {
"view": true,
"create": true,
"edit": true,
"delete": false,
"editOtherUser": false,
"invite": true
},
"vat": {
"authorise": true,
"print": true,
"submit": true,
"view": false
}
},
"users": [
{
"id": "3072ec37-0c1f-4f5f-8f13-b058590c826f",
"name": "joebloggs@company.com"
}
]
}
]
}{
"type": "object",
"properties": {
"list": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The role's unique id.",
"format": "int32",
"example": 1532
},
"name": {
"type": "string",
"description": "The role's unique name.",
"example": "Administrator"
},
"description": {
"type": "string",
"description": "A description of the role.",
"nullable": true,
"example": "These users have full access to the book. Owners of a book are automatically assigned to this role."
},
"systemRole": {
"type": "boolean",
"description": "Whether or not the role is a system role.\nSystem roles cannot be modified or deleted.",
"example": true
},
"permissions": {
"oneOf": [
{
"type": "object",
"properties": {
"accountEnquiryReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Account Enquiry report.",
"nullable": true
},
"accountListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Account List report.",
"nullable": true
},
"accounts": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for the Chart of Accounts.",
"nullable": true
},
"activityStatements": {
"oneOf": [
{
"type": "object",
"properties": {
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"lodge": {
"type": "boolean",
"description": "Whether the role has permission to lodge.",
"example": true
}
},
"additionalProperties": false,
"description": "Common role permissions plus print, email and lodge actions."
}
],
"description": "Permissions for Activity Statements.",
"nullable": true
},
"agedCreditorsSummaryReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Aged Creditors summary report.",
"nullable": true
},
"agedCreditorsTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Aged Creditors transactions report.",
"nullable": true
},
"agedDebtorsSummaryReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Aged Debtors summary report.",
"nullable": true
},
"agedDebtorsTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Aged Debtors transactions report.",
"nullable": true
},
"balanceSheetReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Balance Sheet report.",
"nullable": true
},
"bankAccounts": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"import": {
"type": "boolean",
"description": "Whether the role has permission to import bank data.",
"example": true
},
"reconcile": {
"type": "boolean",
"description": "Whether the role has permission to reconcile a bank account.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for bank accounts."
}
],
"description": "Permissions for bank accounts.",
"nullable": true
},
"bankPayments": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for bank payments.",
"nullable": true
},
"bankReconciliationReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Bank Reconciliation report.",
"nullable": true
},
"bankStatementReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Bank Statement report.",
"nullable": true
},
"bankTransfers": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for bank transfers.",
"nullable": true
},
"billListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Bill List report.",
"nullable": true
},
"bills": {
"oneOf": [
{
"type": "object",
"properties": {
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions plus print, email and approve actions."
}
],
"description": "Permissions for bills.",
"nullable": true
},
"bookSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Permissions for book settings.",
"nullable": true
},
"budgets": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for budgets.",
"nullable": true
},
"budgetsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Budgets report.",
"nullable": true
},
"classifications": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for classifications.",
"nullable": true
},
"contactDetailTypes": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for contact detail types.",
"nullable": true
},
"contacts": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for contacts.",
"nullable": true
},
"creditNotes": {
"oneOf": [
{
"type": "object",
"properties": {
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions plus print, email and approve actions."
}
],
"description": "Permissions for credit notes.",
"nullable": true
},
"customerListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Customer List report.",
"nullable": true
},
"customers": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for customers.",
"nullable": true
},
"customerStatements": {
"oneOf": [
{
"type": "object",
"properties": {
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for customer statements."
}
],
"description": "Permissions for customer statements.",
"nullable": true
},
"customerTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permssions for the Customer Transactions report.",
"nullable": true
},
"departments": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for departments.",
"nullable": true
},
"documentStorage": {
"oneOf": [
{
"type": "object",
"properties": {
"upload": {
"type": "boolean",
"description": "Whether the role has permission to upload.",
"example": false
},
"download": {
"type": "boolean",
"description": "Whether the role has permission to download.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for document storage."
}
],
"description": "Permissions for document storage.",
"nullable": true
},
"emails": {
"oneOf": [
{
"type": "object",
"properties": {
"viewHistory": {
"type": "boolean",
"description": "Whether the role has permission to view history.",
"example": false
},
"resend": {
"type": "boolean",
"description": "Whether the role has permission to resend.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for emails."
}
],
"description": "Permissions for emails.",
"nullable": true
},
"emailSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Permissions for email settings.",
"nullable": true
},
"employees": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"managePayrollEmployeeDetails": {
"type": "boolean",
"description": "Whether the role can manage payroll employee's details.",
"example": false
},
"viewOwnDetails": {
"type": "boolean",
"description": "Whether the role can view own employee details.",
"example": true
},
"editOwnDetails": {
"type": "boolean",
"description": "Whether the role can edit own employee details.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for employees."
}
],
"description": "Permissions for employees.",
"nullable": true
},
"employeeListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Employee List report.",
"nullable": true
},
"estimateListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Estimate List report.",
"nullable": true
},
"estimates": {
"oneOf": [
{
"type": "object",
"properties": {
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
}
},
"additionalProperties": false,
"description": "Common role permissions plus print and email actions."
}
],
"description": "Permissions for estimates.",
"nullable": true
},
"expenseClaimListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Expense Claim List report.",
"nullable": true
},
"expenseClaims": {
"oneOf": [
{
"type": "object",
"properties": {
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
},
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"manage": {
"type": "boolean",
"description": "Whether the role has permission to manage.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions plus print, email, approve and manage actions."
}
],
"description": "Permissions for expense claims.",
"nullable": true
},
"expenseClaimSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Permissions for expense claim settings.",
"nullable": true
},
"expenseClaimTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Expense Claim Transactions report.",
"nullable": true
},
"gstSummaryReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the GST Summary report.",
"nullable": true
},
"invoiceListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Invoice List report.",
"nullable": true
},
"invoices": {
"oneOf": [
{
"type": "object",
"properties": {
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions plus print, email and approve actions."
}
],
"description": "Permissions for invoices.",
"nullable": true
},
"itemListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Item List report.",
"nullable": true
},
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for items.",
"nullable": true
},
"journalListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Journal List report.",
"nullable": true
},
"journals": {
"oneOf": [
{
"type": "object",
"properties": {
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions plus print and approve actions."
}
],
"description": "Permissions for journals.",
"nullable": true
},
"ledgerTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Ledger Transactions report.",
"nullable": true
},
"moneyInSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Settings for money in settings (invoices, receipts, credit notes etc.).",
"nullable": true
},
"moneyOutSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Permissions for money out settings (bills, payments, supplier credit notes etc.).",
"nullable": true
},
"paymentListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Payment List report.",
"nullable": true
},
"payments": {
"oneOf": [
{
"type": "object",
"properties": {
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
}
},
"additionalProperties": false,
"description": "Common role permissions plus print and email actions."
}
],
"description": "Permissions for payments.",
"nullable": true
},
"payrollAdjustments": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for payroll adjustments.",
"nullable": true
},
"payrollDetailReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Payroll Detail report.",
"nullable": true
},
"payrollEmployeeListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Payroll Employee List report.",
"nullable": true
},
"payrollItems": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for payroll pay items.",
"nullable": true
},
"payrollLeaveBalancesReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Payroll Leave Balances report.",
"nullable": true
},
"payrollPayments": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for payroll payments.",
"nullable": true
},
"payrollPaymentScheduleReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Payroll Payment Schedule report.",
"nullable": true
},
"payrollSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for payroll settings.",
"nullable": true
},
"payrollSummaryReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Payroll Summary report.",
"nullable": true
},
"payrollTransactionSummaryReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Payroll Transaction Summary report.",
"nullable": true
},
"payrollPaymentSummaries": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for payroll payment summaries.",
"nullable": true
},
"payruns": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
},
"manage": {
"type": "boolean",
"description": "Whether the role has permission to manage.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions plus approve and manage actions."
}
],
"description": "Permissions for pay runs.",
"nullable": true
},
"paySlips": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"manage": {
"type": "boolean",
"description": "Whether the role has permission to manage.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for pay slips."
}
],
"description": "Permissions for pay slips.",
"nullable": true
},
"profitAndLossReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Profit And Loss report.",
"nullable": true
},
"projectListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Project List report.",
"nullable": true
},
"projects": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for projects.",
"nullable": true
},
"receiptListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Receipts List report.",
"nullable": true
},
"receipts": {
"oneOf": [
{
"type": "object",
"properties": {
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
}
},
"additionalProperties": false,
"description": "Common role permissions plus print and email actions."
}
],
"description": "Permissons for receipts.",
"nullable": true
},
"recurringTransactions": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for recurring transactions.",
"nullable": true
},
"reportSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Permissions for settings.",
"nullable": true
},
"restHooks": {
"oneOf": [
{
"type": "object",
"properties": {
"modify": {
"type": "boolean",
"description": "Whether the role can modify REST hooks.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for REST hooks."
}
],
"description": "Permissions for REST hooks.",
"nullable": true
},
"roles": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for roles.",
"nullable": true
},
"salesByItemReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Sales By Item report.",
"nullable": true
},
"singleTouchPayroll": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"send": {
"type": "boolean",
"description": "Whether the role has permission to send.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for Single Touch Payroll."
}
],
"description": "Permissions for Single Touch Payroll.",
"nullable": true
},
"statementSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Permissions for statements.",
"nullable": true
},
"superContributionsByEmployeeReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Super Contributions By Employee report.",
"nullable": true
},
"superFunds": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for super funds.",
"nullable": true
},
"superStream": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"canLodge": {
"type": "boolean",
"description": "Whether the role has permission to lodge SuperStream.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for SuperStream."
}
],
"description": "Permissions for SuperStream",
"nullable": true
},
"superTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Super Transactions report.",
"nullable": true
},
"supplierCreditNotes": {
"oneOf": [
{
"type": "object",
"properties": {
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions plus print and approve actions."
}
],
"description": "Permissions for supplier credit notes.",
"nullable": true
},
"supplierListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Supplier List report.",
"nullable": true
},
"suppliers": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for suppliers.",
"nullable": true
},
"supplierTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Supplier Transactions report.",
"nullable": true
},
"taxCodeExceptionReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Tax Code Exception report.",
"nullable": true
},
"taxCodeListReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Tax Code List report.",
"nullable": true
},
"taxCodeTransactionsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Tax Code Transactions report.",
"nullable": true
},
"taxSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"canDeleteCodeGroup": {
"type": "boolean",
"description": "Whether the role has permission to delete tax codes and tax groups.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for tax settings."
}
],
"description": "Permissions for tax settings.",
"nullable": true
},
"terms": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
}
},
"additionalProperties": false,
"description": "Common role permissions."
}
],
"description": "Permissions for payment terms.",
"nullable": true
},
"timeEntries": {
"oneOf": [
{
"type": "object",
"properties": {
"approve": {
"type": "boolean",
"description": "Whether the role has permission to approve.",
"example": false
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"manage": {
"type": "boolean",
"description": "Whether the role has permission to manage.",
"example": false
},
"assignPayItem": {
"type": "boolean",
"description": "Whether the role has permission to assign a payroll pay item to a time entry.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for time entries."
}
],
"description": "Permissions for time entries.",
"nullable": true
},
"timeEntriesReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Time Entries report.",
"nullable": true
},
"timeSettings": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for settings."
}
],
"description": "Permissions for time settings.",
"nullable": true
},
"topCustomersReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Top 10 Customers report.",
"nullable": true
},
"topExpenseAccountsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Top 10 Expense Accounts report.",
"nullable": true
},
"topIncomeAccountsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Top 10 Income Accounts report.",
"nullable": true
},
"topSuppliersReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Top 10 Suppliers report.",
"nullable": true
},
"tpar": {
"oneOf": [
{
"type": "object",
"properties": {
"email": {
"type": "boolean",
"description": "Whether the role has permission to email.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"lodge": {
"type": "boolean",
"description": "Whether the role has permission to lodge.",
"example": true
}
},
"additionalProperties": false,
"description": "Common role permissions plus print, email and lodge actions."
}
],
"description": "Permissions for TPAR.",
"nullable": true
},
"transactionLineItemsReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Transaction Line Items report.",
"nullable": true
},
"trialBalanceReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Trial Balance report.",
"nullable": true
},
"uninvoicedAmountsByCustomerReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Uninvoiced Amounts By Customer report.",
"nullable": true
},
"uninvoicedAmountsByProjectReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Uninvoiced Amounts By Project report.",
"nullable": true
},
"uninvoicedTransactionsByCustomerReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Uninvoiced Amounts By Customer report.",
"nullable": true
},
"uninvoicedTransactionsByProjectReport": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view the report.",
"example": true
},
"export": {
"type": "boolean",
"description": "Whether the role has permission to export the report.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for a report."
}
],
"description": "Permissions for the Uninvoiced Amounts By Project report.",
"nullable": true
},
"users": {
"oneOf": [
{
"type": "object",
"properties": {
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": true
},
"create": {
"type": "boolean",
"description": "Whether the role has permission to create.",
"example": true
},
"edit": {
"type": "boolean",
"description": "Whether the role has permission to edit/update/modify.",
"example": true
},
"delete": {
"type": "boolean",
"description": "Whether the role has permission to delete.",
"example": false
},
"editOtherUser": {
"type": "boolean",
"description": "Whether the role has permission to edit another user's details.",
"example": false
},
"invite": {
"type": "boolean",
"description": "Whether the role has permission to invite a user.",
"example": true
}
},
"additionalProperties": false,
"description": "Role permissions for users."
}
],
"description": "Permissions for users.",
"nullable": true
},
"vat": {
"oneOf": [
{
"type": "object",
"properties": {
"authorise": {
"type": "boolean",
"description": "Whether the role has permission to authorise.",
"example": true
},
"print": {
"type": "boolean",
"description": "Whether the role has permission to print.",
"example": true
},
"submit": {
"type": "boolean",
"description": "Whether the role has permission to submit.",
"example": true
},
"view": {
"type": "boolean",
"description": "Whether the role has permission to view.",
"example": false
}
},
"additionalProperties": false,
"description": "Role permissions for UK VAT."
}
],
"description": "Permissions for UK VAT.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Role permissions."
}
],
"description": "The role's detailed permissions."
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique id.",
"format": "guid",
"nullable": true
},
"name": {
"type": "string",
"description": "The unique name.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Reference to a user."
},
"description": "The users that are assigned to the role.",
"example": [
{
"id": "3072ec37-0c1f-4f5f-8f13-b058590c826f",
"name": "joebloggs@company.com"
}
]
}
},
"additionalProperties": false,
"description": "A role."
},
"description": "The list of items.",
"nullable": true
}
},
"additionalProperties": false,
"description": "A list of roles."
}401 Unauthorized
The authentication token is missing, expired or invalid.
Representations
{
"message": "Authorization has been denied for this request.",
"code": 401
}{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "Authorization has been denied for this request."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 401
}
},
"additionalProperties": false,
"description": "Response sent when a 401 Unauthorized error occurs."
}403 Forbidden
The user does not have permission to retrieve the roles.
Representations
{
"message": "User does not have permission to access this resource.",
"code": 403
}{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "User does not have permission to access this resource."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 403
}
},
"additionalProperties": false,
"description": "Response sent when a 403 Forbidden error occurs."
}404 Not Found
The specified book does not exist.
Representations
{
"message": "Resource not found.",
"code": 404
}{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "The description of the error.",
"nullable": true,
"example": "Resource not found."
},
"code": {
"type": "integer",
"description": "The HTTP status code of the error.",
"format": "int32",
"example": 404
}
},
"additionalProperties": false,
"description": "Response sent when a 404 Forbidden error occurs."
}Code samples
@ECHO OFF
curl -v -X GET "https://api.reckon.com/r1/v2/{bookId}/roles?page=1&perPage=0"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["page"] = "1";
queryString["perPage"] = "0";
var uri = "https://api.reckon.com/r1/v2/{bookId}/roles?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://api.reckon.com/r1/v2/{bookId}/roles");
builder.setParameter("page", "1");
builder.setParameter("perPage", "0");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
"page": "1",
"perPage": "0",
};
$.ajax({
url: "https://api.reckon.com/r1/v2/{bookId}/roles?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://api.reckon.com/r1/v2/{bookId}/roles";
NSArray* array = @[
// Request parameters
@"entities=true",
@"page=1",
@"perPage=0",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://api.reckon.com/r1/v2/{bookId}/roles');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'page' => '1',
'perPage' => '0',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'page': '1',
'perPage': '0',
})
try:
conn = httplib.HTTPSConnection('api.reckon.com')
conn.request("GET", "/r1/v2/{bookId}/roles?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'page': '1',
'perPage': '0',
})
try:
conn = http.client.HTTPSConnection('api.reckon.com')
conn.request("GET", "/r1/v2/{bookId}/roles?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################require 'net/http'
uri = URI('https://api.reckon.com/r1/v2/{bookId}/roles')
query = URI.encode_www_form({
# Request parameters
'page' => '1',
'perPage' => '0'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body