Help Page Home - Invoices
POST Invoice/id/email-contact
Email an invoice to the billing contact.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| WsAccessKey | The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. | string |
Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred. |
| FileId | Specifies the file id of the file to perform the operation upon. | integer |
Required |
| id | Invoice Id (Transaction Id) | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
InvoiceEmailResult| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceId | The Id of the emailed invoice. | integer |
None. |
| StatusMessage | Status message from the response (if any). | string |
None. |
| _links | Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. | Collection of Link |
None. |
Response Formats
application/json, text/json
Sample:
{
"InvoiceId": 123,
"StatusMessage": "Invoice has been emailed.",
"_links": [
{
"rel": "detail",
"href": "https://api.saasu.com/Invoice/123?FileId=1234",
"method": "GET",
"title": null
},
{
"rel": "self",
"href": "https://api.saasu.com/Invoice/123/email/?FileId=1234",
"method": "GET",
"title": null
}
]
}
application/xml, text/xml
Sample:
<InvoiceEmailResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<_links>
<Link>
<rel>detail</rel>
<href>https://api.saasu.com/Invoice/123?FileId=1234</href>
<method>GET</method>
</Link>
<Link>
<rel>self</rel>
<href>https://api.saasu.com/Invoice/123/email/?FileId=1234</href>
<method>GET</method>
</Link>
</_links>
<StatusMessage>Invoice has been emailed.</StatusMessage>
<InvoiceId>123</InvoiceId>
</InvoiceEmailResult>