Documentation

Get a list of AP Bills by search criteria

Returns a specific AP Bill record by InvoiceID

Creates an APBill record for a specified vendor

Returns a specific AP Check record by CheckID

Creates an APCheck record for a customer refund.

Returns all Branches

Returns the specified Branch

Returns all the records in the AR_Category table expect the default record

Returns the specified Category

Returns all Collection Statuses

Returns the specified Collection Status

Returns all Contract Forms

Returns the specified Contract Form

Returns all CreditReasones

Returns the specified CreditReason

Returns a specific CriticalMessage record by CriticalMessageId

Creates a new Critical Message record

Returns a set of Customer records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerNumber' - a single record for Customer where id = CustomerNumber, 'ByCancelledRecurring' - list of customers cancelled via recurrings over a period of time (date range passed into ID in format YYYYMMDD-YYYYMMDD)

Returns dashboard info (Balance, Last Payment, Open Service Tickets, etc.) by CustomerID

Returns a list of combined Job and Service Ticket Dispatch records filtered by values in the DispatchSearch object

Returns a queryable list of customers. oData capable.

Returns a specific Customer record by CustomerID

Creates a new Customer record. In order for the record to show in SedonaOffice, it must also have a CustomerBill and CustomerSite record associated with it.

Update a specific Customer record by CustomerID

Returns the specified Customer ACH by ACH_Id

Returns a set of Customer ACH records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all ACH records for Customer where id = customerId.

Returns the last 10 records inserted into the ACH table (for testing purposes only; this operation may be disabled in production.)

Creates a new ACH record for payment of existing Invoices; create an entry for a pre-authorized Forte transaction that will be cleared in SedonaOffice (use CustomerPayment to create Deposit Check entries). Can also be used to create a credit refund by setting IsCredit = True (either a Credit or Unapplied Cash transaction must also be created for the customer for the accounting records to be complete).

Allows the bulk submission of transactions for adding AR_ACH records. New transaction will be added while existing transaction will be skipped to avoid duplicate records. Each AR_ACH will be added to a batch based on the tranasction date

Retrieve CustomerActivityLedger by CustomerNumber and other optional parameters

Returns a specific Customer Advance Deposit record by CustomerAdvanceDepositID

Returns a set of Customer Advance Deposit records based on the option parameter. Possible values for the option parameter are: 'ByCustomerId' - all Invoice records for Customer where id = customerId, ...

Returns the last 10 records inserted into the AR_Advance_Deposit table (for testing purposes only; this operation may be disabled in production.)

Creates an CustomerAdvanceDeposit record. Customer, Bill Address, and Site records must exist in order to create an CustomerAdvanceDeposit.

Returns the specified Customer Aging record for the Customer_Id passed in

Returns a set of Customer Bill records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all bank records for Customer where id = customerId, 'ByCustomerNumber' - all bank records for Customer where id = CustomerNumber,...

Returns the last 10 records inserted into the Customer Bank table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer Bank record by CustomerBankID

Creates a new Customer Bank record. A Customer record must exist in order to create a Bank record.

Update a specific Customer Bank record by CustomerBankID

Returns a specific Customer Bill record by CustomerBillID

Returns a set of Customer Bill records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all billing records for Customer where id = customerId, 'ByCustomerNumber' - all billing records for Customer where id = CustomerNumber,...

Updates a specific Customer Bill record by CustomerBillID. You must provide the CustomerBillID in the first parameter and within the CustomerBill object. If these don't match the method will not update the record. It is strongly recommended that you synchronize your Customer Bill information with the database using the Get(int) opertion prior to updating the record.

Returns the last 10 records inserted into the AR_Customer_Bill table (for testing purposes only; this operation may be disabled in production.)

Creates a Customer Bill record. A Customer record must exist in order to create a Customer Billing address.

Returns a set of Customer Bill records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all Credit Card records for Customer where id = customerId, 'ByCustomerNumber' - all Credit Card records for Customer where id = CustomerNumber,...

Returns the last 10 records inserted into the Customer Credit Card table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer Credit Card record by CustomerCCID

Creates a new Customer Credit Card record. A Customer record must exist in order to create a Credit Card record.

Update a specific Customer Credit Card record by CustomerCCID

Returns a specified Customer Check by DepositCheckId

