stub
  • Introduction
  • API basics
  • Setting up API access
  • API Documentation
    • Authentication Tokens
    • Push data
    • Pull data
  • SDK Documentation
    • Embedded accounting
    • Custom Styling
    • Reference
Powered by GitBook
On this page
  1. API Documentation

Pull data

PreviousPush dataNextEmbedded accounting

Last updated 11 months ago

Pull businesses linked to email

Check businesses linked to an email account.

Asynchronously pull insights

The financial insights for the specified business will be returned to the specified webhook.

Asynchronously pull expense

The expenses for the specified business will be returned to the specified webhook.

Asynchronously pull income

Income for the specified business will be returned to the specified webhook.

Trigger bank sync

Sync bank accounts for the specified business if available.

Page cover image
  • Pull businesses linked to email
  • POST/api/pull/business
  • Asynchronously pull insights
  • POST/api/pull/insights
  • Asynchronously pull expense
  • POST/api/pull/expenses
  • Asynchronously pull income
  • POST/api/pull/income
  • Trigger bank sync
  • POST/api/pull/bank-feed
post
Body
apikeystringRequired
appidstringRequired
emailstringRequired
Responses
post
POST /api/pull/business HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "apikey": "text",
  "appid": "text",
  "email": "text"
}
No content
post
Body
apikeystringRequired
appidstringRequired
uidstringRequired
webhookstringRequired
signaturestringOptional
Responses
post
POST /api/pull/insights HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "apikey": "text",
  "appid": "text",
  "uid": "text",
  "webhook": "text",
  "signature": "text"
}
No content
post
Body
apikeystringRequired
appidstringRequired
uidstringRequired
webhookstringRequired
signaturestringOptional
Responses
post
POST /api/pull/expenses HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "apikey": "text",
  "appid": "text",
  "uid": "text",
  "webhook": "text",
  "signature": "text"
}
No content
post
Body
apikeystringRequired
appidstringRequired
uidstringRequired
webhookstringRequired
signaturestringOptional
Responses
post
POST /api/pull/income HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "apikey": "text",
  "appid": "text",
  "uid": "text",
  "webhook": "text",
  "signature": "text"
}
No content
post
Body
apikeystringRequired
appidstringRequired
uidstringRequired
webhookstringOptional
signaturestringOptional
Responses
post
POST /api/pull/bank-feed HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "apikey": "text",
  "appid": "text",
  "uid": "text",
  "webhook": "text",
  "signature": "text"
}
No content