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

Invoice Bean

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 bean with short descriptions. Click on the links for further details.

AckAcknowledgement code received from PayPal.
ApplicationIdYour application's identification, which is issued by PayPal.
BillingInfoThe billing information for the current invoice.
CancellationInfoThe information used to describe an invoice cancellation.
CurrencyCodeCurrency code used for all invoice item amounts and totals.
DeviceIPClient's IP address.
FirewallA set of properties related to firewall access.
IdleThe current status of the component.
InvoiceDetailsThe details about an invoice.
InvoiceInfoThe information about an invoice.
InvoiceItemsThis is the collection of items included on the invoice.
MerchantInfoThe merchant information for the current invoice.
PasswordPassword for communicating with PayPal.
PaymentInfoThe information used to describe a payment when marking an invoice as paid.
ProxyA set of properties related to proxy access.
ResponseThe response received when creating or updating an invoice.
SearchCriteriaSet this to the criteria to search for.
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.
SearchResultsThe invoice summaries returned by PayPal's search.
ShippingInfoThe shipping information for the current invoice.
SignatureValue to use with PayPal's Signature Authentication scheme.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
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 bean 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 bean 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 bean 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