Returns a set of Customer Check records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all check records for Customer where id = customerId.

Returns the last 10 records inserted into the ACH table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer Contact record by CustomerContactID

Returns a set of Customer Contact records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all billing records for Customer where id = customerId, ...

Update a specific customer contact record by CustomerContactID

Returns the last 10 records inserted into the Customer Contact table (for testing purposes only; this operation may be disabled in production.)

Creates a new Customer Contact record. A Customer record must exist in order to create a Contact. In addition, either a Site or Billing Address (or both) record must exist.

Returns a set of Customer Credit records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all Credit records for Customer where id = customerId, 'ByCustomerNumber' - all Credit records for Customer where id = CustomerNumber, ...

Returns a set of Customer Credit records based on the option parameter. The id2 parameter may or may not be used. Possible values for the option parameter are: 'ForInvoice' - Creates a new credit where id1 = InvoiceID to which a full credit will be applied; id2 = CreditReasonID (from AR_Credit_Reason)

Returns the last 10 records inserted into the Customer Credit table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer Credit record by CustomerCreditID

Creates a Credit record.

Returns a specific Customer Credit record by CustomerCreditID

Returns a specific Customer Credit Detail record by CustomerCreditDetailID

Creates a Credit Detail record. The Credit must exist prior to creation of the detail record.

Returns a list of Customer Equipment using the CustomerEquipmentSearch object

Returns the last 10 records inserted into the AR_Customer_Equipment table (for testing purposes only; this operation may be disabled in production.)

Returns a specific CustomerEquipment record by CustomerEquipmentID

Creates a new CustomerEquipment record.

Update a specific CustomerEquipment record by CustomerEquipmentID

Returns all Customer Groups

Returns the specified Customer Group

Returns a specific Customer Invoice record by CustomerInvoiceID

Returns a set of Customer Invoice records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all Invoice records for Customer where id = customerId, ... 'OpenBalance' - all Invoice records for Customer where id = customerId and Net_Due > 0, ...

Returns a set of Customer Invoice records based on the id and option parameters. The id parameter is the CustomerID. Possible values for the option parameter are: 'CategoryInclude' - Invoice records where id2 = categoryId (from the AR_Category table), 'CategoryExclude' - Invoice records where id2 = categoryId (from the AR_Category table), ... Possible values for the option2 parameter are: 'OpenBalance' - Invoice records where Net_Due is positive, ...

Returns the last 10 records inserted into the Customer Invoice table (for testing purposes only; this operation may be disabled in production.)

Creates an Invoice record. Customer, Bill Address, and Site records must exist in order to create an Invoice.

Returns a set of Customer Note records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all note records for Customer where id = customerId, 'ByCustomerNumber' - all note records for Customer where id = CustomerNumber,...

Returns a specific payment record by DepositCheckID

Retrieve all CustomerPayments by CustomerNumber and other optional parameters

Creates a CustomerPayment record for a specified customer

Returns a set of Customer Recurring records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all recurring records for Customer where id = customerId, 'ByCustomerNumber' - all recurring records for Customer where id = CustomerNumber, 'ByCustomerSystem' - all recurring records for CustomerSystem where id = CustomerSsystemId, ...

Updates the Recurring Rate (Effective Date, Reason for increase/decrease, and Monthly/Cycle Amounts) by CustomerRecurringID; also used to cancel a recurring record

Returns the last 10 records inserted into the Customer Recurring table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer Recurring record by CustomerRecurringID

Creates a new Customer Recurring record. Customer, Site, and System records must exist in order to create a Recurring record.

Updates a specific customer recurring record by CustomerRecurringID; only the following fields can be updated: Recurring Item Code, Description, Master Item Code, Bill Cycle, and Memo. To update all other fields, cancel and recreate the recur line.

Returns the credit amount and the total prorated bill amount for the recurring change. The change can be committed by setting the commit parameter of the CustomerRecurringProrate model to true.

Returns a set of Customer Site records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all site records for Customer where id = customerId, 'ByCustomerNumber' - all site records for Customer where id = Customer_Number

Returns the last 10 records inserted into the Customer Site table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer Site record by CustomerSiteID

Creates a new Customer Site record. A Customer record must exist in order to create a Site.

Update a specific customer site record by CustomerSiteID

Deactivates specified site.

