Capium API Help Page

Introduction

Capium's APIs belong to the Representational State Transfer (REST) category. They allow you to perform 'RESTful' operations such as reading, modifying, adding or deleting data from your account. The APIs also support Cross-Origin Resource Sharing (CORS).

Company

Company controller

API	Description
GET v1/company/GetUserCompanies	No documentation available.
GET v1/company/{companyId}/GetCurrencies	No documentation available.
GET v1/company/{companyId}/GetCompanyUsers	To Get Company Users
GET v1/Company	Get company detail (first company for current login user)
GET v1/Company/{id}	Get company detail

PaymentsWeb

Payments controller

API	Description
GET api/{companyId}/paymentsweb/GetPaymentAccounts	To get the payment accounts
POST api/{companyId}/paymentsweb/GetPurchasesforCompany	To get the purchases based on the customer,currency,accounts
GET api/{companyId}/paymentsweb/GetPaymentDetails/{Id}	To get the payment details
POST api/{companyId}/paymentsweb/AddPayment/{userId}	To save a payment for single invoice
POST api/{CompanyId}/paymentsweb/UpdatePaymentData	To update the receipt
POST api/{companyId}/paymentsweb/DeletePayments	To Delete multiple or single Receipt(s)
GET api/{companyId}/paymentsweb/PrintPaymentPDF/{Id}	To print the receipt as PDF
GET api/{companyId}/paymentsweb/GetPaymentsDetailsForAdd/{Id}	To get the payment details for add
POST v1/PaymentsWeb/{id}?companyid={companyid}	To print the payment details

DashboardWeb

Dashboard controller

API	Description
GET api/{companyId}/dashboardsweb/SalesPurchasesDashboard/{Type}/{MonthNumber}	Get sales and purchase dashboard details
GET api/{companyId}/dashboardsweb/PayrollDashboard/{userId}/{year}	Get Payroll dashboard details
GET api/{companyId}/dashboardsweb/CorporationTaxDashboard/{Id}	Get corporation tax dashboard data
GET api/{companyId}/dashboardsweb/SelfAssessmentDashboard/{returnId}	Get self assessment dashboard summary data
GET api/{companyId}/dashboardsweb/GetDashboardData/{userid}/{saReturnId}/{ctReturnId}	Get self assessment dashboard summary data
GET api/{companyId}/dashboardsweb/GetDashboardFilters	Get dashboard year drop down data

Communications

Communication controller

API	Description
GET v1/user/{userId}/communications?Start={Start}&Count={Count}&Search={Search}	Get communications for a user
GET v1/user/{userId}/communications/{id}	Get communication detail
GET v1/user/{userId}/communications/users	Get list of all users whom the current user can start communication
GET v1/user/{userId}/communications/{id}/attachments/{attachmentId}?inline={inline}	Get communication attachment
POST v1/user/{userId}/communications	Post/Start a new communication
POST v1/user/{userId}/communications/{id}/reply	Post reply to a communication

CapiScanWeb

CapiScanWeb controller

API	Description
POST api/{companyId}/capiscanweb/GetScannedPurchasesList	To get list of capiscan records
GET api/{companyId}/capiscanweb/attachments/{attachmentId}	To download capiscan Attachment
POST api/{companyId}/capiscanweb/UpdateCapiScanAsRejected	To update capiscan records status as rejected
GET api/{companyId}/capiscanweb/GetImageDatastream/{Id}	To get scanned image data
POST api/{companyId}/capiscanweb/ExportCapiScanRecords	CapiScan records Export(PDF or Excel)
POST v1/CapiScanWeb?input={input}	No documentation available.
GET v1/CapiScanWeb?Html={Html}&ReportHeaderText={ReportHeaderText}&CompanyId={CompanyId}	No documentation available.

Receipts

Receipts controller

API	Description
GET v1/company/{companyId}/receipts?Start={Start}&Count={Count}&Search={Search}	Get receipts for a company
GET v1/company/{companyId}/receipts/{id}	Get receipt detail
POST v1/company/{companyId}/receipts	Post new receipt for an invoice

