Invoice (rest-api-sdk 1.14.0 API)

java.lang.Object
- com.paypal.base.rest.PayPalModel
- - com.paypal.base.rest.PayPalResource
  - - com.paypal.api.payments.Invoice

public class Invoice
extends PayPalResource

Constructor Summary

Constructors
Constructor and Description

Invoice()
Default Constructor

Invoice(MerchantInfo merchantInfo)
Parameterized Constructor

Constructors
Constructor and Description
`Invoice()` Default Constructor
`Invoice(MerchantInfo merchantInfo)` Parameterized Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`cancel(APIContext apiContext, CancelNotification cancelNotification)` Cancels an invoice, by ID.
`void`	`cancel(java.lang.String accessToken, CancelNotification cancelNotification)` Deprecated. Please use `cancel(APIContext, CancelNotification)` instead.
`protected boolean`	`canEqual(java.lang.Object other)`
`Invoice`	`create(APIContext apiContext)` Creates an invoice.
`Invoice`	`create(java.lang.String accessToken)` Deprecated. Please use `create(APIContext)` instead.
`void`	`delete(APIContext apiContext)` Delete a particular invoice by passing the invoice ID to the request URI.
`void`	`delete(java.lang.String accessToken)` Deprecated. Please use `delete(APIContext)` instead.
`void`	`deleteExternalPayment(APIContext apiContext)` Delete external payment.
`void`	`deleteExternalRefund(APIContext apiContext)` Delete external refund.
`boolean`	`equals(java.lang.Object o)`
`static java.lang.String`	`fetchRefreshToken(APIContext context, java.lang.String authorizationCode)` Fetches long lived refresh token from authorization code, for third party merchant invoicing use.
`InvoiceNumber`	`generateNumber(APIContext apiContext)` Generates the next invoice number.
`static Invoice`	`get(APIContext apiContext, java.lang.String invoiceId)` Gets the details for a specified invoice, by ID.
`static Invoice`	`get(java.lang.String accessToken, java.lang.String invoiceId)` Deprecated. Please use `get(APIContext, String)` instead.
`java.lang.String`	`getAdditionalData()` Any miscellaneous invoice data.
`static Invoices`	`getAll(APIContext apiContext)` Lists some or all merchant invoices.
`static Invoices`	`getAll(APIContext apiContext, java.util.Map<java.lang.String,java.lang.String> options)` Lists some or all merchant invoices.
`static Invoices`	`getAll(java.lang.String accessToken)` Deprecated. Please use `getAll(APIContext)` instead.
`java.lang.Boolean`	`getAllowPartialPayment()` Indicates whether the invoice allows a partial payment.
`java.util.List<FileAttachment>`	`getAttachments()` List of files attached to the invoice.
`java.util.List<BillingInfo>`	`getBillingInfo()` The required invoice recipient email address and any optional billing information.
`java.util.List<Participant>`	`getCcInfo()` For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
`CustomAmount`	`getCustom()` The custom amount to apply on an invoice.
`Cost`	`getDiscount()` The invoice level discount, as a percent or an amount value.
`Currency`	`getGratuity()` Gratuity to include with the invoice.
`java.lang.String`	`getId()` The unique invoice resource identifier.
`java.lang.String`	`getInvoiceDate()` The date when the invoice was enabled.
`java.util.List<InvoiceItem>`	`getItems()` The list of items to include in the invoice.
`java.util.List<Links>`	`getLinks()` HATEOS links representing all the actions over the invoice resource based on the current invoice status.
`java.lang.String`	`getLogoUrl()` Full URL of an external image to use as the logo.
`MerchantInfo`	`getMerchantInfo()` Information about the merchant who is sending the invoice.
`java.lang.String`	`getMerchantMemo()` A private bookkeeping memo for the merchant.
`Metadata`	`getMetadata()` Audit information for the invoice.
`Currency`	`getMinimumAmountDue()` If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
`java.lang.String`	`getNote()` Note to the payer.
`java.lang.String`	`getNumber()` Unique number that appears on the invoice.
`PaymentSummary`	`getPaidAmount()` Payment summary of the invoice including amount paid through PayPal and other sources.
`java.util.List<PaymentDetail>`	`getPaymentDetails()` Deprecated. Please use `getPayments()` instead.
`java.util.List<PaymentDetail>`	`getPayments()` List of payment details for the invoice.
`PaymentTerm`	`getPaymentTerm()` Optional.
`java.lang.String`	`getReference()` Reference data, such as PO number, to add to the invoice.
`java.util.List<RefundDetail>`	`getRefundDetails()` Deprecated. Please use `getRefunds()` instead.
`PaymentSummary`	`getRefundedAmount()` Payment summary of the invoice including amount refunded through PayPal and other sources.
`java.util.List<RefundDetail>`	`getRefunds()` List of refund details for the invoice.
`ShippingCost`	`getShippingCost()` The shipping cost, as a percent or an amount value.
`ShippingInfo`	`getShippingInfo()` The shipping information for entities to whom items are being shipped.
`java.lang.String`	`getStatus()` Status of the invoice.
`java.lang.Boolean`	`getTaxCalculatedAfterDiscount()` Indicates whether tax is calculated before or after a discount.
`java.lang.Boolean`	`getTaxInclusive()` Indicates whether the unit price includes tax.
`java.lang.String`	`getTemplateId()` The template ID used for the invoice.
`java.lang.String`	`getTerms()` General terms of the invoice.
`Currency`	`getTotalAmount()` The total amount of the invoice.
`java.lang.String`	`getUri()` URI of the invoice resource.
`int`	`hashCode()`
`static Image`	`qrCode(APIContext apiContext, java.lang.String invoiceId)` Deprecated. Please use `qrCode(APIContext, String, Map)` instead.
`static Image`	`qrCode(APIContext apiContext, java.lang.String invoiceId, java.util.Map<java.lang.String,java.lang.String> options)` Generates a QR code for an invoice, by ID.
`void`	`recordPayment(APIContext apiContext, PaymentDetail paymentDetail)` Marks the status of a specified invoice, by ID, as paid.
`void`	`recordPayment(java.lang.String accessToken, PaymentDetail paymentDetail)` Deprecated. Please use `recordPayment(APIContext, PaymentDetail)` instead.
`void`	`recordRefund(APIContext apiContext, RefundDetail refundDetail)` Marks the status of a specified invoice, by ID, as refunded.
`void`	`recordRefund(java.lang.String accessToken, RefundDetail refundDetail)` Deprecated. Please use `recordRefund(APIContext, RefundDetail)` instead.
`void`	`remind(APIContext apiContext, Notification notification)` Sends a reminder about a specific invoice, by ID, to a recipient.
`void`	`remind(java.lang.String accessToken, Notification notification)` Deprecated. Please use `remind(APIContext, Notification)` instead.
`Invoices`	`search(APIContext apiContext, Search search)` Searches for an invoice or invoices.
`Invoices`	`search(java.lang.String accessToken, Search search)` Deprecated. Please use `search(APIContext, Search)` instead.
`void`	`send(APIContext apiContext)` Sends an invoice, by ID, to a recipient.
`void`	`send(java.lang.String accessToken)` Deprecated. Please use `send(APIContext)` instead.
`Invoice`	`setAdditionalData(java.lang.String additionalData)` Any miscellaneous invoice data.
`Invoice`	`setAllowPartialPayment(java.lang.Boolean allowPartialPayment)` Indicates whether the invoice allows a partial payment.
`Invoice`	`setAttachments(java.util.List<FileAttachment> attachments)` List of files attached to the invoice.
`Invoice`	`setBillingInfo(java.util.List<BillingInfo> billingInfo)` The required invoice recipient email address and any optional billing information.
`Invoice`	`setCcInfo(java.util.List<Participant> ccInfo)` For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification.
`Invoice`	`setCustom(CustomAmount custom)` The custom amount to apply on an invoice.
`Invoice`	`setDiscount(Cost discount)` The invoice level discount, as a percent or an amount value.
`Invoice`	`setGratuity(Currency gratuity)` Gratuity to include with the invoice.
`Invoice`	`setId(java.lang.String id)` The unique invoice resource identifier.
`Invoice`	`setInvoiceDate(java.lang.String invoiceDate)` The date when the invoice was enabled.
`Invoice`	`setItems(java.util.List<InvoiceItem> items)` The list of items to include in the invoice.
`Invoice`	`setLinks(java.util.List<Links> links)` HATEOS links representing all the actions over the invoice resource based on the current invoice status.
`Invoice`	`setLogoUrl(java.lang.String logoUrl)` Full URL of an external image to use as the logo.
`Invoice`	`setMerchantInfo(MerchantInfo merchantInfo)` Information about the merchant who is sending the invoice.
`Invoice`	`setMerchantMemo(java.lang.String merchantMemo)` A private bookkeeping memo for the merchant.
`Invoice`	`setMetadata(Metadata metadata)` Audit information for the invoice.
`Invoice`	`setMinimumAmountDue(Currency minimumAmountDue)` If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
`Invoice`	`setNote(java.lang.String note)` Note to the payer.
`Invoice`	`setNumber(java.lang.String number)` Unique number that appears on the invoice.
`Invoice`	`setPaidAmount(PaymentSummary paidAmount)` Payment summary of the invoice including amount paid through PayPal and other sources.
`Invoice`	`setPaymentDetails(java.util.List<PaymentDetail> details)` Deprecated. Please use `setPayments(List)` instead.
`Invoice`	`setPayments(java.util.List<PaymentDetail> payments)` List of payment details for the invoice.
`Invoice`	`setPaymentTerm(PaymentTerm paymentTerm)` Optional.
`Invoice`	`setReference(java.lang.String reference)` Reference data, such as PO number, to add to the invoice.
`Invoice`	`setRefundDetails(java.util.List<RefundDetail> details)` Deprecated. Please use `setRefunds(List)` instead.
`Invoice`	`setRefundedAmount(PaymentSummary refundedAmount)` Payment summary of the invoice including amount refunded through PayPal and other sources.
`Invoice`	`setRefunds(java.util.List<RefundDetail> refunds)` List of refund details for the invoice.
`Invoice`	`setShippingCost(ShippingCost shippingCost)` The shipping cost, as a percent or an amount value.
`Invoice`	`setShippingInfo(ShippingInfo shippingInfo)` The shipping information for entities to whom items are being shipped.
`Invoice`	`setStatus(java.lang.String status)` Status of the invoice.
`Invoice`	`setTaxCalculatedAfterDiscount(java.lang.Boolean taxCalculatedAfterDiscount)` Indicates whether tax is calculated before or after a discount.
`Invoice`	`setTaxInclusive(java.lang.Boolean taxInclusive)` Indicates whether the unit price includes tax.
`Invoice`	`setTemplateId(java.lang.String templateId)` The template ID used for the invoice.
`Invoice`	`setTerms(java.lang.String terms)` General terms of the invoice.
`Invoice`	`setTotalAmount(Currency totalAmount)` The total amount of the invoice.
`Invoice`	`setUri(java.lang.String uri)` URI of the invoice resource.
`Invoice`	`update(APIContext apiContext)` Fully updates an invoice by passing the invoice ID to the request URI.
`Invoice`	`update(java.lang.String accessToken)` Deprecated. Please use `update(APIContext)` instead.

