BBAPI: ProcessOrders Command
This command processes an order into an invoice or invoices where appropriate. When an order is placed, the order may contain products on recurring billing cycles. Therefore, the order must generate invoices on appropriate intervals so that the client can be charged on a recurring basis. Even if the products in the order are all a one time charge, an invoice must still be created for the order to be charged to a billing account.
On This Page:
Available Commands
ProcessOrders
Finds all orders (or can perform a search for specific ones) that invoices need to be generated for. Will automatically create any and all invoices for found orders and mark the invoice status as due. Due date for the invoice(s) are automatically calculated.
Example 1: Input
After an order is inserted into the system using the SetOrders command, a follow-up command should be sent to process the order. Typically the orderID of the order is passed along so that only one order is processed (greatly increasing performance) as opposed to scanning all orders.
Example 1: Response
The API will return 0 or more invoices that were generated. A single order may generate more than one invoice. This happens if the order contains products with mixed billing cycles (ie. one product bills monthly another is a one time charge). Each invoice will represent a billing cycle. So if your order contains products with two different billing cycles, two invoices will be created.
If you are probing the system to find past orders on recurring billing cycles that may need invoices generated, the system will only generate invoices that will have due dates within the specified amount of hours in the future. Store owners can change the specified amount of hours to generate invoices prior to their due date from within their admin panel under the settings tab.
Summary of Nodes
The nodes returned in this command are the exact same as the ones returned when calling GetInvoices. See the GetInvoices nodes for more information.
The nodes that can be sent to filter orders are the exact same as the ones shown in the GetOrders command.