(Delphi DLL) 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 for Delphi Downloads Chilkat non-ActiveX DLL for Delphi Chilkat ActiveX DLL for Delphi * The examples here use the non-ActiveX DLL.

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, StringBuilder, Rest, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
jsonToken: HCkJsonObject;
sbAuth: HCkStringBuilder;
rest: HCkRest;
bAutoReconnect: Boolean;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
sbResponseBody: HCkStringBuilder;
jsonResponse: HCkJsonObject;

begin
// 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 := CkJsonObject_Create();
CkJsonObject_LoadFile(jsonToken,'qa_data/tokens/paypal.json');

// Build the Authorization request header field value.
sbAuth := CkStringBuilder_Create();
// token_type should be "Bearer"
CkStringBuilder_Append(sbAuth,CkJsonObject__stringOf(jsonToken,'token_type'));
CkStringBuilder_Append(sbAuth,' ');
CkStringBuilder_Append(sbAuth,CkJsonObject__stringOf(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 := CkRest_Create();
bAutoReconnect := True;
success := CkRest_Connect(rest,'api.sandbox.paypal.com',443,True,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  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..
// ----------------------------------------------------------------------------------------------

// First create a JSON invoice:
json := CkJsonObject_Create();
CkJsonObject_putEmitCompact(json,False);
CkJsonObject_UpdateString(json,'merchant_info.email','frank-facilitator@example.com');
CkJsonObject_UpdateString(json,'merchant_info.first_name','Frank');
CkJsonObject_UpdateString(json,'merchant_info.last_name','Facilitator');
CkJsonObject_UpdateString(json,'merchant_info.business_name','Medical Professionals, LLC');
CkJsonObject_UpdateString(json,'merchant_info.phone.country_code','001');
CkJsonObject_UpdateString(json,'merchant_info.phone.national_number','5032141716');
CkJsonObject_UpdateString(json,'merchant_info.address.line1','1234 Main St.');
CkJsonObject_UpdateString(json,'merchant_info.address.city','Portland');
CkJsonObject_UpdateString(json,'merchant_info.address.state','OR');
CkJsonObject_UpdateString(json,'merchant_info.address.postal_code','97217');
CkJsonObject_UpdateString(json,'merchant_info.address.country_code','US');
CkJsonObject_UpdateString(json,'billing_info[0].email','frank-buyer@somewhere.com');
CkJsonObject_UpdateString(json,'items[0].name','Sutures');
CkJsonObject_UpdateInt(json,'items[0].quantity',100);
CkJsonObject_UpdateString(json,'items[0].unit_price.currency','USD');
CkJsonObject_UpdateString(json,'items[0].unit_price.value','5');
CkJsonObject_UpdateString(json,'note','Medical Invoice 16 Jul, 2013 PST');
CkJsonObject_UpdateString(json,'payment_term.term_type','NET_45');
CkJsonObject_UpdateString(json,'shipping_info.first_name','Sally');
CkJsonObject_UpdateString(json,'shipping_info.last_name','Patient');
CkJsonObject_UpdateString(json,'shipping_info.business_name','Not applicable');
CkJsonObject_UpdateString(json,'shipping_info.phone.country_code','001');
CkJsonObject_UpdateString(json,'shipping_info.phone.national_number','5039871234');
CkJsonObject_UpdateString(json,'shipping_info.address.line1','1234 Broad St.');
CkJsonObject_UpdateString(json,'shipping_info.address.city','Portland');
CkJsonObject_UpdateString(json,'shipping_info.address.state','OR');
CkJsonObject_UpdateString(json,'shipping_info.address.postal_code','97216');
CkJsonObject_UpdateString(json,'shipping_info.address.country_code','US');

Memo1.Lines.Add(CkJsonObject__emit(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_putEmitCompact(json,True);
sbRequestBody := CkStringBuilder_Create();
sbResponseBody := CkStringBuilder_Create();

CkRest_AddHeader(rest,'Content-Type','application/json');
CkRest_AddHeader(rest,'Authorization',CkStringBuilder__getAsString(sbAuth));
CkJsonObject_EmitSb(json,sbRequestBody);

success := CkRest_FullRequestSb(rest,'POST','/v1/invoicing/invoices',sbRequestBody,sbResponseBody);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// We should have some sort of JSON response.  It could be successful, or an error.
jsonResponse := CkJsonObject_Create();
CkJsonObject_putEmitCompact(jsonResponse,False);
CkJsonObject_LoadSb(jsonResponse,sbResponseBody);

Memo1.Lines.Add('Response Status Code = ' + IntToStr(CkRest_getResponseStatusCode(rest)));

// Did we get a 201 success response?
if (CkRest_getResponseStatusCode(rest) <> 201) then
  begin
    // Show the JSON response body
    Memo1.Lines.Add(CkJsonObject__emit(jsonResponse));

    Memo1.Lines.Add(CkRest__lastRequestStartLine(rest));
    Memo1.Lines.Add(CkRest__lastRequestHeader(rest));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// Show a few parts of the JSON response
Memo1.Lines.Add('id: ' + CkJsonObject__stringOf(jsonResponse,'id'));
Memo1.Lines.Add('number: ' + CkJsonObject__stringOf(jsonResponse,'number'));
Memo1.Lines.Add('template_id: ' + CkJsonObject__stringOf(jsonResponse,'template_id'));
Memo1.Lines.Add('status: ' + CkJsonObject__stringOf(jsonResponse,'status'));

// Show the full JSON response.
Memo1.Lines.Add(CkJsonObject__emit(jsonResponse));
Memo1.Lines.Add('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_Dispose(jsonToken);
CkStringBuilder_Dispose(sbAuth);
CkRest_Dispose(rest);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jsonResponse);

end;