Returns a single CustomerSystem object based on the filter criteria.

Returns a list of matching CustomerSystem records based on the filter criteria at the customer, site and system levels.

Search Systems by system number. Acts as a contains system number. So System 123, and system 1234, if you search for 12 it would bring both systems back. EmergencyContacts are not included at this time.

Returns the last 10 records inserted into the Customer System table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer System record by CustomerSystemID

Returns a set of Customer System records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all system records for Customer where id = customerId, 'ByCustomerNumber' - all system records for Customer where id = CustomerNumber, 'ByCustomerSite' - all system records for Customer where id = customerSiteId...

Creates a new Customer System record. Customer and Site records must exist in order to create a System.

PUT operation for updating an existing Customer System

Deactivates specified system.

Returns a set of Customer System records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all system records for Customer where id = customerId, 'ByCustomerNumber' - all system records for Customer where id = CustomerNumber, 'ByCustomerSite' - all system records for Customer where id = customerSiteId...

Creates a new Customer Recurring record. Customer, Site, and System records must exist in order to create a Recurring record.

Returns the last 10 records inserted into the Customer System Userdef table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer System Userdef record by CustomerUserdefID

The CustomerSystem record must already exist, and there cannot be an existing System Userdef record.

Update a specific Customer System Userdef record by CustomerID (CustomerUserdefID not required since there is only one Userdef record per Customer)

Returns all Customer Types

Returns the specified Customer Type

Returns a set of Customer Unapplied Cash records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all Unapplied Cash records for Customer where id = customerId, 'ByCustomerNumber' - all Unapplied Cash records for Customer where id = CustomerNumber, ...

Returns the Customer Userdef record by CustomerId. Possible values for the option parameter are: 'ByCustomerId' - get the Userdef record (only one) for a specific Customer where id = customerId

Returns the last 10 records inserted into the Customer Userdef table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Customer Userdef record by CustomerUserdefID

A blank Userdef record is created automatically when the Customer is created, so this is only needed to generate a missing Userdef record. The Customer record must already exist, and there cannot be an existing Userdef record.

Update a specific customer userdef record by CustomerID (CustomerUserdefID not required since there is only one Userdef record per Customer)

Returns a list of any job or service ticket where the Dispatch_Id = id. This can possible be more than one record since a record in both the OE_Job_Dispatch and SV_Service_Ticket_Dispatch tables can both have a record with the same id.

Returns a list of combined Job and Service Ticket Dispatch records by id and option, where id is the unique identifier for a given option; valid options are: "byreference", "byservicetechid", "byservicetechcode", "bydaterange" For example, when the option is "byservicetechcode", then id respresents the Employee_Code in the SY_Eployee table. The option "bydaterange" use the following format for id to represent (StartDate-EndDate): YYYYMMDD-YYYYMMDD

Allows a limited set of fields to be updated. You must specify both the DispatchId and the DispatchType in order for the correct record to be updated.

Returns all the combined job and service tickets in a date range specified by the config app setting "dispatchDayRange", This number of days is added and substracted to the current to establish the date range. Defaults to 7 if not specified in the web.config file.

Returns a list of combined Job and Service Ticket Dispatch records filtered by values in the DispatchSearch object

Returns all Document Types from SY_Document_Types table in the SedonaDocuments database

Returns a specific Employee record by EployeeId

Returns a set of Employee records based on the EmployeeSearch parameter.

Returns inventory for a specific InventoryID record

Returns inventory base on the following option values: "bycodes" - WarehouseCode (id1), PartCode (id2), this is also the default if option is left out "bywarehouse" - WarehouseCode (id1), id2 will be ignored but needs a place holder (use zero), "bypart" = id1 will be ignored but needs a place holder (use zero), PartCode (id2)

Returns inventory for all Warehouses

Returns all Items

Returns the specified Item

Returns the last 10 records inserted into the OE_Job table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Job record by JobId

Returns a set of Job records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCustomerId' - all job records for Customer where id = customerId, 'ByCustomerNumber' - all job records for Customer where id = CustomerNumber,...

Returns a list of Job Stati

Returns a list of Job Types

Returns a set of Job records based on the JobSearch parameter.

Update a specific Job record by JobId

