Skip to main content
GET
/
entities
/
{entityId}
/
insights
/
metrics
/
vendor-network
Get vendor network insight
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/insights/metrics/vendor-network \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/GetVendorNetwork",
  "@id": "/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/vendor-network",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "vendor": "Apple",
      "totalReceived": "15928890.28",
      "totalCancelledReceived": "0.00",
      "percentageCancelled": "0.0000",
      "receivedDiscounts": "963836.78",
      "receivedCreditNotes": "897457.12",
      "receivedPaymentPending": "0.00",
      "netReceived": "14067696.38",
      "pueReceived": "15928890.28",
      "ppdReceived": "0.00",
      "ppdCount": 0,
      "paymentAmount": "0.00",
      "collectedInInstallments": "0.0000",
      "daysPayableOutstanding": "0.00"
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:first": "<string>",
    "hydra:next": "<string>",
    "hydra:last": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Path Parameters

​
entityId
string<uuid>
required

Response

Success

​
@context
string
default:/contexts/GetVendorNetwork
​
@id
string
Example:

"/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/vendor-network"

​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:totalItems
integer

The total number of items found

Required range: x >= 0
Example:

1

​
hydra:view
object

Pagination information