Dart
Dart
PayPal Create Invoice
See more PayPal Examples
Creates a draft invoice.Chilkat Dart Downloads
import 'package:chilkat/chilkat.dart';
void main() {
// 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)
final jsonToken = CkJsonObject();
jsonToken.loadFile('qa_data/tokens/paypal.json');
// Build the Authorization request header field value.
final sbAuth = CkStringBuilder();
// token_type should be "Bearer"
sbAuth.append(jsonToken.stringOf('token_type'));
sbAuth.append(' ');
sbAuth.append(jsonToken.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.
final rest = CkRest();
final bAutoReconnect = true;
try {
rest.connect('api.sandbox.paypal.com', 443, true, bAutoReconnect);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// ----------------------------------------------------------------------------------------------
// 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:
final json = CkJsonObject();
json.emitCompact = false;
json.updateString('merchant_info.email', 'frank-facilitator@example.com');
json.updateString('merchant_info.first_name', 'Frank');
json.updateString('merchant_info.last_name', 'Facilitator');
json.updateString('merchant_info.business_name', 'Medical Professionals, LLC');
json.updateString('merchant_info.phone.country_code', '001');
json.updateString('merchant_info.phone.national_number', '5032141716');
json.updateString('merchant_info.address.line1', '1234 Main St.');
json.updateString('merchant_info.address.city', 'Portland');
json.updateString('merchant_info.address.state', 'OR');
json.updateString('merchant_info.address.postal_code', '97217');
json.updateString('merchant_info.address.country_code', 'US');
json.updateString('billing_info[0].email', 'frank-buyer@somewhere.com');
json.updateString('items[0].name', 'Sutures');
json.updateInt('items[0].quantity', 100);
json.updateString('items[0].unit_price.currency', 'USD');
json.updateString('items[0].unit_price.value', '5');
json.updateString('note', 'Medical Invoice 16 Jul, 2013 PST');
json.updateString('payment_term.term_type', 'NET_45');
json.updateString('shipping_info.first_name', 'Sally');
json.updateString('shipping_info.last_name', 'Patient');
json.updateString('shipping_info.business_name', 'Not applicable');
json.updateString('shipping_info.phone.country_code', '001');
json.updateString('shipping_info.phone.national_number', '5039871234');
json.updateString('shipping_info.address.line1', '1234 Broad St.');
json.updateString('shipping_info.address.city', 'Portland');
json.updateString('shipping_info.address.state', 'OR');
json.updateString('shipping_info.address.postal_code', '97216');
json.updateString('shipping_info.address.country_code', 'US');
print(json.emit());
// 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 }'
json.emitCompact = true;
final sbRequestBody = CkStringBuilder();
final sbResponseBody = CkStringBuilder();
rest.addHeader('Content-Type', 'application/json');
rest.addHeader('Authorization', sbAuth.getAsString());
json.emitSb(sbRequestBody);
try {
rest.fullRequestSb('POST', '/v1/invoicing/invoices', sbRequestBody, sbResponseBody);
} on ChilkatException catch (e) {
print(e.lastErrorText);
return;
}
// We should have some sort of JSON response. It could be successful, or an error.
final jsonResponse = CkJsonObject();
jsonResponse.emitCompact = false;
jsonResponse.loadSb(sbResponseBody);
print('Response Status Code = ${rest.responseStatusCode}');
// Did we get a 201 success response?
if (rest.responseStatusCode != 201) {
// Show the JSON response body
print(jsonResponse.emit());
print(rest.lastRequestStartLine);
print(rest.lastRequestHeader);
print('Failed.');
return;
}
// Show a few parts of the JSON response
print('id: ${jsonResponse.stringOf('id')}');
print('number: ${jsonResponse.stringOf('number')}');
print('template_id: ${jsonResponse.stringOf('template_id')}');
print('status: ${jsonResponse.stringOf('status')}');
// Show the full JSON response.
print(jsonResponse.emit());
print('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"
// }
// ]
// }
//
}