JSON API » invoices » invoices/send
Sends invoices to customers.
Input parameters
Requires authentication and the commerce role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
reseller | Integer | ID of reseller owning invoices. | No | Customer of authentication user. |
status | String | Send invoices with this status. "approved", "queued", or "both". | No | "approved" |
Responses
Code | Description |
---|---|
200 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
Data returned
Number of invoices sent.
Example: With required parameters
http://enswitch.example.com/api/json/invoices/send/?auth_username=user;auth_password=password{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":3 } }
Change history
Version | Changes |
---|---|
3.13 | Function added. |