Methods inherited from class com.paypal.base.rest.PayPalResource
configureAndExecute, configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientCredential, getClientID, getClientSecret, getConfigurations, getCredential, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel
toJSON, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Invoice
```
public Invoice()
```
    Default Constructor
  - Invoice
```
public Invoice(MerchantInfo merchantInfo)
```
    Parameterized Constructor
- Method Detail
  - getPaymentDetails
```
public java.util.List<PaymentDetail> getPaymentDetails()
```
    Deprecated. Please use getPayments() instead.
    
    Returns:
    
    List of PaymentDetail
  - setPaymentDetails
```
public Invoice setPaymentDetails(java.util.List<PaymentDetail> details)
```
    Deprecated. Please use setPayments(List) instead.
    
    Parameters:
    
    details -
    
    Returns:
    
    Invoice
  - getRefundDetails
```
public java.util.List<RefundDetail> getRefundDetails()
```
    Deprecated. Please use getRefunds() instead.
    
    Returns:
    
    List of RefundDetail
  - setRefundDetails
```
public Invoice setRefundDetails(java.util.List<RefundDetail> details)
```
    Deprecated. Please use setRefunds(List) instead.
    
    Parameters:
    
    details -
    
    Returns:
    
    Invoice
  - create
```
public Invoice create(java.lang.String accessToken)
               throws PayPalRESTException
```
    Deprecated. Please use create(APIContext) instead.
    
    Creates an invoice. Include invoice details including merchant information in the request.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Returns:
    
    Invoice
    
    Throws:
    
    PayPalRESTException
  - create
