DELETE Invoice/id

Delete an invoice.

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 integer

Required

Body Parameters

None.

Response Information

Resource Description

BaseResponseModel
Name Description Type Additional information
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:
{
  "StatusMessage": "Status message if applicable",
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/Invoice?FileId=123",
      "method": "DELETE",
      "title": null
    },
    {
      "rel": "list",
      "href": "https://api.saasu.com/Invoices?FileId=123&",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:
<DeleteResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>self</rel>
      <href>https://api.saasu.com/Invoice?FileId=123</href>
      <method>DELETE</method>
    </Link>
    <Link>
      <rel>list</rel>
      <href>https://api.saasu.com/Invoices?FileId=123&amp;</href>
      <method>GET</method>
    </Link>
  </_links>
  <StatusMessage>Status message if applicable</StatusMessage>
</DeleteResponse>