Class: PayPal::SDK::Invoice::DataTypes::InvoiceType

Inherits:
DataType
  • Object
show all
Defined in:
lib/paypal-sdk/invoice/data_types.rb

Overview

Invoice details about the merchant, payer, totals and terms.

Class Method Summary collapse

Class Method Details

.load_members ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/paypal-sdk/invoice/data_types.rb', line 248

def self.load_members
  # Merchant's email. 
  object_of :merchantEmail, String, :required => true
  # Email to which the invoice will be sent. 
  object_of :payerEmail, String, :required => true
  # Unique identifier for the invoice. 
  object_of :number, String
  # Company contact information of the merchant company sending the invoice. 
  object_of :merchantInfo, BusinessInfoType
  # List of items included in this invoice. 
  object_of :itemList, InvoiceItemListType, :required => true
  # If True, indicates tax calculated after discount. Default is False.
  object_of :taxCalculatedAfterDiscount, Boolean
  # Currency used for all invoice item amounts and totals. 
  object_of :currencyCode, String, :required => true
  # Date on which the invoice will be enabled. 
  object_of :invoiceDate, DateTime
  # Date on which the invoice payment is due. 
  object_of :dueDate, DateTime
  # Terms by which the invoice payment is due. 
  object_of :paymentTerms, PaymentTermsType
  # A discount percent applied to the invoice, if any. 
  object_of :discountPercent, Float
  # A Invoice level discount amount applied on the invoice, if any. If DiscountPercent is provided, DiscountAmount is ignored. 
  object_of :discountAmount, Float
  # Total Items Discount applied to the invoice, if any. 
  object_of :totalItemDiscountAmount, Float
  # If true, indicates tax included in item amount. If present, this setting will supersede the merchant’s default setting. 
  object_of :taxInclusive, Boolean
  # General terms for the invoice. 
  object_of :terms, String
  # Note to the payer company. 
  object_of :note, String
  # Memo for book keeping that is private to the Merchant. 
  object_of :merchantMemo, String
  # Details of the receipt. Applicable only when invoice is a receipt. 
  object_of :receiptDetails, String
  # Billing information for the payer. 
  object_of :billingInfo, BusinessInfoType
  # Shipping information for the payer. 
  object_of :shippingInfo, BusinessInfoType
  # Cost of shipping. 
  object_of :shippingAmount, Float
  # Name of the applicable tax on shipping cost, if any. 
  object_of :shippingTaxName, String
  # Rate of the applicable tax on shipping cost, if any. 
  object_of :shippingTaxRate, Float
  # The tax on shipping amount, either included or on top of it. 
  object_of :shippingTaxAmount, Float
  # The external image URL of the invoice's logo, if any 
  object_of :logoUrl, String
  # BN code for tracking transactions with a particular partner. 
  object_of :referrerCode, String
  # Label used to display custom amount value. If a value is entered for customAmountLabel, then customAmountValue cannot be empty. 
  object_of :customAmountLabel, String
  # Value of custom amount. If a value is entered for customAmountValue, then customAmountLabel cannot be empty. 
  object_of :customAmountValue, Float
  # False, if the payment cannot be paid using both external and PayPal payment. True, if the payment can be paid using both external and PayPal payment. 
  object_of :allowPartialPayments, Boolean
end