```
public Invoice create(APIContext apiContext)
               throws PayPalRESTException
```
    Creates an invoice. Include invoice details including merchant information in the request.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    Invoice
    
    Throws:
    
    PayPalRESTException
  - search
```
public Invoices search(java.lang.String accessToken,
                       Search search)
                throws PayPalRESTException
```
    Deprecated. Please use search(APIContext, Search) instead.
    
    Searches for an invoice or invoices. Include a search object that specifies your search criteria in the request.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    search - Search
    
    Returns:
    
    Invoices
    
    Throws:
    
    PayPalRESTException
  - search
```
public Invoices search(APIContext apiContext,
                       Search search)
                throws PayPalRESTException
```
    Searches for an invoice or invoices. Include a search object that specifies your search criteria in the request.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    search - Search
    
    Returns:
    
    Invoices
    
    Throws:
    
    PayPalRESTException
  - send
```
public void send(java.lang.String accessToken)
          throws PayPalRESTException
```
    Deprecated. Please use send(APIContext) instead.
    
    Sends an invoice, by ID, to a recipient. Optionally, set the `notify_merchant` query parameter to send the merchant an invoice update notification. By default, `notify_merchant` is `true`.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Throws:
    
    PayPalRESTException
  - send
```
public void send(APIContext apiContext)
          throws PayPalRESTException
```
    Sends an invoice, by ID, to a recipient. Optionally, set the `notify_merchant` query parameter to send the merchant an invoice update notification. By default, `notify_merchant` is `true`.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Throws:
    
    PayPalRESTException
  - remind
