SensorAlarm-Buy API documentation

Introduction

This API supports multiple regions. Country is set by using X-API-Country header. If X-API-Country header is not present it will be defaulted to SE. Accepted values: SE, NO

Billecta

API	Description
POST api/Billecta/GetUserByNumber?PaymentType={PaymentType}	Get person/organisation by using person/organisation number respectively.
GET api/Billecta/GetPackages	Get list of alarm packages.
GET api/Billecta/GetAlarmsAndTags	Get list of alarm packages, tag and security products.
GET api/Billecta/GetProducts	Get list of alarm products.
GET api/Billecta/GetBanks	Get list of supported banks.
GET api/Billecta/InitiateBankAccountNumbersRetrival?PersonNo={PersonNo}&PayerPersonNo={PayerPersonNo}&BankCode={BankCode}	Initiate bank account numbers retrival request.
GET api/Billecta/GetAccounts?PersonNo={PersonNo}&PayerPersonNo={PayerPersonNo}&PublicId={PublicId}	Get list of bank account numbers.
GET api/Billecta/InitiateBankIdAuthentication?PersonNo={PersonNo}&PayerPersonNo={PayerPersonNo}&IsAutogiro={IsAutogiro}	Intitiates request to Authenticate BankID.
GET api/Billecta/AuthenticateBankID?PersonNo={PersonNo}&PayerPersonNo={PayerPersonNo}&ReferenceToken={ReferenceToken}&IsAutogiro={IsAutogiro}	Authenticate BankID request.
POST api/Billecta/CalculateInvoicingData	No documentation available.
GET api/Billecta/GetAddresses?personNumber={personNumber}	No documentation available.

CRM

API	Description
GET api/CRM/ZipcodeExists/{code}	Check if Zipcode exists in CRM.
POST api/CRM/AddPerson	Add a new person to CRM.
POST api/CRM/SendCustomerAlarmBookingEmail	Add a new person to CRM.
GET api/CRM/GetPersonPhone?personId={personId}	Get phone number of a person from CRM.
GET api/CRM/IsCompany?personId={personId}	Check if registered Person record is a person or company.
GET api/CRM/GetPerson?personId={personId}	Get person record from CRM.
GET api/CRM/GetEmailValidation?email={email}	Validate an emailaddress against an external validation service.
POST api/CRM/SendSalesOrderSignInEmail	Sends an email to customer.
POST api/CRM/ProcessTrialOrder	Creates a trial order for the customer.
POST api/CRM/ProcessPurchaseOrder	Adds new purchase order (i.e. adds a Product entry in WebCRM, creates one regular and one contract invoice in Billecta, created agreement PDF and sends email with agreement.)
POST api/CRM/ManualSign	Used to sign manualy and then creating the invoices and updating prices in webcrm.
POST api/CRM/ManualSignByPhone	Used to sign manually by using customer's/lead's phone number and then creating the invoices and updating prices in webcrm.
POST api/CRM/ChangeTrialDate	Used to change the start date of a trail purchase.
POST api/CRM/SendSignEmailManually	Sends sign email and sms manually.
POST api/CRM/SendTrialEmailManually	Sends trial email manually.
POST api/CRM/ReUploadTrialAgreementManually	Re-upload trial agreement to webCRM
POST api/CRM/AddPurchase	Add purchase - A combination of AddPerson and ProcessTrialOrder
POST api/CRM/ConfirmStartupByPhone	Used to confirm startup manually by using customer's/lead's phone number

Partner

API	Description
POST api/Partner/AddLead	Add lead
POST api/Partner/AddPartner	Add partner
GET api/Partner/DeletePartner/{Id}	Delete partner by id
GET api/Partner/GetLead/{Id}	Get lead by id
GET api/Partner/GetLeads?PageIndex={PageIndex}&PageLimit={PageLimit}&SortProperty={SortProperty}&SortDirection={SortDirection}&InternalStatus={InternalStatus}&PartnerIds={PartnerIds}&Search={Search}&Finished={Finished}	Get leads
GET api/Partner/GetPartner/{Id}	Get partner by id
GET api/Partner/GetPartners?PageIndex={PageIndex}&PageLimit={PageLimit}&Search={Search}&Enabled={Enabled}&Type={Type}	Get partners
POST api/Partner/UpdateLead	Update lead
POST api/Partner/UpdateLeadInternalStatus	Update lead internal status
POST api/Partner/UpdatePartner	Update partner

Logs

API	Description
GET api/Logs/GetLogs?personNo={personNo}&showErrorLogs={showErrorLogs}	Get list of logs.

Campaign

API	Description
POST api/Campaign/AddCampaign	Add campaign
GET api/Campaign/DeleteCampaign/{Id}	Delete campaign by id
GET api/Campaign/GetActiveCampaign?Code={Code}	Get active campaign by code
GET api/Campaign/GetCampaign/{Id}	Get campaign by id
GET api/Campaign/GetCampaign?Code={Code}	Get campaign by code
GET api/Campaign/GetCampaigns?Search={Search}&Enabled={Enabled}&Type={Type}	Get campaigns
POST api/Campaign/UpdateCampaign	Update campaign