DataFlex

PayPal - Delete Draft Invoice

See more PayPal Examples

Deletes a draft invoice, by ID. Note that this call works for invoices in the draft state only. For invoices that have already been sent, you can cancel the invoice.

Note: This example requires Chilkat v9.5.0.65 or greater.

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoJsonToken
    Handle hoSbAuth
    Handle hoRest
    Boolean iBAutoReconnect
    String sInvoiceId
    Handle hoSbPath
    Variant vSbJsonResponse
    Handle hoSbJsonResponse
    String sTemp1
    Integer iTemp1

    Move False To iSuccess

    // Note: Requires Chilkat v9.5.0.65 or greater.

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    // Load our previously obtained access token. (see PayPal OAuth2 Access Token)
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
    If (Not(IsComObjectCreated(hoJsonToken))) Begin
        Send CreateComObject of hoJsonToken
    End
    Get ComLoadFile Of hoJsonToken "qa_data/tokens/paypal.json" To iSuccess

    // Build the Authorization request header field value.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbAuth
    If (Not(IsComObjectCreated(hoSbAuth))) Begin
        Send CreateComObject of hoSbAuth
    End
    // token_type should be "Bearer"
    Get ComStringOf Of hoJsonToken "token_type" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess
    Get ComAppend Of hoSbAuth " " To iSuccess
    Get ComStringOf Of hoJsonToken "access_token" To sTemp1
    Get ComAppend Of hoSbAuth sTemp1 To iSuccess

    // Make the initial connection.
    // A single REST object, once connected, can be used for many PayPal 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.
    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "api.sandbox.paypal.com" 443 True iBAutoReconnect To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // ----------------------------------------------------------------------------------------------
    // The code above this comment could be placed inside a function/subroutine within the application
    // because the connection does not need to be made for every request.  Once the connection is made
    // the app may send many requests..
    // ----------------------------------------------------------------------------------------------

    Get ComGetAsString Of hoSbAuth To sTemp1
    Get ComAddHeader Of hoRest "Authorization" sTemp1 To iSuccess

    Move "INV2-29Z4-EB7M-MUCY-327J" To sInvoiceId

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
    If (Not(IsComObjectCreated(hoSbPath))) Begin
        Send CreateComObject of hoSbPath
    End
    Get ComAppend Of hoSbPath "/v1/invoicing/invoices/" To iSuccess
    Get ComAppend Of hoSbPath sInvoiceId To iSuccess

    // Send the DELETE request and get the JSON response.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbJsonResponse
    If (Not(IsComObjectCreated(hoSbJsonResponse))) Begin
        Send CreateComObject of hoSbJsonResponse
    End
    Get ComGetAsString Of hoSbPath To sTemp1
    Get pvComObject of hoSbJsonResponse to vSbJsonResponse
    Get ComFullRequestNoBodySb Of hoRest "DELETE" sTemp1 vSbJsonResponse To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // A 204 response is expected for success.
    Get ComResponseStatusCode Of hoRest To iTemp1
    Showln "Response Status Code = " iTemp1

    // Did we get a 204 success response?
    Get ComResponseStatusCode Of hoRest To iTemp1
    If (iTemp1 <> 204) Begin
        Showln "Failed."
        Procedure_Return
    End

    Showln "Received successful 204 status code response."
    Showln "There is no response body, as expected."
    Showln "Success."


End_Procedure