```
public void remind(java.lang.String accessToken,
                   Notification notification)
            throws PayPalRESTException
```
    Deprecated. Please use remind(APIContext, Notification) instead.
    
    Sends a reminder about a specific invoice, by ID, to a recipient. Include a notification object that defines the reminder subject and other details in the JSON request body.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    notification - Notification
    
    Throws:
    
    PayPalRESTException
  - remind
```
public void remind(APIContext apiContext,
                   Notification notification)
            throws PayPalRESTException
```
    Sends a reminder about a specific invoice, by ID, to a recipient. Include a notification object that defines the reminder subject and other details in the JSON request body.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    notification - Notification
    
    Throws:
    
    PayPalRESTException
  - cancel
```
public void cancel(java.lang.String accessToken,
                   CancelNotification cancelNotification)
            throws PayPalRESTException
```
    Deprecated. Please use cancel(APIContext, CancelNotification) instead.
    
    Cancels an invoice, by ID.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    cancelNotification - CancelNotification
    
    Throws:
    
    PayPalRESTException
  - cancel
```
public void cancel(APIContext apiContext,
                   CancelNotification cancelNotification)
            throws PayPalRESTException
```
    Cancels an invoice, by ID.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    cancelNotification - CancelNotification
    
    Throws:
    
    PayPalRESTException
  - recordPayment
```
public void recordPayment(java.lang.String accessToken,
                          PaymentDetail paymentDetail)
                   throws PayPalRESTException
```
    Deprecated. Please use recordPayment(APIContext, PaymentDetail) instead.
    
    Marks the status of a specified invoice, by ID, as paid. Include a payment detail object that defines the payment method and other details in the JSON request body.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    paymentDetail - PaymentDetail
    
    Throws:
    
    PayPalRESTException
  - recordPayment
```
public void recordPayment(APIContext apiContext,
                          PaymentDetail paymentDetail)
                   throws PayPalRESTException
```
    Marks the status of a specified invoice, by ID, as paid. Include a payment detail object that defines the payment method and other details in the JSON request body.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    paymentDetail - PaymentDetail
    
    Throws:
    
    PayPalRESTException
  - recordRefund
```
public void recordRefund(java.lang.String accessToken,
                         RefundDetail refundDetail)
                  throws PayPalRESTException
```
    Deprecated. Please use recordRefund(APIContext, RefundDetail) instead.
    
    Marks the status of a specified invoice, by ID, as refunded. Include a refund detail object that defines the refund type and other details in the JSON request body.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    refundDetail - RefundDetail
    
    Throws:
    
    PayPalRESTException
  - recordRefund
