PayPal Integrator V5 - Online Help
PayPal Integrator V5
Questions / Feedback?

Invoice Class

Properties   Methods   Events   Configuration Settings   Errors  

Invoice allows merchants to easily create, send, and manage invoices using PayPal.

Syntax

inpaypal.invoice()

Remarks

The Invoice component is used to create invoices and send them to the recipient via email. To create an invoice, the MerchantInfo, BillingInfo, ShippingInfo, InvoiceInfo, and InvoiceItems can be set to the desired invoice details. After entering the information to be contained on the invoice, you can then create it by calling CreateInvoice and send it by calling Send. If you wish to create an invoice and send it immediately, you can make a single call to CreateAndSend.

If you wish to alter invoice details after it has been created, you can set MerchantInfo, BillingInfo, ShippingInfo, InvoiceInfo, and InvoiceItems as desired and then call Update. This will update an existing invoice using the new details specified. Note that you can remove items from the invoice by removing it from InvoiceItems prior to calling Update.

To cancel an invoice, you can set CancellationInfo to provide details about the cancellation and then call Cancel.

To mark an invoice as paid, PaymentInfo can be set to the describe the payment and then MarkAsPaid can be called.

The Invoice component also provides search features which allows you to find and filter created invoices. To perform a search, just set SearchCriteria to the desired search parameters and call Search. The invoices that match the specified search parameters will be returned via SearchResults. If you happen to know the ID of the invoice you wish to retrieve details about, you can use GetDetails to obtain in depth details for the specified invoice.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AckAcknowledgement code received from PayPal.
ApplicationIdYour application's identification, which is issued by PayPal.
BillingBusinessNameThe business name.
BillingCityThe city of the contact.
BillingCountryCodeThe country code of the contact.
BillingCustomValueCustom value to be displayed in the contact information details.
BillingEmailThe email address of the contact.
BillingFaxThe fax number of the contact.
BillingFirstNameThe first name of the contact.
BillingLastNameThe last name of the contact.
BillingPhoneThe phone number of the contact.
BillingStateThe state of the contact.
BillingStreet1The street name for the contact.
BillingStreet2An extra street line for the contact.
BillingWebsiteThe website of the contact.
BillingZipThe zip code of the contact.
CancellationNoteContains a note to send the payer within the cancellation notification.
CancellationSendMerchantCopyIndicates whether to send a copy of the cancellation notification to the merchant.
CancellationSubjectContains the subject of the cancellation notification.
CurrencyCodeCurrency code used for all invoice item amounts and totals.
DeviceIPClient's IP address.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the component.
InvoiceDetailCanceledByContains the account that canceled the invoice.
InvoiceDetailCanceledByActorContains the actor that canceled the invoice.
InvoiceDetailCanceledDateContains the date on which the invoice was canceled.
InvoiceDetailCreatedByContains the account that created the invoice.
InvoiceDetailCreatedDateContains the date on which the invoice was created.
InvoiceDetailFirstSentDateContains the date on which the invoice was first sent.
InvoiceDetailOriginContains the origin of which the invoice was created.
InvoiceDetailStatusContains the status of the invoice.
InvoiceDetailTotalAmountContains the total amount of the invoice.
InvoiceDetailLastSentByContains the account that last sent the invoice.
InvoiceDetailLastSentDateContains the date on which the invoice was last sent.
InvoiceDetailLastUpdatedByContains the account last edited the invoice.
InvoiceDetailLastUpdatedDateContains the date on which the invoice was last updated.
InvoiceDetailPaidDateContains the date on which the invoice was paid.
InvoiceDateContains the date on which the invoice is enabled.
InvoiceDiscountAmountThe discount amount applied to the invoice.
InvoiceDiscountPercentThe discount percent applied to the invoice.
InvoiceDueDateContains the date on which the payment is due.
InvoiceLogoURLContains the complete URL to an external image used as the logo.
InvoiceMerchantMemoMemo for bookkeeping that is private to the merchant.
InvoiceNoteNote to the payer company.
InvoiceNumberContains the number of the invoice as assigned by the merchant.
InvoicePaymentTermSpecifies the term by which the invoice payment is due.
InvoiceShippingAmountThe cost of shipping.
InvoiceShippingTaxNameName of the applicable tax on shipping cost.
InvoiceShippingTaxRateRate of the applicable tax on shipping cost.
InvoiceTermsGeneral terms for the invoice.
InvoiceItemCountThe number of records in the InvoiceItem arrays.
InvoiceItemDateDate on which the product or service was provided.
InvoiceItemDescriptionDescription of the invoice item.
InvoiceItemNameSKU or name of the item.
InvoiceItemQuantityItem count.
InvoiceItemTaxNameName of the applicable tax.
InvoiceItemTaxRateRate of the applicable tax.
InvoiceItemUnitPricePrice of the item (in the currency specified by CurrencyCode ).
MerchantBusinessNameThe business name.
MerchantCityThe city of the contact.
MerchantCountryCodeThe country code of the contact.
MerchantCustomValueCustom value to be displayed in the contact information details.
MerchantEmailThe email address of the contact.
MerchantFaxThe fax number of the contact.
MerchantFirstNameThe first name of the contact.
MerchantLastNameThe last name of the contact.
MerchantPhoneThe phone number of the contact.
MerchantStateThe state of the contact.
MerchantStreet1The street name for the contact.
MerchantStreet2An extra street line for the contact.
MerchantWebsiteThe website of the contact.
MerchantZipThe zip code of the contact.
PasswordPassword for communicating with PayPal.
PaymentDateContains the date on which the invoice was paid.
PaymentMethodThis property is used to specify the method of payment used when marking an invoice as paid (via MarkAsPaid ).
PaymentNoteContains a note associated with the invoice payment.
PaymentTransactionIdContains the Transaction ID of a PayPal payment.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
ResponseInvoiceIdContains the Id of the invoice as assigned by PayPal.
ResponseInvoiceNumberContains the number of the invoice as assigned by the merchant.
ResponseInvoiceURLContains the URL location where merchants can view the invoice details.
SearchCriteriaBusinessNameSearch by the Business's name.
SearchCriteriaCreationEndDateInvoice creation end date filter.
SearchCriteriaCreationStartDateInvoice creation start date filter.
SearchCriteriaCurrencyCodeSearch by currency code.
SearchCriteriaDueEndDateInvoice due end date filter.
SearchCriteriaDueStartDateInvoice due start date filter.
SearchCriteriaEmailSearch by an email address.
SearchCriteriaInvoiceEndDateInvoice end date filter (the date in which the invoice was enabled).
SearchCriteriaInvoiceNumberSearch by the invoice number.
SearchCriteriaInvoiceStartDateInvoice start date filter (the date in which the invoice was enabled).
SearchCriteriaLowerAmountSearch by transaction invoice amount.
SearchCriteriaMemoSearch by the invoice memo.
SearchCriteriaOriginSearch an invoice by its origin of creation.
SearchCriteriaPageThe page number of the result set.
SearchCriteriaPageSizeThe specifies the number of results per page that should be returned.
SearchCriteriaPaymentEndDateInvoice payment end date filter.
SearchCriteriaPaymentStartDateInvoice payment start date filter.
SearchCriteriaRecipientNameSearch by the Recipient's name.
SearchCriteriaStatusSearch by the invoice status.
SearchCriteriaUpperAmountSearch by transaction invoice amount.
SearchHasNextPageIndicates if another page of invoice summary results exists.
SearchHasPreviousPageIndicates if a previous page of invoice summary results exists.
SearchPageThe page number of the search result set.
SearchResultCountThe number of records in the SearchResult arrays.
SearchResultBillingBusinessNameContains the business name of the billing contact.
SearchResultBillingFirstNameContains the first name of the billing contact.
SearchResultBillingLastNameContains the last name of the billing contact.
SearchResultCurrencyCodeContains the currency code used for all invoice item amounts and totals.
SearchResultDueDateContains the date on which the invoice payment is due.
SearchResultInvoiceDateContains the date on which the invoice was enabled.
SearchResultInvoiceIdContains the Id of the invoice as assigned by PayPal.
SearchResultInvoiceNumberContains the number of the invoice as assigned by the merchant.
SearchResultMerchantEmailContains the Merchant's email address of the invoice.
SearchResultOriginContains the origin of which the invoice was created.
SearchResultPayerEmailContains the Payer's email address of the invoice.
SearchResultShippingBusinessNameContains the business name of the shipping contact.
SearchResultShippingFirstNameContains the first name of the shipping contact.
SearchResultShippingLastNameContains the last name of the shipping contact.
SearchResultStatusContains the status of the invoice.
SearchResultTotalAmountContains the total amount of the invoice.
ShippingBusinessNameThe business name.
ShippingCityThe city of the contact.
ShippingCountryCodeThe country code of the contact.
ShippingCustomValueCustom value to be displayed in the contact information details.
ShippingEmailThe email address of the contact.
ShippingFaxThe fax number of the contact.
ShippingFirstNameThe first name of the contact.
ShippingLastNameThe last name of the contact.
ShippingPhoneThe phone number of the contact.
ShippingStateThe state of the contact.
ShippingStreet1The street name for the contact.
ShippingStreet2An extra street line for the contact.
ShippingWebsiteThe website of the contact.
ShippingZipThe zip code of the contact.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TimeStampThe date on which the response was sent.
URLURL all PayPal payment transactions are posted to.
UserUser name for communicating with Paypal.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

