BBAPI: ProcessInvoices Command
Process an invoice so that funds are attempted to be charged to the clients account. Only due invoices are attempted. Parameters can be passed into the system so that only specified invoices are processed.
On This Page:
Available Commands
ProcessInvoices
Finds all due invoices and attempts to process them to collect funds.
Example 1: Input
The below example shows how to process an invoice in order to collect funds. You can pass in an invoiceID to process only one invoice (as shown below).
If a billing account record is not passed in, an account will be attempted to be grabbed from the client record. The system will first look for a default billing account and will then look for the most recently added account. If no billing account is found, a manually billing account is created for the client.
Example 1: Response
The response will contain the invoice details including the items in the invoice and all memos to date for the invoice. The most recent memo will show the results of the transaction.
Summary of Nodes
The nodes passed to and received from when using this command are the same as the ones in the Set and GetInvoices command. See this command for the details of the nodes.
Node |
Type | Description |
|---|---|---|
| processNow | Char | Force the invoice to be processed now. Set to 'y' if you wish to force processing. |
| amount | Double | Amount to charge on invoice. This is equivalent to a partial payment. Invoice will remain due until the amount owed is 0 or less. |
account |
XML | Billing account node to use when processing the invoice |
| clientBillingAccountID | Integer | Unique ID reference to a saved client's billing account. |
| cardNumber | String | Credit card number |
| cardName | String | Name found on card. |
| cardType | String | Type of credit card. ie. visa, mastercard, etc. |
| cardConfirmation | String | Confirmation numbers found on back of card. |
| cardMonth | Integer | Expiration month of card. |
| cardYear | Integer | Expiration year of card. |