CapiScan

Invoice controller

API	Description
POST v1/Company/CapiScan/quickEntrySave	No documentation available.
POST v1/Company/CapiScan/quickEntryDelete/{QucikEntryId}	No documentation available.
GET v1/Company/CapiScan/getQuickEntryType	No documentation available.
GET v1/Company/CapiScan/getAllQuickEntryDetails/{F_CompanyId}	No documentation available.
GET v1/Company/CapiScan/getAllQuickEntryDetailsByDate/{F_CompanyId}/{search}	No documentation available.
GET v1/Company/CapiScan/getAllQuickEntryDetailsByCount/{F_CompanyId}?Start={Start}&Count={Count}&Search={Search}	No documentation available.
GET v1/Company/CapiScan/getAttachment/{companyId}/{id}/{attachmentId}?inline={inline}	No documentation available.
GET v1/Company/CapiScan/getQuickEntryViewResponseFile/{Id}	No documentation available.
GET v1/Company/CapiScan/getTicketsCount/{Companyid}	No documentation available.
GET v1/CapiScan?type={type}&companyId={companyId}	No documentation available.
POST v1/CapiScan/{Id}?F_CompanyId={F_CompanyId}	No documentation available.
POST v1/CapiScan?FileName={FileName}&ContentType={ContentType}&QucikEntryId={QucikEntryId}&UserId={UserId}&F_ParentUserId={F_ParentUserId}&CompanyId={CompanyId}&ImageType={ImageType}	No documentation available.
GET v1/CapiScan/{Id}?ext={ext}&CompanyId={CompanyId}	No documentation available.
GET v1/CapiScan?currencyId={currencyId}&type={type}	No documentation available.

Items

Item controller

API	Description
GET v1/company/{companyId}/items?Start={Start}&Count={Count}&Search={Search}	Get items for a company
GET v1/company/{companyId}/items/{id}	Get item detail from a company
POST v1/company/{companyId}/items	Add new item for a company
POST v1/company/{companyId}/items/EditItem/{id}	Update item detail for a company
POST v1/company/{companyId}/items/{id}	Delete a item
POST v1/Items/{id}?columnName={columnName}&TableName={TableName}&companyId={companyId}	Function to check weather given name has duplicate value or not

Vision

Vision controller

API	Description
POST api/Vision/PostVision	To get data from scanned receipt

CompanyWeb

Company controller

API	Description
GET api/companyweb/GetUserCompanies/{userId}/{parentUserId}	Get companies list for logged in user
GET api/companyweb/GetCountries	Get countries list
GET api/companyweb/GetCompanyMinAndMaxDates/{companyId}	To get Date Filters validation dates based on company
GET api/companyweb/GetCurrencies/{companyId}	Get company currencies list
GET api/companyweb/GetLatestCurrencyRate/{companyId}/{CurrencyId}	Get company latest currency rate
GET api/companyweb/GetModules/{userId}	To get user modules
GET api/companyweb/GetGlobalSearchResult/{companyId}/{searchKey}	No documentation available.
GET v1/CompanyWeb?userId={userId}&parentUserId={parentUserId}	No documentation available.
POST v1/CompanyWeb?userId={userId}&companyId={companyId}	No documentation available.
POST v1/CompanyWeb?companyId={companyId}&userId={userId}&parentUserId={parentUserId}&strCmpQry={strCmpQry}	No documentation available.
GET v1/CompanyWeb?Type={Type}&Module={Module}	No documentation available.

InvoicesWeb

Invoice Web controller

