QuickBooks Sync regroups multiple NuGet packages to sync data from QuickBooks Desktop using QbXml. Make requests to QuickBooks Desktop, analyze the returned values, etc.
This project is actively maintained and is in its early alpha stage. Many breaks will be introduced until stability is reached.
Install-Package QbSync.QbXml
QbXml is the language used by QuickBooks desktop to exchange back and forth data between an application and the QuickBooks database.
Here is a couple of ideas how you can make some requests and parse responses.
Create a request XML with QbXml
public class CustomerRequest
{
public CustomerRequest()
{
var request = new QbXmlRequest();
var innerRequest = new CustomerQueryRqType();
// Add some filters here
innerRequest.MaxReturned = "100";
innerRequest.FromModifiedDate = new DATETIMETYPE(DateTime.Now);
request.AddToSingle(innerRequest);
// Get the XML
var xml = request.GetRequest();
}
}Receive a response from QuickBooks and parse the QbXml
public class CustomerResponse
{
public void LoadResponse(string xml)
{
var response = new QbXmlResponse();
var rs = response.GetSingleItemFromResponse<CustomerQueryRsType>(xml);
// Receive customer objects, corresponding to the xml
var customers = rs.CustomerRet;
}
}Install-Package QbSync.WebConnector
Install-Package QbSync.WebConnector.AspNetCore
The WebConnector.AspNetCore contains reference to SoapCore/AspNetCore.
If you wish to create your steps in a library that does not have this dependency, you may install the WebConnector package.
Version 1.0.0 supports .NET Standard 2.0. We follow the dependency injection standard to load the services. We abstracted the SOAP protocol so you only have to implement necessary services in order to make your queries to QuickBooks.
Thanks to the Web Connector, you can communicate with QuickBooks Desktop. Users must download it at the following address: Intuit Web Connector
The Web Connector uses the SOAP protocol to talk with your website, the NuGet package takes care of the heavy lifting to talk with the QuickBooks Desktop. However, you must implement some services in order to get everything working according to your needs. The Web Connector will come periodically to your website asking if you have any requests to do to its database. With the nature of SOAP in mind, there are no protocols keeping the connection state between QuickBooks and your server. For this reason, your server needs to keep track of sessions with a database.
Once the Web Connector downloaded, your user must get a QWC file that will connect the Web Connector to your website. To generate a QWC file, load the appropriate service then pass in your model:
public MyController(IWebConnectorQwc webConnectorQwc)
{
this.webConnectorQwc = webConnectorQwc;
}
// ...
var data = webConnectorQwc.GetQwcFile(new QbSync.WebConnector.Models.WebConnectorQwcModel
{
AppName = "My App",
AppDescription = "Sync QuickBooks with My Website",
AppSupport = $"{url}/support",
AppURL = $"{url}/QBConnectorAsync.asmx",
FileID = Guid.NewGuid(), // Don't generate a new guid all the time, save it somewhere
OwnerID = Guid.NewGuid(), // Don't generate a new guid all the time, save it somewhere
UserName = "jsgoupil",
RunEvery = new TimeSpan(0, 30, 0),
QBType = QbSync.WebConnector.Models.QBType.QBFS
});In your Startup.cs, registers the services as follow:
public void ConfigureServices(IServiceCollection services)
{
services
.AddWebConnector(options =>
{
options
.AddAuthenticator<Authenticator>()
//.WithMessageValidator<MyMessageValidator>()
//.WithWebConnectorHandler<MyWebConnectorHandler>()
// Register steps; the order matters.
.WithStep<CustomerQuery.Request, CustomerQuery.Response>()
.WithStep<InvoiceQuery.Request, InvoiceQuery.Response>();
});
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
// Before UseMvc()
app
.UseWebConnector(options =>
{
options.SoapPath = "/QBConnectorAsync.asmx";
});
app.UseMvc();
}An authenticator will keep the state in your database of what is happening with the Web Connector session.
public interface IAuthenticator
{
Task<IAuthenticatedTicket> GetAuthenticationFromLoginAsync(string login, string password);
Task<IAuthenticatedTicket> GetAuthenticationFromTicketAsync(string ticket);
Task SaveTicketAsync(IAuthenticatedTicket ticket);
}GetAuthenticationFromLoginAsync- Authenticates a user from its login/password combination.GetAuthenticationFromTicketAsync- Authenticates a ticket previously given from a GetAuthenticationFromLogin call.SaveTicketAsync- Saves the ticket to the database.
The IAuthenticatedTicket contains 3 mandatory properties:
public interface IAuthenticatedTicket
{
string Ticket { get; set; }
string CurrentStep { get; set; }
bool Authenticated { get; set; }
}Ticket- Exchanged with the Web Connector. It acts as a session identifier.CurrentStep- State indicating at which step the Web Connector is currently at.Authenticated- Simple boolean indicating if the ticket is authenticated.
If a user is not authenticated, make sure to return a ticket value, but set the Authenticated to false.
You may want to attach more properties to the interface, such as your UserId, TimeZone, etc.
By registering a step such as CustomerQuery, you can get customers from the QuickBooks database.
Since all steps will require a database manipulation on your side, you have to implement it yourself. But don't worry, it is pretty simple.
The classes request and response are split because it is important to understand that they do not share fields: the HTTP requests coming from the Web Connector are made separately.
Don't forget to register them in your startup. The order matters, the steps will be executed in the order you provided.
After the step has executed, the next step in order will run.
Here is an example:
public class CustomerQuery
{
public const string NAME = "CustomerQuery";
public class Request : StepQueryRequestBase<CustomerQueryRqType>
{
public override string Name => NAME;
protected override Task<bool> ExecuteRequestAsync(IAuthenticatedTicket authenticatedTicket, CustomerQueryRqType request)
{
// Do some operations on the customerRequest to get only specific ones
request.FromModifiedDate = new DateTimeType(DateTime.Now);
return base.ExecuteRequestAsync(authenticatedTicket, request);
}
}
public class Response : StepQueryResponseBase<CustomerQueryRsType>
{
public override string Name => NAME;
protected override Task ExecuteResponseAsync(IAuthenticatedTicket authenticatedTicket, CustomerQueryRsType response)
{
// Execute some operations with your database.
return base.ExecuteResponseAsync(authenticatedTicket, response);
}
}
}The 2 classes CustomerQueryRqType/CustomerQueryRsType are provided by the QbXml NuGet package. You associate the request and the response. They implement QbRequest and QbResponse.
To find the correct request and response pair, visit https://static.developer.intuit.com/qbSDK-current/common/newosr/index.html
When you make a request to the QuickBooks database, you might receive hundreds of objects back. Your server or the database won't be able to handle that many; you have to break the query into batches. We have everything handled for you, but we need to save another state to the database. Instead of deriving from StepQueryResponseBase, you have to derive from StepQueryWithIterator and implement 2 methods.
- In the request *
protected abstract Task<string> RetrieveMessageAsync(IAuthenticatedTicket ticket, string key);- In the response *
protected abstract void SaveMessageAsync(IAuthenticatedTicket ticket, string key, string value);Save the message to the database based on its ticket, CurrentStep and key. Then retrieve it from the same keys.
By default, if you derive from the iterator, the query is batched with 100 objects.
The requests and responses that support an iterator implements QbIteratorRequest and QbIteratorResponse.
If you wish to send more than one request at once to QuickBooks, inherit from GroupStepQueryRequestBase and GroupStepQueryResponseBase and send as many objects you want to QuickBooks. Keep in mind that you should keep the final result
under a certain size to allow your server to be able to parse it.
Look at this example which make a CustomerAdd and a CustomerQuery in one step.
public class CustomerGroupAddQuery
{
public const string NAME = "CustomerGroupAddQuery";
public class Request : GroupStepQueryRequestBase
{
public override string Name => NAME;
private readonly ApplicationDbContext dbContext;
public Request(
ApplicationDbContext dbContext
)
{
this.dbContext = dbContext;
}
protected override Task<IEnumerable<IQbRequest>> ExecuteRequestAsync(IAuthenticatedTicket authenticatedTicket)
{
var list = new List<IQbRequest>
{
new CustomerAddRqType
{
CustomerAdd = new QbSync.QbXml.Objects.CustomerAdd
{
Name = "Unique Name" + Guid.NewGuid().ToString("D"),
FirstName = "User " + authenticatedTicket.GetUserId().ToString()
}
},
new CustomerQueryRqType
{
ActiveStatus = ActiveStatus.All
}
};
return Task.FromResult(list as IEnumerable<IQbRequest>);
}
protected override Task<QBXMLMsgsRqOnError> GetOnErrorAttributeAsync(IAuthenticatedTicket authenticatedTicket)
{
// This is the default behavior, use this overriden method to change it to stopOnError
// QuickBooks does not support rollbackOnError
return Task.FromResult(QBXMLMsgsRqOnError.continueOnError);
}
}
public class Response : GroupStepQueryResponseBase
{
public override string Name => NAME;
private readonly ApplicationDbContext dbContext;
public Response(
ApplicationDbContext dbContext
)
{
this.dbContext = dbContext;
}
protected override Task ExecuteResponseAsync(IAuthenticatedTicket authenticatedTicket, IEnumerable<IQbResponse> responses)
{
foreach (var item in responses)
{
switch (item)
{
case CustomerQueryRsType customerQueryRsType:
// Do something with the CustomerQuery data
break;
case CustomerAddRsType customerAddRsType:
// Do something with the CustomerAdd data
break;
}
}
return base.ExecuteResponseAsync(authenticatedTicket, responses);
}
}
}If you want to change the step order at runtime, you may implement the following methods:
public interface IStepQueryResponse
{
Task<string> GotoStepAsync();
Task<bool> GotoNextStepAsync();
}GotoStepAsync- Indicates the exact step name you would like to go. If you returnnull, theGotoNextStepAsyncwill be called.GotoNextStepAsync- Indicates if you should go to the next step or not. If you returnfalse, the same exact step will be executed.
QuickBooks supports multiple versions. However, this package supports only version 13.0 and above. In order to validate a request, you must provide a IMessageValidator.
The reason this package cannot validate the version is because of the nature of the Web Connector: it takes 2 calls from the Web Connector to validate the version then warn the user.
- The first call sends a version to your server. You can validate the version and must save the ticket for reference in the second call.
- The second call, you need to tell the Web Connector the version was wrong based on the ticket saved in step 1.
Since this is done with two requests, the first request must persist that the version is wrong based on the ticket.
With IsValidTicket, simply check if the ticket has been saved in your database (as invalid). If you find the ticket in your database, you can safely remove it from it as this method will not be called again with the same ticket.
This step is optional. If you don't implement a MessageValidator, we assume that the version is valid.
The MessageValidator can also be used to get the company file path that QuickBooks sends you.
This step is optional, the handler allows you to receive some calls from the Web Connector that you can take further actions.
If you do not wish to implement all the methods, you can override WebConnectorHandlerNoop.
public interface IWebConnectorHandler
{
Task ProcessClientInformationAsync(IAuthenticatedTicket authenticatedTicket, string response);
Task OnExceptionAsync(IAuthenticatedTicket authenticatedTicket, Exception exception);
Task<int> GetWaitTimeAsync(IAuthenticatedTicket authenticatedTicket);
Task<string> GetCompanyFileAsync(IAuthenticatedTicket authenticatedTicket);
Task CloseConnectionAsync(IAuthenticatedTicket authenticatedTicket);
}ProcessClientInformationAsync- Returns the configuration QuickBooks is in. This method is called once per session.OnExceptionAsync- Called when any types of exception occur on the server.GetWaitTimeAsync- Tells the Web Connector to come back later after X seconds. Returning 0 means to do the work immediately.GetCompanyFileAsync- Uses the company file path. Return an empty string to use the file that is currently opened.CloseConnectionAsync- The connection is closing; the Web Connector will not come back with this ticket.
QuickBooks does not handle Daylight Saving Time (DST) properly. The DATETIMETYPE class in this library is aware of
this issue and will correct timestamps coming from QuickBooks by removing the offset values in the common use cases.
Internally, QuickBooks returns an incorrect date time offset during DST. Consequently, QuickBooks expects that you send the date time with the same incorrect offset OR a date time, without an offset, in the computer's time zone where QuickBooks is installed.
In order to get correct dates from a DATETIMETYPE, you can do the following:
var savedString = request.FromModifiedDate.ToString();
// -> 2019-03-21T11:37:00 ; this value is the local time when the object has been modifiedvar savedDateTime = request.FromModifiedDate.ToDateTime();
// -> An unspecified `DateTime` representing the local time when the object has been modifiedTo re-create a DATETIMETYPE to use in a subsequent query, you may use one of the following methods:
request.FromModifiedDate = DATETIMETYPE.Parse(savedString);or
request.FromModifiedDate = new DATETIMETYPE(savedDateTime);Because the request.FromModifiedDate is inclusive, a common practice is to add one second to the previous date before making the query:
request.FromModifiedDate = new DATETIMETYPE(savedDateTime.AddSeconds(1));request.FromModifiedDate = DATETIMETYPE.Parse(savedString).Add(TimeSpan.FromSeconds(1));The above methods are the recommended approach, which will be the least likely to give you query issues due to QuickBooks DST issues.
If you truly need the original uncorrected value returned from QuickBooks that has a potentially incorrect offset, you can use:
request.FromModifiedDate.QuickBooksRawString;
// -> 2019-03-21T11:37:00-08:00 ; the original string returned from QuickBooksrequest.FromModifiedDate.UncorrectedDate;
// -> A nullable `DateTimeOffset` parsed value of the QuickBooksRawStringNote: The UncorrectedDate while nullable, will never be null if the DATETIMETYPE was generated from a QuickBooks response
To re-create a DATETIMETYPE for a query in this situation:
request.FromModifiedDate = DATETIMETYPE.Parse(rawString);request.FromModifiedDate = DATETIMETYPE.FromUncorrectedDate(uncorrectedDate);A use case for this method is if you are required to persist a DateTimeOffset, or any other UTC-based method,
so that you can accurately use the value to do a future query.
These methods should not be used to show the value to an end-user since it may appear to be an hour off during DST.
If you need to display the date to the user, you can get the DateTimeOffset by providing the correct TimeZoneInfo as such:
var quickBooksTimeZone = TimeZoneInfo.FindSystemTimeZoneById("Pacific Standard Time");
var dateTime = customerRet.TimeModified.ToDateTime();
var correctedOffset = quickBooksTimeZone.GetUtcOffset(dateTime);
var correctedDateTimeOffset = new DateTimeOffset(dateTime, correctedOffset);If you are not contributing to this project, you most likely don't need to read this section.
The Web Connector executes the following tasks:
Authenticate- Sends the login/password that you must verify. You also return a session ticket that will be used for the rest of messages that are exchanged back and forth.SendRequestXML- The Web Connector expects that you return an XML command that will execute on the database.ReceiveRequestXML- Response regarding the previous step.- GOTO Step 2 - Until you return an empty string, indicating that you are done.
CloseConnection- Connection is done.
The QbManager can be overriden in order to handle the communication at a lower level. You most likely don't need to do this.
Use the WebConnectorHandler.
SaveChangesAsync- Called before returning any data to the Web Connector. It's time to save data to your database.LogMessage- Data going in or out goes through this method, you can save it to a database in order to better debug.GetWaitTimeAsync- Tells the Web Connector to come back in X seconds.AuthenticateAsync- Verifies if the login/password is correct. Returns appropriate message to the Web Connector in order to continue further communication.ServerVersion- Returns the server version.ClientVersion- Indicates which version is the Web Connector. Returns W: to return a warning; E: to return an error. Empty string if everything is fine.SendRequestXMLAsync- The Web Connector is asking what has to be done to its database. Return an QbXml command.ReceiveRequestXMLAsync- Response from the Web Connector based on the previous command sent.GetLastErrorAsync- Gets the last error that happened. This method is called only if an error is found.ConnectionErrorAsync- An error happened with the Web Connector.CloseConnectionAsync- Closing the connection. Return a string to show to the user in the Web Connector.OnExceptionAsync- Called if any of your steps throw an exception. It would be a great time to log this exception for future debugging.ProcessClientInformationAsync- Called when the Web Connector first connect to the service. It contains the information about the QuickBooks database.GetCompanyFileAsync- Indicates which company file to use on the client. By default, it uses the one currently opened.
The XSD generator that Microsoft provides does not embed enough information in the resulting C#. For this reason, this project has its own code generator which enhanced a lot of types. For instance, we order properly the items in the XML. We add some length restriction. We add some interfaces.
We marked some properties as deprecated as we found out QuickBooks was emitting a warning when using them. If you find more properties, let us know.
We use a modified version of the XSD provided from QuickBooks; after working on this project, we found that the XSD are not up to date with the latest information.
Contributions are welcome. Code or documentation!
- Fork this project
- Create a feature/bug fix branch
- Push your branch up to your fork
- Submit a pull request
QuickBooksSync is under the MIT license.