(PureBasic) PayPal Create Invoice

See more PayPal Examples

Creates a draft invoice.

For more information, see https://developer.paypal.com/docs/api/invoicing/v2/#invoices_create

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkRest.pb"

Procedure ChilkatExample()

    ; Note: Requires Chilkat v9.5.0.64 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)
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/paypal.json")

    ; Build the Authorization request header field value.
    sbAuth.i = CkStringBuilder::ckCreate()
    If sbAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; token_type should be "Bearer"
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"token_type"))
    CkStringBuilder::ckAppend(sbAuth," ")
    CkStringBuilder::ckAppend(sbAuth,CkJsonObject::ckStringOf(jsonToken,"access_token"))

    ; 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.
    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bAutoReconnect.i = 1
    success.i = CkRest::ckConnect(rest,"api.sandbox.paypal.com",443,1,bAutoReconnect)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        ProcedureReturn
    EndIf

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

    ; First create a JSON invoice:
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    CkJsonObject::ckUpdateString(json,"merchant_info.email","frank-facilitator@example.com")
    CkJsonObject::ckUpdateString(json,"merchant_info.first_name","Frank")
    CkJsonObject::ckUpdateString(json,"merchant_info.last_name","Facilitator")
    CkJsonObject::ckUpdateString(json,"merchant_info.business_name","Medical Professionals, LLC")
    CkJsonObject::ckUpdateString(json,"merchant_info.phone.country_code","001")
    CkJsonObject::ckUpdateString(json,"merchant_info.phone.national_number","5032141716")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.line1","1234 Main St.")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.city","Portland")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.state","OR")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.postal_code","97217")
    CkJsonObject::ckUpdateString(json,"merchant_info.address.country_code","US")
    CkJsonObject::ckUpdateString(json,"billing_info[0].email","frank-buyer@somewhere.com")
    CkJsonObject::ckUpdateString(json,"items[0].name","Sutures")
    CkJsonObject::ckUpdateInt(json,"items[0].quantity",100)
    CkJsonObject::ckUpdateString(json,"items[0].unit_price.currency","USD")
    CkJsonObject::ckUpdateString(json,"items[0].unit_price.value","5")
    CkJsonObject::ckUpdateString(json,"note","Medical Invoice 16 Jul, 2013 PST")
    CkJsonObject::ckUpdateString(json,"payment_term.term_type","NET_45")
    CkJsonObject::ckUpdateString(json,"shipping_info.first_name","Sally")
    CkJsonObject::ckUpdateString(json,"shipping_info.last_name","Patient")
    CkJsonObject::ckUpdateString(json,"shipping_info.business_name","Not applicable")
    CkJsonObject::ckUpdateString(json,"shipping_info.phone.country_code","001")
    CkJsonObject::ckUpdateString(json,"shipping_info.phone.national_number","5039871234")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.line1","1234 Broad St.")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.city","Portland")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.state","OR")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.postal_code","97216")
    CkJsonObject::ckUpdateString(json,"shipping_info.address.country_code","US")

    Debug CkJsonObject::ckEmit(json)

    ; The JSON invoice created by the above code:

    ; 	{ 
    ; 	  "merchant_info": { 
    ; 	    "email": "frank-facilitator@example.com",
    ; 	    "first_name": "Frank",
    ; 	    "last_name": "Facilitator",
    ; 	    "business_name": "Medical Professionals, LLC",
    ; 	    "phone": { 
    ; 	      "country_code": "001",
    ; 	      "national_number": "5032141716"
    ; 	    },
    ; 	    "address": { 
    ; 	      "line1": "1234 Main St.",
    ; 	      "city": "Portland",
    ; 	      "state": "OR",
    ; 	      "postal_code": "97217",
    ; 	      "country_code": "US"
    ; 	    }
    ; 	  },
    ; 	  "billing_info": [ 
    ; 	    { 
    ; 	      "email": "frank-buyer@somewhere.com"
    ; 	    }
    ; 	  ],
    ; 	  "items": [ 
    ; 	    { 
    ; 	      "name": "Sutures",
    ; 	      "quantity": 100,
    ; 	      "unit_price": { 
    ; 	        "currency": "USD",
    ; 	        "value": "5"
    ; 	      }
    ; 	    }
    ; 	  ],
    ; 	  "note": "Medical Invoice 16 Jul, 2013 PST",
    ; 	  "payment_term": { 
    ; 	    "term_type": "NET_45"
    ; 	  },
    ; 	  "shipping_info": { 
    ; 	    "first_name": "Sally",
    ; 	    "last_name": "Patient",
    ; 	    "business_name": "Not applicable",
    ; 	    "phone": { 
    ; 	      "country_code": "001",
    ; 	      "national_number": "5039871234"
    ; 	    },
    ; 	    "address": { 
    ; 	      "line1": "1234 Broad St.",
    ; 	      "city": "Portland",
    ; 	      "state": "OR",
    ; 	      "postal_code": "97216",
    ; 	      "country_code": "US"
    ; 	    }
    ; 	  }
    ; 	}

    ; Send the POST equivalent to this CURL command:

    ; 	curl -v -X POST https://api.sandbox.paypal.com/v1/invoicing/invoices/ \
    ; 	-H "Content-Type:application/json" \
    ; 	-H "Authorization: Bearer Access-Token" \
    ; 	-d '{ invoice JSON goes here }'

    CkJsonObject::setCkEmitCompact(json, 1)
    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkRest::ckAddHeader(rest,"Content-Type","application/json")
    CkRest::ckAddHeader(rest,"Authorization",CkStringBuilder::ckGetAsString(sbAuth))
    CkJsonObject::ckEmitSb(json,sbRequestBody)

    success = CkRest::ckFullRequestSb(rest,"POST","/v1/invoicing/invoices",sbRequestBody,sbResponseBody)
    If success <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    ; We should have some sort of JSON response.  It could be successful, or an error.
    jsonResponse.i = CkJsonObject::ckCreate()
    If jsonResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonResponse, 0)
    CkJsonObject::ckLoadSb(jsonResponse,sbResponseBody)

    Debug "Response Status Code = " + Str(CkRest::ckResponseStatusCode(rest))

    ; Did we get a 201 success response?
    If CkRest::ckResponseStatusCode(rest) <> 201
        ; Show the JSON response body
        Debug CkJsonObject::ckEmit(jsonResponse)

        Debug CkRest::ckLastRequestStartLine(rest)
        Debug CkRest::ckLastRequestHeader(rest)
        Debug "Failed."
        CkJsonObject::ckDispose(jsonToken)
        CkStringBuilder::ckDispose(sbAuth)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jsonResponse)
        ProcedureReturn
    EndIf

    ; Show a few parts of the JSON response
    Debug "id: " + CkJsonObject::ckStringOf(jsonResponse,"id")
    Debug "number: " + CkJsonObject::ckStringOf(jsonResponse,"number")
    Debug "template_id: " + CkJsonObject::ckStringOf(jsonResponse,"template_id")
    Debug "status: " + CkJsonObject::ckStringOf(jsonResponse,"status")

    ; Show the full JSON response.
    Debug CkJsonObject::ckEmit(jsonResponse)
    Debug "Success."

    ; A successful response looks like this:

    ; 	{ 
    ; 	  "id": "INV2-ZG2H-HKAW-PMWU-N6ZR",
    ; 	  "number": "0001",
    ; 	  "template_id": "TEMP-8HS37702UW384535K",
    ; 	  "status": "DRAFT",
    ; 	  "merchant_info": { 
    ; 	    "email": "smith-facilitator@chilkatsoft.com",
    ; 	    "first_name": "Joe",
    ; 	    "last_name": "Facilitator",
    ; 	    "business_name": "Medical Professionals, LLC",
    ; 	    "phone": { 
    ; 	      "country_code": "001",
    ; 	      "national_number": "5032141716"
    ; 	    },
    ; 	    "address": { 
    ; 	      "line1": "1234 Main St.",
    ; 	      "city": "Portland",
    ; 	      "state": "OR",
    ; 	      "postal_code": "97217",
    ; 	      "country_code": "US"
    ; 	    }
    ; 	  },
    ; 	  "billing_info": [ 
    ; 	    { 
    ; 	      "email": "smith-buyer@chilkatsoft.com"
    ; 	    }
    ; 	  ],
    ; 	  "shipping_info": { 
    ; 	    "first_name": "Sally",
    ; 	    "last_name": "Patient",
    ; 	    "business_name": "Not applicable",
    ; 	    "phone": { 
    ; 	      "country_code": "001",
    ; 	      "national_number": "5039871234"
    ; 	    },
    ; 	    "address": { 
    ; 	      "line1": "1234 Broad St.",
    ; 	      "city": "Portland",
    ; 	      "state": "OR",
    ; 	      "postal_code": "97216",
    ; 	      "country_code": "US"
    ; 	    }
    ; 	  },
    ; 	  "items": [ 
    ; 	    { 
    ; 	      "name": "Sutures",
    ; 	      "quantity": 100.0,
    ; 	      "unit_price": { 
    ; 	        "currency": "USD",
    ; 	        "value": "5.00"
    ; 	      }
    ; 	    }
    ; 	  ],
    ; 	  "invoice_date": "2016-11-15 PST",
    ; 	  "payment_term": { 
    ; 	    "term_type": "NET_45",
    ; 	    "due_date": "2016-12-30 PST"
    ; 	  },
    ; 	  "tax_calculated_after_discount": false,
    ; 	  "tax_inclusive": false,
    ; 	  "note": "Medical Invoice 16 Jul, 2013 PST",
    ; 	  "total_amount": { 
    ; 	    "currency": "USD",
    ; 	    "value": "500.00"
    ; 	  },
    ; 	  "metadata": { 
    ; 	    "created_date": "2016-11-15 06:17:03 PST"
    ; 	  },
    ; 	  "links": [ 
    ; 	    { 
    ; 	      "rel": "self",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
    ; 	      "method": "GET"
    ; 	    },
    ; 	    { 
    ; 	      "rel": "send",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/send",
    ; 	      "method": "POST"
    ; 	    },
    ; 	    { 
    ; 	      "rel": "update",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR/update",
    ; 	      "method": "PUT"
    ; 	    },
    ; 	    { 
    ; 	      "rel": "delete",
    ; 	      "href": "https://api.sandbox.paypal.com/v1/invoicing/invoices/INV2-ZG2H-HKAW-PMWU-N6ZR",
    ; 	      "method": "DELETE"
    ; 	    }
    ; 	  ]
    ; 	}
    ; 


    CkJsonObject::ckDispose(jsonToken)
    CkStringBuilder::ckDispose(sbAuth)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jsonResponse)


    ProcedureReturn
EndProcedure