API	Description
POST api/{companyId}/invoicesweb/AddInvoice/{userId}/{parentUserId}	To add the invoice
POST api/{companyId}/invoicesweb/EditInvoice/{id}/{userId}/{parentUserId}	To edit the invoice
GET api/{companyId}/invoicesweb/GetInvoiceDetails/{id}	To get the invoice details
GET api/{companyId}/invoicesweb/{id}/attachments/{attachmentId}?inline={inline}	To get the attachment
POST api/{companyId}/invoicesweb/DeleteInvoice	To delete the multiple inovices
POST api/{companyId}/invoicesweb/DeleteAttachment/{InvoiceId}	To delete attachment of a inovice
POST api/{companyId}/invoicesweb/SendInvoiceEmail	To send the invoice details as email
GET api/{companyId}/invoicesweb/DownloadInvoicePDF/{InvoiceId}/{Ispaymentlink}	No documentation available.
GET api/{companyid}/invoicesweb/GetInvoiceAccounts	To get the accounts for accounts dropdown
POST api/{companyId}/invoicesweb/GetEmailBody	To get the email body
POST api/{companyId}/invoicesweb/GetPaymentLinkEmailBody
POST v1/InvoicesWeb?invoiceIds={invoiceIds}&to={to}&cc={cc}&bcc={bcc}&subject={subject}&body={body}&companyId={companyId}&parentUserId={parentUserId}&userId={userId}&Ispaymentlink={Ispaymentlink}	No documentation available.
POST v1/InvoicesWeb?value={value}	No documentation available.
POST v1/InvoicesWeb?strTemp={strTemp}&start={start}&end={end}	To remove the block
POST v1/InvoicesWeb/{id}?companyid={companyid}&companyCurrencyId={companyCurrencyId}	To print the receipt details
POST v1/InvoicesWeb	To know the credit note details
POST v1/InvoicesWeb/{Id}?companyId={companyId}	To reset the template
GET v1/InvoicesWeb?companyId={companyId}	To get the default template

User

User controller

API	Description
GET v1/user	Get current/login user's detail
GET v1/countries?Start={Start}&Count={Count}&Search={Search}	Get countries list
POST v1/user/{id}/token	Update device token (to be used to send notifications)
PUT v1/user/{id}	Update user profile
DELETE v1/user/{id}/picture	Remove profile picture for user
POST v1/user/recover?email={email}	Recover user password
GET v1/user/Accountant/{companyId}	Accountant Details
GET v1/user/{companyId}/CheckClientModules	Check client user module and page Privileges
GET v1/user/CheckClientModules	Check client user module and page Privileges
POST v1/user/{id}/LogOutUser	delete device token (when user log out)
GET v1/GetLatestVersion	To get mobile(Android/IOS) latest versions
GET v1/GetLatestVersionNew?CustomUrl={CustomUrl}	To get mobile(Android/IOS) latest versions
GET v1/GetSubscriptionStatus/{UserId}	To get Mobile app subscription status
GET v1/user/GetNotificationStatus?UserId={UserId}&IsNotify={IsNotify}	To get mobile(Android/IOS) latest versions
GET v1/user/GetModules	To get user modules

ItemsWeb

Item Web controller

API	Description
POST api/{companyId}/itemsweb/GetAllItems	To get the all items
GET api/{companyId}/itemsweb/GetItemById/{Id}	To get the item by id
POST api/{companyId}/itemsweb/IsDuplicateItem	To check the duplicate item
POST api/{companyId}/itemsweb/AddOrEditItem	Add or Edit New Item
POST api/{companyId}/itemsweb/DeleteItem	To Delte the Item
GET api/{companyId}/itemsweb/GetAllVATCodes	To get the all vat codes
POST v1/ItemsWeb/{id}?columnName={columnName}&TableName={TableName}&companyId={companyId}	Function to check weather given name has duplicate value or not

Contacts

Contact controller

API	Description
GET v1/company/{companyId}/contacts?Type={Type}&Start={Start}&Count={Count}&Search={Search}	Get contacts for a company
GET v1/company/{companyId}/contacts/{id}	Get contact detail from a company
POST v1/company/{companyId}/contacts	Add new contact for a company
POST v1/company/{companyId}/contacts/EditContact/{id}	Update contact detail for a company
POST v1/company/{companyId}/contacts/{id}/{Type}	Delete contact detail for a company

ClientData

