Deal File References

The Deal File References API allows you to manage the relationship between the deal and first and third party deal file systems.

The Deal File References Resource

Properties

Name
deal_id
Required
Type
integer
Description
The ID of the deal for this deal step.
Name
provider
Required
Type
string
Description
Machine friendly name for the deal file provider.
Name
provider_reference
Required
Type
string
Description
The reference of the deal provided by the external deal file platform.
Name
dates
Required
Type
object
Description
Name
created_at
Required
Type
datetime
Description
The date the deal file record was created, represented in YYYY-MM-DD HH:MM:SS format
Name
updated_at
Required
Type
datetime
Description
The date the deal file record was last updated, represented in YYYY-MM-DD HH:MM:SS format
Name
deleted_at
Required
Type
null | datetime
Description
The date the deal file record was deleted, represented in YYYY-MM-DD HH:MM:SS format. If the deal file is not deleted, this will be null

Deal File Resource

{
  "deal_id": 12345,
  "provider": "edf",
  "provider_reference": "12345",
  "dates": {
    "created_at": "2024-01-01 00:00:00",
    "updated_at": "2024-01-02 12:00:00",
    "deleted_at": null,
  }
}

GET/v2/deal-file/references

Search References

The search references endpoint uses the standard Search package from the SDK.

An array of deal file reference resources are returned. If no results are found, an empty collection is returned.

Search Filters

Name
filters.deal.equals
Required
Type
integer
Description
Match customer by a deal ID
Name
filters.deal.in
Required
Type
array<integer>
Description
Match customers by multiple deal IDs
Name
filters.provider.equals
Required
Type
string
Description
Match reference records by provider
Name
filters.provider.in
Required
Type
array<string>
Description
Match reference records by multiple providers
Name
filters.reference.equals
Required
Type
string
Description
Match reference records by provider reference
Name
filters.reference.in
Required
Type
array<string>
Description
Match reference records by multiple provider references
Name
filters.deleted.equals
Required
Type
bool
Description
To return only deleted records, provide true. To return only non-deleted records, provide false. Not including this filter will return both deleted and active references.

Search Ordering

id
deal / deal_id
provider
provider_reference / reference
created_at / created
updated_at / updated
deleted_at / deleted

Request

GET

/v2/deal-file/references

use Compliance\Sdk\ApexV3\Contracts\ApexV3SdkInterface;
use Compliance\Sdk\Authentication\Types\Machine;
use Compliance\Sdk\Search\Search;

private ApexV3SdkInterface $sdk;

$search = new Search();

$response = $this->sdk
  ->v2(new Machine())
  ->dealFile()
  ->references()
  ->search($search);

Response

{
  "data": [
    {
      "deal_id": 12345,
      "provider": "edf",
      "provider_reference": "12345",
      "dates": {
        "created_at": "2024-01-01 00:00:00",
        "updated_at": "2024-01-02 12:00:00",
        "deleted_at": null,
      }
    }
  ]
}