JSON API » invoices » invoices/send

Sends invoices to customers.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
resellerIntegerID of reseller owning invoices.NoCustomer of authentication user.
statusStringSend invoices with this status. "approved", "queued", or "both".No"approved"

Responses

CodeDescription
200Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your 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

VersionChanges
3.13Function added.