API	Description
GET v1/clientdata/GetCustomers?companyId={companyId}&contactType={contactType}	No documentation available.
GET v1/clientdata/GetVatRate?companyId={companyId}	No documentation available.
GET v1/clientdata/GetProducts?companyId={companyId}	No documentation available.
GET v1/clientdata/GetBankAccountList?companyId={companyId}	No documentation available.
POST v1/clientdata/AddBKSaleInvoice/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/AddBKExpenses/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/AddBKTransactions/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/CapsicanquickEntrySave/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/AddBKPurchaseCreditNote/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/AddBKSaleCreditNote/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/DeleteBKExpenses/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/DeleteBKSalesInvoice/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/AddJournal/{userGuid}?companyId={companyId}	No documentation available.
POST v1/clientdata/DeleteJournal/{userGuid}?companyId={companyId}	No documentation available.
POST v1/ClientData?QucikEntryId={QucikEntryId}	No documentation available.
POST v1/ClientData/{Id}?F_CompanyId={F_CompanyId}&userid={userid}&parentID={parentID}	No documentation available.
POST v1/ClientData?FileName={FileName}&ContentType={ContentType}&QucikEntryId={QucikEntryId}&UserId={UserId}&F_ParentUserId={F_ParentUserId}&CompanyId={CompanyId}&ImageType={ImageType}	No documentation available.
DELETE v1/ClientData?JournalId={JournalId}	No documentation available.
POST v1/ClientData/{id}?companyId={companyId}	No documentation available.
DELETE v1/ClientData?TransId={TransId}	No documentation available.

ReceiptsWeb

Receipts controller

API	Description
POST api/{companyId}/receiptsweb/GetAllTransactions	Get receipts/payments for a company
GET api/{companyId}/receiptsweb/GetReceiptsDetails/{id}	To Get receipt detail by id
GET api/{companyId}/receiptsweb/GetReceiptsDetailsForAdd/{Id}	To get the receipt details for add
POST api/{companyId}/receiptsweb/SaveReceipt/{userId}	Post new receipt for an invoice
GET api/{companyId}/receiptsweb/GetCompanyAccounts	To get the company accounts
POST api/{companyId}/receiptsweb/GetInvoicesforCustomer	To get the invoices based on the customer
POST api/{CompanyId}/receiptsweb/UpdateReceiptData	To update the receipt data
POST api/{companyId}/receiptsweb/DeleteReceipts	To Delete multiple or single Receipt(s)
GET api/{companyId}/receiptsweb/PrintReceiptsPDF/{Id}	To print the receipt as PDF
POST api/{companyId}/receiptsweb/SaveJournal/{userId}	No documentation available.
POST v1/ReceiptsWeb/{id}?companyId={companyId}	To print the details
GET v1/ReceiptsWeb?companyid={companyid}&ext={ext}&postFix={postFix}&preFix={preFix}	To get the company file name

Dashboard

Dashboard controller

API	Description
GET v1/company/{companyId}/dashboards/GetDashboardYearsList/{dashboardKey}	Get dashboard year drop down data
GET v1/company/{companyId}/dashboards/SalesPurchasesDashboard?Year={Year}&Month={Month}&Type={Type}	Get sales and purchase dashboard details
GET v1/company/{companyId}/dashboards/PayrollDashboard/{year}	Get Payroll dashboard details
GET v1/company/{companyId}/dashboards/GetSATaxSummary/{returnId}	Get self assessment dashboard summary data
GET v1/company/{companyId}/dashboards/GetCTTaxSummary/{Id}	Get corporation tax dashboard data
GET v1/Dashboard?companyId={companyId}&returnId={returnId}	Get self assessment(100) dashboard summary data

Expenses

Expenses controller

API	Description
GET v1/company/{companyId}/expenses?Type={Type}&FromDate={FromDate}&ToDate={ToDate}&ContactId={ContactId}&Start={Start}&Count={Count}&Search={Search}	Get expenses for a company
GET v1/company/{companyId}/expenses/{id}	Get expenses detail
GET v1/company/{companyId}/expenses/{id}/attachments/{attachmentId}?inline={inline}	Get expense attachment
POST v1/company/{companyId}/expenses	Post new expenses
POST v1/company/{companyId}/expenses/EditExpenses/{id}	Update expense details
GET v1/company/{companyId}/expenses/GetExpenseDetails/{id}	Get expenses detail
POST v1/company/{companyId}/expenses/{id}	Delete a expense

