Skip to main content
GET
/
entities
/
{entityId}
/
insights
/
metrics
/
invoicing-annual-comparison
Get invoicing annual comparison insight
curl --request GET \
  --url https://api.syntage.com/entities/{entityId}/insights/metrics/invoicing-annual-comparison \
  --header 'X-API-Key: <api-key>'
{
  "@context": "/contexts/GetInvoicingAnnualComparison",
  "@id": "/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/invoicing-annual-comparison",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "period": "2021",
      "totalIncome": "161227.35",
      "incomePaymentPending": "24206.10",
      "totalIncomeCancelled": "0.00",
      "incomeDiscounts": "11754.18",
      "incomeCreditNotes": "0.00",
      "netIncome": "125267.06",
      "incomeDueUponReceipt": "0.0051",
      "incomeDueOverTime": "0.9949",
      "collectedIncomeDueOverTime": "0.8596",
      "totalExpenses": "120439.39",
      "receivedPaymentPending": "26514.75",
      "totalExpensesCancelled": "0.00",
      "expensesDiscounts": "5670.48",
      "expensesCreditNotes": "0.00",
      "payroll": "0.00",
      "netExpensesPlusPayroll": "88254.16",
      "margin": "0.2955",
      "expensesDueUponReceipt": "0.3511",
      "expensesDueOverTime": "0.6489",
      "paidExpensesDueOverTime": "0.0193",
      "daysPayableOutstanding": "14.00",
      "daysSalesOutstanding": "-1.33",
      "netExpenses": "88254.16",
      "profitOrLoss": "37012.90"
    }
  ],
  "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/GetInvoicingAnnualComparison
​
@id
string
Example:

"/entities/9bd4a640-9f41-4cd5-a158-20767b386ca0/insights/metrics/invoicing-annual-comparison"

​
@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