SQL Server / New FreshBooks / Single Payment
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr 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.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Content-Type', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "response": {
-- "result": {
-- "payment": {
-- "accounting_systemid": "wkMd2g",
-- "amount": {
-- "amount": "10.00",
-- "code": "USD"
-- },
-- "clientid": 31006,
-- "creditid": null,
-- "date": "2019-04-19",
-- "from_credit": false,
-- "gateway": null,
-- "id": 7658,
-- "invoiceid": 26398,
-- "logid": 7658,
-- "note": "Updated with proper invoice amount",
-- "orderid": null,
-- "overpaymentid": null,
-- "transactionid": null,
-- "type": "Check",
-- "updated": "2019-04-19 14:05:33",
-- "vis_state": 0
-- }
-- }
-- }
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @Accounting_systemid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Accounting_systemid OUT, 'response.result.payment.accounting_systemid'
DECLARE @Amount nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Amount OUT, 'response.result.payment.amount.amount'
DECLARE @Code nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Code OUT, 'response.result.payment.amount.code'
DECLARE @Clientid int
EXEC sp_OAMethod @jResp, 'IntOf', @Clientid OUT, 'response.result.payment.clientid'
DECLARE @Creditid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Creditid OUT, 'response.result.payment.creditid'
DECLARE @Date nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Date OUT, 'response.result.payment.date'
DECLARE @From_credit int
EXEC sp_OAMethod @jResp, 'BoolOf', @From_credit OUT, 'response.result.payment.from_credit'
DECLARE @Gateway nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Gateway OUT, 'response.result.payment.gateway'
DECLARE @Id int
EXEC sp_OAMethod @jResp, 'IntOf', @Id OUT, 'response.result.payment.id'
DECLARE @Invoiceid int
EXEC sp_OAMethod @jResp, 'IntOf', @Invoiceid OUT, 'response.result.payment.invoiceid'
DECLARE @Logid int
EXEC sp_OAMethod @jResp, 'IntOf', @Logid OUT, 'response.result.payment.logid'
DECLARE @Note nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Note OUT, 'response.result.payment.note'
DECLARE @Orderid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Orderid OUT, 'response.result.payment.orderid'
DECLARE @Overpaymentid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Overpaymentid OUT, 'response.result.payment.overpaymentid'
DECLARE @Transactionid nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Transactionid OUT, 'response.result.payment.transactionid'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'response.result.payment.type'
DECLARE @Updated nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated OUT, 'response.result.payment.updated'
DECLARE @Vis_state int
EXEC sp_OAMethod @jResp, 'IntOf', @Vis_state OUT, 'response.result.payment.vis_state'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}
Postman Collection Item JSON
{
"name": "Single Payment",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"payments",
"payments",
"{{paymentId}}"
]
}
},
"response": [
{
"name": "Single Payment",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"url": {
"raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/payments/payments/{{paymentId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"accounting",
"account",
"{{accountId}}",
"payments",
"payments",
"{{paymentId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSAwEOVlcTGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4DFVdfRgFPCkNFR0gUUE9eBwgXEQoSWRtVXVpGEUkJTQFPA1VQAgNUVFcPBQVUUFYBBQ9KSQAaEQFUVlIHAQhVXQkNCwVTD1QTTVUDCEVSPA=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:21:49 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:21:49 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"result\": {\n \"payment\": {\n \"accounting_systemid\": \"wkMd2g\",\n \"amount\": {\n \"amount\": \"10.00\",\n \"code\": \"USD\"\n },\n \"clientid\": 31006,\n \"creditid\": null,\n \"date\": \"2019-04-19\",\n \"from_credit\": false,\n \"gateway\": null,\n \"id\": 7658,\n \"invoiceid\": 26398,\n \"logid\": 7658,\n \"note\": \"Updated with proper invoice amount\",\n \"orderid\": null,\n \"overpaymentid\": null,\n \"transactionid\": null,\n \"type\": \"Check\",\n \"updated\": \"2019-04-19 14:05:33\",\n \"vis_state\": 0\n }\n }\n }\n}"
}
]
}
