Skip to main content
GET
/
{prefix}
/
{entityId}
/
insights
/
accounts-receivable
Get accounts receivable
curl --request GET \
  --url https://api.syntage.com/{prefix}/{entityId}/insights/accounts-receivable \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "nonCumulative": [
      {
        "metric": 50000,
        "label": "Due",
        "startDate": "2024-01-01T00:00:00.000Z"
      }
    ],
    "cumulative": [
      {
        "metric": 150000,
        "label": "Cumulative Due",
        "startDate": "2024-01-01T00:00:00.000Z"
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
prefix
enum<string>
required

Resource prefix (taxpayers or entities)

Available options:
taxpayers,
entities
Example:

"entities"

​
entityId
required

Entity identifier. Use UUID when prefix is 'entities', or RFC (Taxpayer ID) when prefix is 'taxpayers'.

RFC (Taxpayer ID) - use with prefix 'taxpayers'

Required string length: 12 - 13
Example:

"XAXX010101000"

Query Parameters

​
options[from]
string<date-time>
default:2014-01-01T00:00:00.000Z

Filter by invoice issuing date (greater than)

​
options[to]
string<date-time>
default:now

Filter by invoice issuing date (less than)

​
options[periodicity]
enum<string>
default:monthly

The data set is grouped by this field

Available options:
daily,
weekly,
monthly,
quarterly,
yearly

Response

Accounts Receivable

​
data
object