Sinao API API

by sinao.app

HTTP BasicHTTPSFinance

Overview

Sinao API for account management, apps administration and network exploration

Sinao API is a finance API from sinao.app. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 272 endpoints.

At a glance

Authentication: HTTP Basic
HTTPS: Yes
CORS: Unknown
Category: Finance
Base URL: https://api.sinao.app/v1
Version: 1.1.0
Endpoints: 272
OpenAPI: Specification ↗
Spec updated: 2023-03-24

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.sinao.app/v1/apps" \
  -H "Accept: application/json" \
  -H "Authorization: Basic BASE64_USER_PASSWORD"

JavaScript

const response = await fetch("https://api.sinao.app/v1/apps", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.sinao.app/v1/apps",
    headers={
    "Accept": "application/json",
    "Authorization": "Basic BASE64_USER_PASSWORD",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/apps`	List apps
POST	`/apps`	Create an app
GET	`/apps/access/invite/{accessToken}`	Get invitation informations
DELETE	`/apps/access/invite/{accessToken}`	Delete an invitation from token
POST	`/apps/access/invite/{accessToken}/register`	Create an User by invitation
GET	`/apps/{appId}`	Get an app
GET	`/apps/{appId}/access`	Get policies for an app
GET	`/apps/{appId}/access/invite`	List invitations
POST	`/apps/{appId}/access/invite`	Invite an user
DELETE	`/apps/{appId}/access/invite/{id}`	Delete an invitation
GET	`/apps/{appId}/access/profiles`	Get profiles
GET	`/apps/{appId}/access/{userId}`	Get police for an user
POST	`/apps/{appId}/access/{userId}`	Update police for an user
DELETE	`/apps/{appId}/access/{userId}`	Delete police for an user
GET	`/apps/{appId}/accountcategories/`	List categories
POST	`/apps/{appId}/accountcategories/`	Create a category
GET	`/apps/{appId}/accountcategories/{id}`	Get a category
POST	`/apps/{appId}/accountcategories/{id}`	Update a category
DELETE	`/apps/{appId}/accountcategories/{id}`	Remove a category
GET	`/apps/{appId}/accounting_entries/`	List accounting entries
GET	`/apps/{appId}/accounts/`	List Account
POST	`/apps/{appId}/accounts/`	Create a Account
POST	`/apps/{appId}/accounts/batch`	Create many accounts
GET	`/apps/{appId}/accounts/{id}`	Get a Account
POST	`/apps/{appId}/accounts/{id}`	Update a Account
DELETE	`/apps/{appId}/accounts/{id}`	Remove a Account
GET	`/apps/{appId}/apikeys`	Get all api keys
POST	`/apps/{appId}/apikeys`	Create new API key
DELETE	`/apps/{appId}/apikeys/{id}`	Remove an api key
GET	`/apps/{appId}/apipartners`	Get all api parners
GET	`/apps/{appId}/attachments`	List attachments
POST	`/apps/{appId}/attachments`	Attach a file on an object
PUT	`/apps/{appId}/attachments`	Recreate S.A.P attestations
GET	`/apps/{appId}/attachments/download`	Download a list of attachments in pdf into a .zip file
GET	`/apps/{appId}/attachments/sap-download`	Download a list of SAP attestations in pdf into a .zip file
GET	`/apps/{appId}/attachments/{id}`	Get attachment by id
DELETE	`/apps/{appId}/attachments/{id}`	Detach a file from id
GET	`/apps/{appId}/attachments/{id}/pdf`	Download the attachment as pdf
GET	`/apps/{appId}/bankdetails`	List BankDetails
POST	`/apps/{appId}/bankdetails`	Create a BankDetails
GET	`/apps/{appId}/bankdetails/{id}`	Get a BankDetails
POST	`/apps/{appId}/bankdetails/{id}`	Update a BankDetails
DELETE	`/apps/{appId}/bankdetails/{id}`	Remove a BankDetails
GET	`/apps/{appId}/banks/`	List banks connected to bankin
DELETE	`/apps/{appId}/banks/`	Remove a Bankin synchronization
GET	`/apps/{appId}/banks/connect`	Get the link to the funnel to connect a bank with Sinao
POST	`/apps/{appId}/banks/synchronize`	Triggers synchronization at Bankin then synchronizes transactions with Sinao
GET	`/apps/{appId}/banks/{id}/funnel/edit`	Get the link to the funnel to edit password
GET	`/apps/{appId}/banks/{id}/funnel/sync`	Get the link to the funnel to start manually a synchronization (SCA)
GET	`/apps/{appId}/banks/{id}/funnel/validate`	Get the link to the funnel to validate a pro item (SCA)
POST	`/apps/{appId}/banks/{id}/select_accounts`	Select accounts to synchronize
GET	`/apps/{appId}/cashflowsources/`	List CashflowSource
POST	`/apps/{appId}/cashflowsources/`	Create a CashflowSource
GET	`/apps/{appId}/cashflowsources/{id}`	Get a CashflowSource
POST	`/apps/{appId}/cashflowsources/{id}`	Update a CashflowSource
DELETE	`/apps/{appId}/cashflowsources/{id}`	Remove a CashflowSource
POST	`/apps/{appId}/contacts/merge`	Merge many contacts
POST	`/apps/{appId}/email/batch`	Send emails
POST	`/apps/{appId}/email/document`	Send an email
GET	`/apps/{appId}/establishments/{id}`	Get an establishment
POST	`/apps/{appId}/establishments/{id}`	Update an establishment
DELETE	`/apps/{appId}/establishments/{id}`	Remove an establishment
GET	`/apps/{appId}/exports`	List ExportEntity
POST	`/apps/{appId}/exports`	Create a ExportEntity
GET	`/apps/{appId}/exports/acd_compta`	Get the ACD UUID for authentification
POST	`/apps/{appId}/exports/acd_compta`	Register ACD identifiants
GET	`/apps/{appId}/exports/download`	Download the export entity as zip
GET	`/apps/{appId}/exports/months`	List ExportEntity
GET	`/apps/{appId}/exports/{id}`	Get a ExportEntity
DELETE	`/apps/{appId}/exports/{id}`	Remove a ExportEntity
GET	`/apps/{appId}/invoices`	List invoices
POST	`/apps/{appId}/invoices`	Create an invoice
POST	`/apps/{appId}/invoices/batch`	Create or update many invoices
DELETE	`/apps/{appId}/invoices/batch`	Delete many invoices
GET	`/apps/{appId}/invoices/download`	Download a list of invoices in pdf into a .zip file
POST	`/apps/{appId}/invoices/fresh`	Regenerate pdf and recalcul amounts of invoice
GET	`/apps/{appId}/invoices/nextnumber`	Get the next invoice number for preview
GET	`/apps/{appId}/invoices/statistics`	Obtain statistics about invoices
GET	`/apps/{appId}/invoices/{id}`	Get an invoice
POST	`/apps/{appId}/invoices/{id}`	Update an invoice
DELETE	`/apps/{appId}/invoices/{id}`	Remove an invoice
POST	`/apps/{appId}/invoices/{id}/attach`	Attach a file at an invoice
DELETE	`/apps/{appId}/invoices/{id}/attach`	Detach a file at an invoice
POST	`/apps/{appId}/invoices/{id}/avoid`	Create a creditnote on an invoice
POST	`/apps/{appId}/invoices/{id}/duplicate`	Duplicate an invoice
POST	`/apps/{appId}/invoices/{id}/finalize`	Finalize an invoice
GET	`/apps/{appId}/invoices/{id}/pdf`	Download the invoice as pdf
GET	`/apps/{appId}/invoices/{id}/preview.jpg`	Download invoice as jpeg
POST	`/apps/{appId}/invoices/{id}/tag`	Add a tag on an invoice
DELETE	`/apps/{appId}/invoices/{id}/tag`	Delete a tag on an invoice
POST	`/apps/{appId}/invoices/{id}/updatestatus`	Update the status of an invoice
GET	`/apps/{appId}/logs/autoreconcile/`	List autoreconciliation logs
POST	`/apps/{appId}/logs/autoreconcile/`	Start force autoreconciliation
DELETE	`/apps/{appId}/logs/autoreconcile/`	Clear autoreconciliation logs
GET	`/apps/{appId}/organization`	Get organization profile for current app
POST	`/apps/{appId}/organization`	Update organization profile for current app
GET	`/apps/{appId}/organizations`	List organizations
POST	`/apps/{appId}/organizations`	Create an organization
POST	`/apps/{appId}/organizations/batch`	Create multiple organizations
GET	`/apps/{appId}/organizations/{id}`	Get an organization