(SQL Server) QuickBooks - Create an Employee

Demonstrates how to send an JSON request to create a QuickBooks employee

For more information, see https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/employee#create-an-employee

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- Get our previously obtained OAuth2 access token, which should contain JSON like this:
    -- {
    --   "expires_in": 3600,
    --   "x_refresh_token_expires_in": 8726400,
    --   "refresh_token": "L011546037639r ... 3vR2DrbOmg0Sdagw",
    --   "access_token": "eyJlbmMiOiJBMTI4Q0 ... oETJEMbeggg",
    --   "token_type": "bearer"
    -- }

    DECLARE @jsonToken int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonToken OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @jsonToken, 'LoadFile', @success OUT, 'qa_data/tokens/qb-access-token.json'

    DECLARE @rest int
    -- Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT

    -- Connect using TLS.
    -- A single REST object, once connected, can be used for many Quickbooks REST API calls.
    -- The auto-reconnect indicates that if the already-established HTTPS connection is closed,
    -- then it will be automatically re-established as needed.
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'sandbox-quickbooks.api.intuit.com', 443, 1, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @rest
        RETURN
      END

    DECLARE @sbAuth int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbAuth OUT

    EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, 'Bearer '
    EXEC sp_OAMethod @jsonToken, 'StringOf', @sTmp0 OUT, 'access_token'
    EXEC sp_OAMethod @sbAuth, 'Append', @success OUT, @sTmp0
    EXEC sp_OAMethod @sbAuth, 'GetAsString', @sTmp0 OUT
    EXEC sp_OASetProperty @rest, 'Authorization', @sTmp0

    -- Create the following JSON:

    -- Use this online tool to generate code from sample JSON: 
    -- Generate Code to Create JSON

    -- {
    --   "SSN": "444-55-6666",
    --   "PrimaryAddr": {
    --     "Id": "50",
    --     "Line1": "45 N. Elm Street",
    --     "City": "Middlefield",
    --     "CountrySubDivisionCode": "CA",
    --     "PostalCode": "93242"
    --   },
    --   "GivenName": "John",
    --   "FamilyName": "Meuller",
    --   "PrimaryPhone": {
    --     "FreeFormNumber": "408-525-1234"
    --   }
    -- }
    -- 
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'SSN', '444-55-6666'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'PrimaryAddr.Id', '50'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'PrimaryAddr.Line1', '45 N. Elm Street'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'PrimaryAddr.City', 'Middlefield'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'PrimaryAddr.CountrySubDivisionCode', 'CA'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'PrimaryAddr.PostalCode', '93242'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'GivenName', 'John'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'FamilyName', 'Meuller'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'PrimaryPhone.FreeFormNumber', '408-525-1234'

    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Content-Type', 'application/json'
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Accept', 'application/json'
    EXEC sp_OASetProperty @rest, 'AllowHeaderFolding', 0

    -- The company ID is 123146096291789
    DECLARE @responseBody nvarchar(4000)
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'FullRequestString', @responseBody OUT, 'POST', '/v3/company/123146096291789/employee?minorversion=45', @sTmp0
    EXEC sp_OAGetProperty @rest, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbAuth
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- We should expect a 200 response if successful.
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN

        PRINT 'Request Header: '
        EXEC sp_OAGetProperty @rest, 'LastRequestHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT '----'

        EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
        PRINT 'Response StatusCode = ' + @iTmp0

        EXEC sp_OAGetProperty @rest, 'ResponseStatusText', @sTmp0 OUT
        PRINT 'Response StatusLine: ' + @sTmp0

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
        PRINT @sTmp0

        PRINT @responseBody
        EXEC @hr = sp_OADestroy @jsonToken
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbAuth
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    DECLARE @jsonResponse int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonResponse OUT

    EXEC sp_OAMethod @jsonResponse, 'Load', @success OUT, @responseBody
    EXEC sp_OASetProperty @jsonResponse, 'EmitCompact', 0
    EXEC sp_OAMethod @jsonResponse, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    PRINT 'Success.'

    -- Use this online tool to generate parsing code from sample JSON: 
    -- Generate Parsing Code from JSON

    -- A sample JSON response:
    -- {
    --   "Employee": {
    --     "SSN": "XXX-XX-XXXX",
    --     "PrimaryAddr": {
    --       "Id": "97",
    --       "Line1": "45 N. Elm Street",
    --       "City": "Middlefield",
    --       "CountrySubDivisionCode": "CA",
    --       "PostalCode": "93242"
    --     },
    --     "BillableTime": false,
    --     "domain": "QBO",
    --     "sparse": false,
    --     "Id": "59",
    --     "SyncToken": "0",
    --     "MetaData": {
    --       "CreateTime": "2016-10-25T14:05:05-07:00",
    --       "LastUpdatedTime": "2016-10-25T14:05:05-07:00"
    --     },
    --     "GivenName": "John",
    --     "FamilyName": "Meuller",
    --     "DisplayName": "John Meuller",
    --     "PrintOnCheckName": "John Meuller",
    --     "Active": true,
    --     "PrimaryPhone": {
    --       "FreeFormNumber": "408-525-1234"
    --     }
    --   },
    --   "time": "2016-10-25T14:05:05.661-07:00"
    -- }
    -- 

    EXEC @hr = sp_OADestroy @jsonToken
    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @sbAuth
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @jsonResponse


END
GO