Returns Job Dispatch record by id and option, where id is the unique identifier for a given option; valid options are: "byserviceticketid", "byservicetechid", "byserviceticketnumber", "byservicetechcode" For example, when the option is "byservicetechcode", then id respresents the Employee_Code in the SY_Eployee table. Results are also limited to days

Update a specific Job Dispatch record by DispatchID

Returns today's Job Dispatches

Returns a specific Job Dispatch record by DispatchID

Creates a Job Dispatch record.

File must be encoded in the JSON request. Only one file can be submitted per request.

Removes the specified Job Document from the SedonaDocuments database

Creates a Note on a Job

Creates a Part on a Job

No documentation available.

Returns a specific Job record by JobId

Adds a job record with job system and parts

Returns all Master Accounts

Returns the specified Master Account

Update a specific Master Account record by MasterAccountID

Returns all Panel Types

Returns the specified Panel Type

Returns all Parts

Returns the specified Part

Returns a set of Prospect records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'BySalepersonCode' - all prospect records for salesperson where id = SalepersonCode, 'BySalesDepartmentCode' - all prospects records for a sales department where id = SalesDepartmentCode,...

Returns the last 10 records inserted into the SM_Prospect table (for testing purposes only; this operation may be disabled in production.)

Returns a specific Prospect record by ProspectId

Get a list of Purchase Orders by search criteria

Get a specific Purchase order by PurchaseOrderID

Returns all RMR Reasons

Returns the specified RMR Reason

Returns all Salespeople

Returns the specified Salesperson

Files must be included in a multiplart-MIME format request. Only one file can be submitted per request. The SedonaDocument model / data must be added in the header as an example: X-JsonData: {DocumentId: "1", CustomerId: "8", DocumentType: "eForms", UserCode: "PerennialSoftware", UserDescription: "From eForms", SedonaDocumentEnum: "1" } If a SystemId is set > 1, the api will validate and obtain the correct Ids for Customer and Site.

Delete a sedona document

Returns a set of Service Company records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByCode' - service company record where id = ServiceCompanyCode,

Returns all Service Companies

Returns the specified Service Company

File must be encoded in the JSON request. Only one file can be submitted per request.

Removes the specified Service Ticket Document from the SedonaDocuments database

Returns all Service Levels

Returns the specified Service Level

Returns all the records in the SV_Problem table expect the default record

Returns the specified Service Problem

Returns a set of Service Tech records based on the option parameter. The id parameter may or may not be used. Possible values for the option parameter are: 'ByServiceCompanyID' - service tech record where id = ServiceCompanyID, 'ByServiceCompanyCode' - service tech record where id = ServiceCompanyCode,

Get a list of Service Tech absences by search criteria

Returns all the records in the SV_Service_Tech table expect the default record

Returns the specified Service Technician

No documentation available.

No documentation available.

No documentation available.

No documentation available.

No documentation available.

Returns a specific Service Ticket Dispatch record by DispatchID

Returns Service Ticket Dispatch records by id and option, where id is the unique identifier for a given option; valid options are: "byserviceticketid", "byservicetechid", "byserviceticketnumber", "byservicetechcode" For example, when the option is "byservicetechcode", then id respresents the Employee_Code in the SY_Eployee table

Updates an existing Service Ticket Dispatch record

Returns today's Service Ticket dispatches

Returns a specific Service Ticket Note record by NoteID

Creates a Service Ticket Note

Creates a Service Ticket Part

Update a specific Service Ticket Part record by ServiceTicketPartId A successful delete while return status code 204 (No Content). Not object is returned unless there is an error.

Deletes a specific Service Ticket Part record by ServiceTicketPartId. A successful delete while return status code 204 (No Content). Not object is returned unless there is an error.

Returns all System Types

Returns the specified System Type

Returns all Taxing Groups

Returns the specified Taxing Group

Returns all Terms

Returns the specified Term

Returns a specific record by UnappliedCashDetailID

Creates an Unapplied Cash Detail record

Returns all Vendor Types

Returns all Vendors

Returns the specified Vendor

File must be encoded (base64) in the JSON request. Only one file can be submitted per request.

Removes the specified Vendor Ticket Document from the SedonaDocuments database

Returns the Version

Returns all Warehouses

Returns the specified Warehouse

Returns all Warranties

Returns the specified Warranty

No documentation available.