(AutoIt) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

; 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)
$oJsonToken = ObjCreate("Chilkat.JsonObject")
$oJsonToken.LoadFile("qa_data/tokens/paypal.json")

; Build the Authorization request header field value.
$oSbAuth = ObjCreate("Chilkat.StringBuilder")
; token_type should be "Bearer"
$oSbAuth.Append($oJsonToken.StringOf("token_type"))
$oSbAuth.Append(" ")
$oSbAuth.Append($oJsonToken.StringOf("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.
$oRest = ObjCreate("Chilkat.Rest")
Local $bAutoReconnect = True
Local $bSuccess = $oRest.Connect("api.sandbox.paypal.com",443,True,$bAutoReconnect)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
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:
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.EmitCompact = False
$oJson.UpdateString("merchant_info.email","frank-facilitator@example.com")
$oJson.UpdateString("merchant_info.first_name","Frank")
$oJson.UpdateString("merchant_info.last_name","Facilitator")
$oJson.UpdateString("merchant_info.business_name","Medical Professionals, LLC")
$oJson.UpdateString("merchant_info.phone.country_code","001")
$oJson.UpdateString("merchant_info.phone.national_number","5032141716")
$oJson.UpdateString("merchant_info.address.line1","1234 Main St.")
$oJson.UpdateString("merchant_info.address.city","Portland")
$oJson.UpdateString("merchant_info.address.state","OR")
$oJson.UpdateString("merchant_info.address.postal_code","97217")
$oJson.UpdateString("merchant_info.address.country_code","US")
$oJson.UpdateString("billing_info[0].email","frank-buyer@somewhere.com")
$oJson.UpdateString("items[0].name","Sutures")
$oJson.UpdateInt("items[0].quantity",100)
$oJson.UpdateString("items[0].unit_price.currency","USD")
$oJson.UpdateString("items[0].unit_price.value","5")
$oJson.UpdateString("note","Medical Invoice 16 Jul, 2013 PST")
$oJson.UpdateString("payment_term.term_type","NET_45")
$oJson.UpdateString("shipping_info.first_name","Sally")
$oJson.UpdateString("shipping_info.last_name","Patient")
$oJson.UpdateString("shipping_info.business_name","Not applicable")
$oJson.UpdateString("shipping_info.phone.country_code","001")
$oJson.UpdateString("shipping_info.phone.national_number","5039871234")
$oJson.UpdateString("shipping_info.address.line1","1234 Broad St.")
$oJson.UpdateString("shipping_info.address.city","Portland")
$oJson.UpdateString("shipping_info.address.state","OR")
$oJson.UpdateString("shipping_info.address.postal_code","97216")
$oJson.UpdateString("shipping_info.address.country_code","US")

ConsoleWrite($oJson.Emit() & @CRLF)

; 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 }'

$oJson.EmitCompact = True
$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")

$oRest.AddHeader("Content-Type","application/json")
$oRest.AddHeader("Authorization",$oSbAuth.GetAsString())
$oJson.EmitSb($oSbRequestBody)

$bSuccess = $oRest.FullRequestSb("POST","/v1/invoicing/invoices",$oSbRequestBody,$oSbResponseBody)
If ($bSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

; We should have some sort of JSON response.  It could be successful, or an error.
$oJsonResponse = ObjCreate("Chilkat.JsonObject")
$oJsonResponse.EmitCompact = False
$oJsonResponse.LoadSb($oSbResponseBody)

ConsoleWrite("Response Status Code = " & $oRest.ResponseStatusCode & @CRLF)

; Did we get a 201 success response?
If ($oRest.ResponseStatusCode <> 201) Then
    ; Show the JSON response body
    ConsoleWrite($oJsonResponse.Emit() & @CRLF)

    ConsoleWrite($oRest.LastRequestStartLine & @CRLF)
    ConsoleWrite($oRest.LastRequestHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; Show a few parts of the JSON response
ConsoleWrite("id: " & $oJsonResponse.StringOf("id") & @CRLF)
ConsoleWrite("number: " & $oJsonResponse.StringOf("number") & @CRLF)
ConsoleWrite("template_id: " & $oJsonResponse.StringOf("template_id") & @CRLF)
ConsoleWrite("status: " & $oJsonResponse.StringOf("status") & @CRLF)

; Show the full JSON response.
ConsoleWrite($oJsonResponse.Emit() & @CRLF)
ConsoleWrite("Success." & @CRLF)

; 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"
; 	    }
; 	  ]
; 	}
;