Chilkat Online Tools

SQL Server / New FreshBooks / Edit Payment to Bill

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
    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.

    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

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

    -- The following JSON is sent in the request body.

    -- {
    --   "bill_payment": {
    --     "billid": "7",
    --     "amount": {
    --       "amount": "300",
    --       "code": "USD"
    --     },
    --     "payment_type": "Check",
    --     "paid_date": "2020-10-09",
    --     "note": "",
    --     "bill": "7"
    --   }
    -- }

    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, 'bill_payment.billid', '7'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bill_payment.amount.amount', '300'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bill_payment.amount.code', 'USD'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bill_payment.payment_type', 'Check'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bill_payment.paid_date', '2020-10-09'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bill_payment.note', ''
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'bill_payment.bill', '7'

    -- Adds the "Authorization: Bearer <access_token>" header.
    EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'

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

    EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PTextSb', @resp OUT, 'PUT', 'https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments/{{billPaymentId}}', @sbRequestBody, 'utf-8', 'application/json', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @sbRequestBody
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @sbRequestBody


END
GO

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
    "bill_payment": {
        "billid": "7",
        "amount": {
            "amount": "300",
            "code": "USD"
        },
        "payment_type": "Check",
        "paid_date": "2020-10-09",
        "note": "",
        "bill": "7"
    }
}'
https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments/{{billPaymentId}}

Postman Collection Item JSON

{
  "name": "Edit Payment to Bill",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"bill_payment\": {\n        \"billid\": \"7\",\n        \"amount\": {\n            \"amount\": \"300\",\n            \"code\": \"USD\"\n        },\n        \"payment_type\": \"Check\",\n        \"paid_date\": \"2020-10-09\",\n        \"note\": \"\",\n        \"bill\": \"7\"\n    }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "https://api.freshbooks.com/accounting/account/{{accountId}}/bill_payments/bill_payments/{{billPaymentId}}",
      "protocol": "https",
      "host": [
        "api",
        "freshbooks",
        "com"
      ],
      "path": [
        "accounting",
        "account",
        "{{accountId}}",
        "bill_payments",
        "bill_payments",
        "{{billPaymentId}}"
      ]
    }
  },
  "response": [
  ]
}