Description
Executes the pending actions against the specified Invoice Ids. You can also specify whether the Invoices need to be cancelled or kept pending.
Parameters
Name | Data Type | Required / Optional | Description |
---|---|---|---|
auth-userid | Integer | Required | Authentication Parameter |
api-key | String | Required | Authentication Parameter |
invoice-ids | Array Of Integer | Required | Invoice Ids whose associated pending actions are to be executed |
cancel-invoice | Boolean | Required |
Indicates whether the Invoice needs to be cancelled or kept pending. Values can either be:
|
HTTP Method
POST
Example Test URL Request
https://test.httpapi.com/api/billing/execute-order-without-payment.xml?auth-userid=0&api-key=key&invoice-ids=0&invoice-ids=1&cancel-invoice=true
Response
Returns a hash map of executed actions containing the below details:
-
Invoice Id (invoiceid)
-
Order Id associated with the Invoice (51821176)
-
Customer Id associated with the Invoice (customerid)
-
Action Id of the Action associated with the Invoice (eaqid)
-
Action Type of the Action associated with the Invoice (actiontype)
-
Description of the Action associated with the Invoice (actiontypedesc)
-
Domain Name (description)
-
Status of the Action associated with the Invoice (actionstatus)
-
Description of the Action Status (actionstatusdesc)
-
Selling Currency Symbol of the Parent Reseller (sellingcurrencysymbol)
-
Transaction Amount in the Selling Currency (sellingamount)
-
Unutilised Transaction Amount in the Selling Currency (unutilisedsellingamount)
-
In case of any errors, a status key with value as ERROR alongwith an error message will be returned.