Archive
SWS FIUValidateExport Method
Displays a credit and corresponding debit and indicates whether they are balanced and available for non-export via FIU (Financial Integration Utility) for the specified organization, sites and dates.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| EndDate | DateTime | Optional |
| Description | The date to end a process. If start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. If ‘Null’, it defaults to today’s date. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Path | String | Not Used |
| Description | Not used for this SWS method as no data is exported. | |
| SiteList | Long | Optional |
| Description | A collection of limited site details for a specified site. If ‘Null’, will return all sites within the organization. | |
| StartDate | DateTime | Required |
| Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. This date cannot be greater than today. | |
Returned Parameters
| Name | DataType |
|---|---|
| Balanced | Boolean |
| Description | “True” if the credit and debit amounts balance, “False” if they do not. |
| CreditTotal | Decimal |
| Description | The total amount for credits for the non-exported transaction data for the specified organization, sites and dates. |
| DebitTotal | Decimal |
| Description | The total amount for debits for the non-exported transaction data for the specified organization, sites and dates. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a FIU_Request request object and a FIUValidateExport_Response response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.FIU_Request request = new SWS.FIU_Request();
SWS.FIUValidateExport_Response response;
Here’s my sample code of the Request object.
// Populate request object
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(1);
request.EndDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to update our previously exported financial information. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.FIUValidateExport(user_request,request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
SWS FIUSelect Method
Allows export of the FIU (Financial Integration Utility) general ledger data in .XML format to the accounting software. It can also be saved to a file path as long as permissions allow for it. This SWS method displays non-exported transaction data for the specified organization, sites and dates.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| EndDate | DateTime | Optional |
| Description | The date to end a process. If start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. This date cannot be greater than today. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Path | String | Not used for this method. |
| Description | If entered, the file location where the FIU export data will be saved as a .xml file. Permissions for the directory must be set to allow this to occur. | |
| SiteList | Long | Optional |
| Description | A collection of limited site details for a specified site. This will return all sites within the organization if left undefined. | |
| StartDate | DateTime | Required |
| Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. | |
Returned Parameters
| Name | DataType |
|---|---|
| TRAN_FIU_DATA | TRAN_FIU_DATA |
| Description | The object containing all the date for the call. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a FIU_Request request object and a FIU_Response response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.FIU_Request request = new SWS.FIU_Request();
SWS.FIU_Response response;
Here’s my sample code of the Request object.
// FIUSelect Request
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(1);
request.EndDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to update our previously exported financial information. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.FIUSelect(user_request,request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
SWS FIUExport Method
Exports FIU (Financial Integration Utility) data into 3rd party accounting software formats. The data is returned in the XML and can also be saved to the path specified as long as path permissions allow. This SWS method was designed to return the exported financial data in an EXR format and update the flag to indicate the change. It can also save the data to the specified path, if one is defined.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| EndDate | DateTime | Optional |
| Description | The date to end a process. If start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. This will default to today’s date undefined. This date cannot be greater than today. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Path | String | Optional |
| Description | If entered, the file location where the FIU export data will be saved as a .csv file. Permissions for the directory must be set to allow this to occur. | |
| SiteList | Long | Optional |
| Description | A collection of site IDs. This will return all sites within the organization if left undefined. | |
| StartDate | DateTime | Required |
| Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. | |
Returned Parameters
| Name | DataType |
|---|---|
| TRAN_FIU_EXPORT | TRAN_FIU_DATA |
| Description | The object containing all the data returned in the method. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a FIU_Request request object and a FIU_Response response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.FIU_Request request = new SWS.FIU_Request();
SWS.FIU_Response response;
Here’s my sample code of the Request object.
// FIUExport Request
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(1);
request.EndDate = DateTime.Today;
request.Path = "c:\\directory";
Finally we can call the method and pass across the login object and the request object to export our financial information. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.FIUSelect(user_request,request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
SWS FIUReInt Method
Resets exported FIU (Financial Integration Utility) data so that it can be re-exported into your accounting software program.
Parameters
| Name | DataType | Is Required |
|---|---|---|
| EndDate | DateTime | Required |
| Description | The date to end a process. If start date is provided, then it is the end date of a range of dates. Technically, it’s one day beyond the end date. This will default to today’s date if left undefined. This date cannot be greater than today. | |
| OrgID | Long | Required |
| Description | The organization’s ID number. | |
| Path | String | Not used in this method. |
| Description | If entered, the file location where the FIU export data will be saved as a .csv file. Permissions for the directory must be set to allow this to occur. | |
| SiteList | Long | Optional |
| Description | A collection of limited site details for a specified site. This will return all sites within the organization if left undefined. | |
| StartDate | DateTime | Required |
| Description | The date to start a process. If end date is provided, then it is the start date of a range of dates. | |
Returned Parameters
| Name | DataType |
|---|---|
| TRAN_FIU_DATA | TRAN_FIU_DATA |
| Description | The object containing all the data returned in the method. |
Example
As with every method we need to pass in credentials. We do this with the LookupUser request object.
We’ll assume you’ve got a web reference, let’s name it SWS, in your Visual Studio project. At this point we need to our objects. We’ll need the standard service object, a FIU_Request request object and a FIU_Response response object. We can define and create those like this:
// Create a request and response objects
SWS.WSSoapClient service = new SWS.WSSoapClient();
SWS.FIU_Request request = new SWS.FIU_Request();
SWS.FIU_Response response;
Here’s my sample code of the Request object.
// FIUReInt Request
request.OrgID = 123456;
request.SiteList = new long[] { 123456, 456789 };
request.StartDate = DateTime.Today.AddDays(1);
request.EndDate = DateTime.Today;
Finally we can call the method and pass across the login object and the request object to update our previously exported financial information. It’s a good idea to do this in a Try Catch block.
// Call the method that will load the response object
try
{
response = service.FIUReInt(user_request,request);
}
catch (Exception ex)
{
MessageBox.Show(ex.Message);
}
Note that if something goes wrong the service will respond with an exception. You’ll want to take a look at that message returned in that exception so it can be debugged.
For a full list of methods see SWS Methods.
Yardi Store Developer eXchange 