GET DeletedEntities

Get deleted entities.

Request Information

URI Parameters

Name Description Type Additional information
Page Specifies the page number of the result set to return. integer

None.

PageSize Specifies the number of records on each page of results. Maximum page size is 100. Defaults to 25 if not specified. integer

None.

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

EntityType Filter records by Entity Type. Valid types are Sale, Purchase, SalePayment, PurchasePayment, Item, Contact, Journal. string

None.

UtcDeletedFromDate Filter records with Deletion Date greater than or equal to a date in UTC. UtcDeletedToDate must also be specified. If filter not used, defaults to 24 hours before current UTC date. string

None.

UtcDeletedToDate Filter records with Deletion Date less than or equal to a date in UTC. UtcDeletedFromDate must also be specified. If filter not used, defaults to current UTC date. string

None.

Body Parameters

None.

Response Information

Resource Description

DeletedEntitiesListResponse
Name Description Type Additional information
Entities List of deleted entities. Collection of DeletedEntityDetail

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:
{
  "Entities": [
    {
      "EntityType": "Sale",
      "EntityId": 111,
      "DeletedByUser": "someone@test.com",
      "Timestamp": "2017-04-16T09:17:16.140748Z",
      "_links": []
    },
    {
      "EntityType": "Purchase",
      "EntityId": 222,
      "DeletedByUser": "someone@test.com",
      "Timestamp": "2017-04-16T09:17:16.140748Z",
      "_links": []
    }
  ],
  "_links": [
    {
      "rel": "self",
      "href": "https://api.saasu.com/DeletedEntities?FileId=123",
      "method": "GET",
      "title": null
    },
    {
      "rel": "next",
      "href": "https://api.saasu.com/DeletedEntities?FileId=123&Page=2&PageSize=25",
      "method": "GET",
      "title": null
    }
  ]
}

application/xml, text/xml

Sample:
<DeletedEntitiesListResponse 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/DeletedEntities?FileId=123</href>
      <method>GET</method>
    </Link>
    <Link>
      <rel>next</rel>
      <href>https://api.saasu.com/DeletedEntities?FileId=123&amp;Page=2&amp;PageSize=25</href>
      <method>GET</method>
    </Link>
  </_links>
  <Entities>
    <DeletedEntityDetail>
      <_links />
      <EntityType>Sale</EntityType>
      <EntityId>111</EntityId>
      <DeletedByUser>someone@test.com</DeletedByUser>
      <Timestamp>2017-04-16T09:17:16.140748Z</Timestamp>
    </DeletedEntityDetail>
    <DeletedEntityDetail>
      <_links />
      <EntityType>Purchase</EntityType>
      <EntityId>222</EntityId>
      <DeletedByUser>someone@test.com</DeletedByUser>
      <Timestamp>2017-04-16T09:17:16.140748Z</Timestamp>
    </DeletedEntityDetail>
  </Entities>
</DeletedEntitiesListResponse>