AddCustomFieldThis adds a custom name-value pair to be sent with the next request.
CancelCancels an invoice.
ConfigSets or retrieves a configuration setting .
CreateAndSendCreates an invoice and sends it to the payer.
CreateInvoiceCreates an invoice.
DoEventsProcesses events from the internal message queue.
GetDetailsRetrieves detailed information about an invoice.
GetResponseVarIt is not uncommon for there to be additional response variables returned in the response that cannot be directly obtained via the Response properties.
InterruptInterrupt the current method.
MarkAsPaidMarks an invoice as paid.
ResetReset the internal state of the component and all properties to their default values.
SearchSearches for invoices.
SendSends an invoice to a payer.
UpdateUpdates an invoice.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
WarningInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

ItemDiscountAmountThe discount amount for an invoice item.
ItemDiscountPercentThe discount percent for an invoice item.
AuthorizingAccountAuthorizing Account Email Address for third-party API access.
AuthAccessTokenThe access token returned by the PayPal Permission Service's GetAccessToken operation.
AuthApplicationIdThe Application ID for the application making a request to the PayPal Permissions Service.
AuthAuthHeaderThe PayPal Permissions Service authentication header.
AuthAuthHeaderNameThe name of the authentication header generated with the PayPal Permissions Service.
AuthCallbackURLThe URL where PayPal will post the RequestToken and VerificationCode.
AuthPasswordAPI Password for the PayPal Permissions Service.
AuthRequestTokenThe request token used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
AuthRequestURLThe URL for the PayPal Permissions Service operation being requested.
AuthScopeScope of permissions to be requested for PayPal Permissions Service.
AuthSignatureAPI Signature for the PayPal Permissions Service.
AuthTokenSecretThe token secret returned by the PayPal Permission Service's GetAccessToken operation.
AuthUsernameAPI Username for the PayPal Permissions Service.
AuthVerificationCodeThe verification code used to obtain an Access Token and Token Secret from the PayPal Permissions Service.
BuildReturns the Build number contained in the response.
RawRequestReturns the raw request sent to the server.
RawResponseReturns the full response.
ResponseVersionReturns the Version number contained in the response.
VersionAllows the user to set the Version number in the request.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0