```
public void recordRefund(APIContext apiContext,
                         RefundDetail refundDetail)
                  throws PayPalRESTException
```
    Marks the status of a specified invoice, by ID, as refunded. Include a refund detail object that defines the refund type and other details in the JSON request body.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    refundDetail - RefundDetail
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Invoice get(java.lang.String accessToken,
                          java.lang.String invoiceId)
                   throws PayPalRESTException
```
    Deprecated. Please use get(APIContext, String) instead.
    
    Gets the details for a specified invoice, by ID.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    invoiceId - String
    
    Returns:
    
    Invoice
    
    Throws:
    
    PayPalRESTException
  - get
```
public static Invoice get(APIContext apiContext,
                          java.lang.String invoiceId)
                   throws PayPalRESTException
```
    Gets the details for a specified invoice, by ID.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    invoiceId - String
    
    Returns:
    
    Invoice
    
    Throws:
    
    PayPalRESTException
  - getAll
```
public static Invoices getAll(java.lang.String accessToken)
                       throws PayPalRESTException
```
    Deprecated. Please use getAll(APIContext) instead.
    
    Lists some or all merchant invoices. Filters the response by any specified optional query string parameters.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Returns:
    
    Invoices
    
    Throws:
    
    PayPalRESTException
  - getAll
```
public static Invoices getAll(APIContext apiContext)
                       throws PayPalRESTException
```
    Lists some or all merchant invoices. Filters the response by any specified optional query string parameters.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    Invoices
    
    Throws:
    
    PayPalRESTException
  - getAll
```
public static Invoices getAll(APIContext apiContext,
                              java.util.Map<java.lang.String,java.lang.String> options)
                       throws PayPalRESTException
```
    Lists some or all merchant invoices. Filters the response by any specified optional query string parameters.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    options - Map of query parameters. Allowed options: page, page_size, total_count_required.
    
    Returns:
    
    Invoices
    
    Throws:
    
    PayPalRESTException
  - update
```
public Invoice update(java.lang.String accessToken)
               throws PayPalRESTException
```
    Deprecated. Please use update(APIContext) instead.
    
    Fully updates an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Partial updates are not supported.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Returns:
    
    Invoice
    
    Throws:
    
    PayPalRESTException
  - update
```
public Invoice update(APIContext apiContext)
               throws PayPalRESTException
```
    Fully updates an invoice by passing the invoice ID to the request URI. In addition, pass a complete invoice object in the request JSON. Partial updates are not supported.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    Invoice
    
    Throws:
    
    PayPalRESTException
  - delete
```
public void delete(java.lang.String accessToken)
            throws PayPalRESTException
```
    Deprecated. Please use delete(APIContext) instead.
    
    Delete a particular invoice by passing the invoice ID to the request URI.
    
    Parameters:
    
    accessToken - Access Token used for the API call.
    
    Throws:
    
    PayPalRESTException
  - delete
```
public void delete(APIContext apiContext)
            throws PayPalRESTException
```
    Delete a particular invoice by passing the invoice ID to the request URI.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Throws:
    
    PayPalRESTException
  - deleteExternalPayment
```
public void deleteExternalPayment(APIContext apiContext)
                           throws PayPalRESTException
```
    Delete external payment.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Throws:
    
    PayPalRESTException
  - deleteExternalRefund
```
public void deleteExternalRefund(APIContext apiContext)
                          throws PayPalRESTException
```
    Delete external refund.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Throws:
    
    PayPalRESTException
  - qrCode
```
public static Image qrCode(APIContext apiContext,
                           java.lang.String invoiceId)
                    throws PayPalRESTException
```
    Deprecated. Please use qrCode(APIContext, String, Map) instead.
    
    Generates a QR code for an invoice, by ID. The request generates a QR code that is 500 pixels in width and height. To change the dimensions of the returned code, specify optional query parameters.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    invoiceId - String
    
    Returns:
    
    object
    
    Throws:
    
    PayPalRESTException
  - qrCode
```
public static Image qrCode(APIContext apiContext,
                           java.lang.String invoiceId,
                           java.util.Map<java.lang.String,java.lang.String> options)
                    throws PayPalRESTException
```
    Generates a QR code for an invoice, by ID. The request generates a QR code that is 500 pixels in width and height. To change the dimensions of the returned code, specify optional query parameters.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    invoiceId - String
    
    options - Map of options. Valid values are: width, height, action.
    
    Returns:
    
    object
    
    Throws:
    
    PayPalRESTException
  - generateNumber
```
public InvoiceNumber generateNumber(APIContext apiContext)
                             throws PayPalRESTException
