GET
/
insights
/
{id}
/
cash-flow
Get cash flow
curl --request GET \
  --url https://api.syntage.com/insights/{id}/cash-flow \
  --header 'X-API-Key: <api-key>'
[
  {
    "type": "inflow",
    "date": "<any>",
    "currency": "<any>",
    "transactions": "6",
    "amount": 5938.88,
    "mxnAmount": 114638.76
  }
]

Authorizations

​
X-API-Key
string
header
required

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

Path Parameters

​
id
string
required

RFC (Registro Federal de Contribuyentes)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

Query Parameters

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

The data set is grouped by this field

Available options:
daily,
weekly,
monthly,
quarterly,
yearly
​
options[type]
enum<string>
default:total

Group series by type

Available options:
total,
payment-method,
currency,
invoice-type
​
options[from]
string<date-time>
default:2014-01-01T00:00:00.000Z

Filter by issuing date (greater than)

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

Filter by issuing date (less than)

Response

Taxpayer cash flow

​
type
enum<string>

Used to identify the flow

Available options:
inflow,
outflow
Example:

"inflow"

​
date
any

It could be in different formats, for daily data "YYYY-mm-dd", for quarterly "YYYY/QX" for monthly data YYYY-M" and for weekly "YYYY-W".

​
currency
any

Currency symbol such as MXN, USD or MXV

​
transactions
string

Number of invoices processed to get this record

Example:

"6"

​
amount
number

Total amount in the defined currency

Example:

5938.88

​
mxnAmount
number

If the currency is different to MXN this is the amount converted to MXN using the exchange rate value when the invoice was issued.

Example:

114638.76