ExpensesWeb

Expenses Web controller

API	Description
POST api/{companyId}/expensesweb/AddExpenses/{userId}/{parentUserId}	To save a new Purchase
POST api/{companyId}/expensesweb/EditExpenses/{id}/{userId}/{parentUserId}	To edit a Purchase
GET api/{companyId}/expensesweb/GetExpenseDetails/{id}	Get Purchases details by Purchase id
GET api/{companyId}/expensesweb/{id}/attachments/{attachmentId}?inline={inline}	To download a Attachment
POST api/{companyId}/expensesweb/DeleteAttachment/{PurchaseId}	To delete attachment of a purchase
POST api/{companyId}/expensesweb/DeleteExpenses
GET api/{companyId}/expensesweb/DownloadExpensesPdf/{UserId}/{Id}	To download the expenses pdf
GET api/{companyId}/expensesweb/GetExpensesAccounts	To get the extesions accounts
POST v1/ExpensesWeb/{id}?companyId={companyId}	No documentation available.

Tickets

Ticket controller

API	Description
GET v1/company/{companyId}/tickets?Start={Start}&Count={Count}&Search={Search}	Get tickets for a company
GET v1/company/{companyId}/tickets/{id}	Get tickets details
POST v1/company/{companyId}/tickets/PostTicketReply	Post a ticket reply
GET v1/company/{companyId}/tickets/GetTicketAttachment?fileName={fileName}	To get the ticket attachment
POST v1/company/{companyId}/tickets	To save a new Ticket

Invoices

Invoice controller

API	Description
GET v1/company/{companyId}/invoices?Type={Type}&FromDate={FromDate}&ToDate={ToDate}&ContactId={ContactId}&Start={Start}&Count={Count}&Search={Search}	Get invoices for a company
GET v1/company/{companyId}/invoices/{id}	Get invoice detail
GET v1/company/{companyId}/invoices/{id}/attachments/{attachmentId}?inline={inline}	Get invoice attachment
POST v1/company/{companyId}/invoices	Post new invoice
POST v1/company/{companyId}/invoices/EditInvoice/{id}	Update invoice details
GET v1/company/{companyId}/invoices/GetInvoiceDetails/{id}	Get invoice detail
POST v1/company/{companyId}/invoices/{id}	Delete a invoice
POST v1/company/{companyId}/invoices/GetInvoiceEmailContent/{InvoiceId}	Get Invoice Email Content
POST v1/company/{companyId}/invoices/SendInvoiceEmail	Get Invoice Email Content
POST v1/Invoices?invoiceId={invoiceId}&to={to}&cc={cc}&subject={subject}&body={body}&companyId={companyId}	No documentation available.
POST v1/Invoices?strTemp={strTemp}&start={start}&end={end}	No documentation available.
POST v1/Invoices/{id}	No documentation available.
POST v1/Invoices	No documentation available.
POST v1/Invoices/{Id}?companyId={companyId}	No documentation available.
GET v1/Invoices?companyId={companyId}	No documentation available.

Payments

Receipts controller

API	Description
GET v1/company/{companyId}/payments?Start={Start}&Count={Count}&Search={Search}	Get payments for a company
GET v1/company/{companyId}/payments/{id}	Get payment detail
POST v1/company/{companyId}/payments	Post new payment for an expense

ContactsWeb

Contact controller

API	Description
POST api/{companyId}/contactsweb/AddOrEditContact/{userId}	Add or Edit contact for a company
POST api/{companyId}/contactsweb/DeleteContact	Delete contact detail for a company
POST api/{companyId}/contactsweb/GetAllContacts	Get all contacts list for a company
POST api/{companyId}/contactsweb/GetContactsHistory	To Get Invoices/Expenses list based on contact
GET api/{companyId}/contactsweb/GetAllContactsforDropDown?Type={Type}	To Get list of contacts for drop down
POST api/{companyId}/contactsweb/GetContactsDetailsById	To get the contact details by id