```
    Generates the next invoice number.
    
    Parameters:
    
    apiContext - APIContext used for the API call.
    
    Returns:
    
    object
    
    Throws:
    
    PayPalRESTException
  - fetchRefreshToken
```
public static java.lang.String fetchRefreshToken(APIContext context,
                                                 java.lang.String authorizationCode)
                                          throws PayPalRESTException
```
    Fetches long lived refresh token from authorization code, for third party merchant invoicing use.
    
    Parameters:
    
    context - context
    
    authorizationCode - authorization code
    
    Returns:
    
    String Refresh Token
    
    Throws:
    
    PayPalRESTException
  - getId
```
public java.lang.String getId()
```
    The unique invoice resource identifier.
  - getNumber
```
public java.lang.String getNumber()
```
    Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
  - getTemplateId
```
public java.lang.String getTemplateId()
```
    The template ID used for the invoice. Useful for copy functionality.
  - getUri
```
public java.lang.String getUri()
```
    URI of the invoice resource.
  - getStatus
```
public java.lang.String getStatus()
```
    Status of the invoice.
  - getMerchantInfo
```
public MerchantInfo getMerchantInfo()
```
    Information about the merchant who is sending the invoice.
  - getBillingInfo
```
public java.util.List<BillingInfo> getBillingInfo()
```
    The required invoice recipient email address and any optional billing information. One recipient is supported.
  - getCcInfo
```
public java.util.List<Participant> getCcInfo()
```
    For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant.
  - getShippingInfo
```
public ShippingInfo getShippingInfo()
```
    The shipping information for entities to whom items are being shipped.
  - getItems
```
public java.util.List<InvoiceItem> getItems()
```
    The list of items to include in the invoice. Maximum value is 100 items per invoice.
  - getInvoiceDate
```
public java.lang.String getInvoiceDate()
```
    The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
  - getPaymentTerm
```
public PaymentTerm getPaymentTerm()
```
    Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both.
  - getReference
```
public java.lang.String getReference()
```
    Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
  - getDiscount
```
public Cost getDiscount()
```
    The invoice level discount, as a percent or an amount value.
  - getShippingCost
```
public ShippingCost getShippingCost()
```
    The shipping cost, as a percent or an amount value.
  - getCustom
```
public CustomAmount getCustom()
```
    The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
  - getAllowPartialPayment
```
public java.lang.Boolean getAllowPartialPayment()
```
    Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`.
  - getMinimumAmountDue
```
public Currency getMinimumAmountDue()
```
    If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
  - getTaxCalculatedAfterDiscount
```
public java.lang.Boolean getTaxCalculatedAfterDiscount()
```
    Indicates whether tax is calculated before or after a discount. If set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`.
  - getTaxInclusive
```
public java.lang.Boolean getTaxInclusive()
```
    Indicates whether the unit price includes tax. Default is `false`.
  - getTerms
```
public java.lang.String getTerms()
```
    General terms of the invoice. 4000 characters max.
  - getNote
```
public java.lang.String getNote()
```
    Note to the payer. 4000 characters max.
  - getMerchantMemo
```
public java.lang.String getMerchantMemo()
```
    A private bookkeeping memo for the merchant. Maximum length is 150 characters.
  - getLogoUrl
```
public java.lang.String getLogoUrl()
```
    Full URL of an external image to use as the logo. Maximum length is 4000 characters.
  - getTotalAmount
```
public Currency getTotalAmount()
```
    The total amount of the invoice.
  - getPayments
```
public java.util.List<PaymentDetail> getPayments()
```
    List of payment details for the invoice.
  - getRefunds
```
public java.util.List<RefundDetail> getRefunds()
```
    List of refund details for the invoice.
  - getMetadata
```
public Metadata getMetadata()
```
    Audit information for the invoice.
  - getAdditionalData
```
public java.lang.String getAdditionalData()
```
    Any miscellaneous invoice data. Maximum length is 4000 characters.
  - getGratuity
```
public Currency getGratuity()
```
    Gratuity to include with the invoice.
  - getPaidAmount
```
public PaymentSummary getPaidAmount()
```
    Payment summary of the invoice including amount paid through PayPal and other sources.
  - getRefundedAmount
```
public PaymentSummary getRefundedAmount()
```
    Payment summary of the invoice including amount refunded through PayPal and other sources.
  - getAttachments
```
public java.util.List<FileAttachment> getAttachments()
```
    List of files attached to the invoice.
  - getLinks
```
public java.util.List<Links> getLinks()
```
    HATEOS links representing all the actions over the invoice resource based on the current invoice status.
  - setId
```
public Invoice setId(java.lang.String id)
```
    The unique invoice resource identifier.
    
    Returns:
    
    this
  - setNumber
```
public Invoice setNumber(java.lang.String number)
```
    Unique number that appears on the invoice. If left blank will be auto-incremented from the last number. 25 characters max.
    
    Returns:
    
    this
  - setTemplateId
```
public Invoice setTemplateId(java.lang.String templateId)
```
    The template ID used for the invoice. Useful for copy functionality.
    
    Returns:
    
    this
  - setUri
```
public Invoice setUri(java.lang.String uri)
```
    URI of the invoice resource.
    
    Returns:
    
    this
  - setStatus
```
public Invoice setStatus(java.lang.String status)
```
    Status of the invoice.
    
    Returns:
    
    this
  - setMerchantInfo
```
public Invoice setMerchantInfo(MerchantInfo merchantInfo)
```
    Information about the merchant who is sending the invoice.
    
    Returns:
    
    this
  - setBillingInfo
```
public Invoice setBillingInfo(java.util.List<BillingInfo> billingInfo)
```
    The required invoice recipient email address and any optional billing information. One recipient is supported.
    
    Returns:
    
    this
  - setCcInfo
```
public Invoice setCcInfo(java.util.List<Participant> ccInfo)
```
    For invoices sent by email, one or more email addresses to which to send a Cc: copy of the notification. Supports only email addresses under participant.
    
    Returns:
    
    this
  - setShippingInfo
```
public Invoice setShippingInfo(ShippingInfo shippingInfo)
```
    The shipping information for entities to whom items are being shipped.
    
    Returns:
    
    this
  - setItems
```
public Invoice setItems(java.util.List<InvoiceItem> items)
```
    The list of items to include in the invoice. Maximum value is 100 items per invoice.
    
    Returns:
    
    this
  - setInvoiceDate
```
public Invoice setInvoiceDate(java.lang.String invoiceDate)
```
    The date when the invoice was enabled. The date format is *yyyy*-*MM*-*dd* *z* as defined in [Internet Date/Time Format](http://tools.ietf.org/html/rfc3339#section-5.6).
    
    Returns:
    
    this
  - setPaymentTerm
```
public Invoice setPaymentTerm(PaymentTerm paymentTerm)
```
    Optional. The payment deadline for the invoice. Value is either `term_type` or `due_date` but not both.
    
    Returns:
    
    this
  - setReference
```
public Invoice setReference(java.lang.String reference)
```
    Reference data, such as PO number, to add to the invoice. Maximum length is 60 characters.
    
    Returns:
    
    this
  - setDiscount
```
public Invoice setDiscount(Cost discount)
```
    The invoice level discount, as a percent or an amount value.
    
    Returns:
    
    this
  - setShippingCost
```
public Invoice setShippingCost(ShippingCost shippingCost)
```
    The shipping cost, as a percent or an amount value.
    
    Returns:
    
    this
  - setCustom
```
public Invoice setCustom(CustomAmount custom)
```
    The custom amount to apply on an invoice. If you include a label, the amount cannot be empty.
    
    Returns:
    
    this
  - setAllowPartialPayment
```
public Invoice setAllowPartialPayment(java.lang.Boolean allowPartialPayment)
```
    Indicates whether the invoice allows a partial payment. If set to `false`, invoice must be paid in full. If set to `true`, the invoice allows partial payments. Default is `false`.
    
    Returns:
    
    this
  - setMinimumAmountDue
```
public Invoice setMinimumAmountDue(Currency minimumAmountDue)
```
    If `allow_partial_payment` is set to `true`, the minimum amount allowed for a partial payment.
    
    Returns:
    
    this
  - setTaxCalculatedAfterDiscount
```
public Invoice setTaxCalculatedAfterDiscount(java.lang.Boolean taxCalculatedAfterDiscount)
```
    Indicates whether tax is calculated before or after a discount. If set to `false`, the tax is calculated before a discount. If set to `true`, the tax is calculated after a discount. Default is `false`.
    
    Returns:
    
    this
  - setTaxInclusive
```
public Invoice setTaxInclusive(java.lang.Boolean taxInclusive)
```
    Indicates whether the unit price includes tax. Default is `false`.
    
    Returns:
    
    this
  - setTerms
```
public Invoice setTerms(java.lang.String terms)
```
    General terms of the invoice. 4000 characters max.
    
    Returns:
    
    this
  - setNote
```
public Invoice setNote(java.lang.String note)
```
    Note to the payer. 4000 characters max.
    
    Returns:
    
    this
  - setMerchantMemo
```
public Invoice setMerchantMemo(java.lang.String merchantMemo)
```
    A private bookkeeping memo for the merchant. Maximum length is 150 characters.
    
    Returns:
    
    this
  - setLogoUrl
```
public Invoice setLogoUrl(java.lang.String logoUrl)
```
    Full URL of an external image to use as the logo. Maximum length is 4000 characters.
    
    Returns:
    
    this
  - setTotalAmount
```
public Invoice setTotalAmount(Currency totalAmount)
```
    The total amount of the invoice.
    
    Returns:
    
    this
  - setPayments
```
public Invoice setPayments(java.util.List<PaymentDetail> payments)
```
    List of payment details for the invoice.
    
    Returns:
    
    this
  - setRefunds
```
public Invoice setRefunds(java.util.List<RefundDetail> refunds)
```
    List of refund details for the invoice.
    
    Returns:
    
    this
  - setMetadata
```
public Invoice setMetadata(Metadata metadata)
```
    Audit information for the invoice.
    
    Returns:
    
    this
  - setAdditionalData
```
public Invoice setAdditionalData(java.lang.String additionalData)
```
    Any miscellaneous invoice data. Maximum length is 4000 characters.
    
    Returns:
    
    this
  - setGratuity
```
public Invoice setGratuity(Currency gratuity)
```
    Gratuity to include with the invoice.
    
    Returns:
    
    this
  - setPaidAmount
```
public Invoice setPaidAmount(PaymentSummary paidAmount)
```
    Payment summary of the invoice including amount paid through PayPal and other sources.
    
    Returns:
    
    this
  - setRefundedAmount
```
public Invoice setRefundedAmount(PaymentSummary refundedAmount)
```
    Payment summary of the invoice including amount refunded through PayPal and other sources.
    
    Returns:
    
    this
  - setAttachments
```
public Invoice setAttachments(java.util.List<FileAttachment> attachments)
```
    List of files attached to the invoice.
    
    Returns:
    
    this
  - setLinks
```
public Invoice setLinks(java.util.List<Links> links)
```
    HATEOS links representing all the actions over the invoice resource based on the current invoice status.
    
    Returns:
    
    this
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class PayPalModel
  - canEqual
```
protected boolean canEqual(java.lang.Object other)
```
    Overrides:
    
    canEqual in class PayPalModel
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class PayPalModel

Class Invoice

Constructor Summary

Method Summary

Methods inherited from class com.paypal.base.rest.PayPalResource

Methods inherited from class com.paypal.base.rest.PayPalModel

Methods inherited from class java.lang.Object

Constructor Detail

Invoice

Invoice

Method Detail

getPaymentDetails

setPaymentDetails

getRefundDetails

setRefundDetails

create

create

search

search

send

send

remind

remind

cancel

cancel

recordPayment

recordPayment

recordRefund

recordRefund

get

get

getAll

getAll

getAll

update

update

delete

delete

deleteExternalPayment

deleteExternalRefund

qrCode

qrCode

generateNumber

fetchRefreshToken

getId

getNumber

getTemplateId

getUri

getStatus

getMerchantInfo

getBillingInfo

getCcInfo

getShippingInfo

getItems

getInvoiceDate

getPaymentTerm

getReference

getDiscount

getShippingCost

getCustom

getAllowPartialPayment

getMinimumAmountDue

getTaxCalculatedAfterDiscount

getTaxInclusive

getTerms

getNote

getMerchantMemo

getLogoUrl

getTotalAmount

getPayments

getRefunds

getMetadata

getAdditionalData

getGratuity

getPaidAmount

getRefundedAmount

getAttachments

getLinks

setId

setNumber

setTemplateId