Sinao API
Sinao API for account management, apps administration and network exploration
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Sinao API for account management, apps administration and network exploration
Endpoints 272
Applications
- GETList apps
/apps?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get all apps - GETGet an app
/apps/:appIdGet app informations - GETGet all api keys
/apps/:appId/apikeys?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate new API key
/apps/:appId/apikeys?name=string&api_partner_id=0 - DELETERemove an api key
/apps/:appId/apikeys/:id - GETGet all api parners
/apps/:appId/apipartners?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - GETGet app config
/apps/:appId/settings?key=stringGet a configuration variable by key - POSTUpdate app config
/apps/:appId/settings?settings={"accounting.export.journals.VE":"VE","accounting.template.color-primary":"#003B51"}&key=string&value=stringGeneral settings of an app. Can be modified in app
hidden
- POSTCreate an app
/apps?organization_name=stringCreate a new App with their organization profile - GETGet invitation informations
/apps/access/invite/:accessTokenGet infos of an invitation request. Returns an AccessInvitation object - DELETEDelete an invitation from token
/apps/access/invite/:accessTokenRemove an invitation from token - POSTCreate an User by invitation
/apps/access/invite/:accessToken/register?password=string&firstname=string&lastname=string&cgu=trueRegistration for an invited user - GETGet policies for an app
/apps/:appId/access?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get all policies for an app. Manage access for users - GETList invitations
/apps/:appId/access/invite?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get all sent invitations - POSTInvite an user
/apps/:appId/access/invite?email=string&policy_profile_id=0&firstname=string&lastname=string&civility=string&password=stringInvites a user to access the organization panel - DELETEDelete an invitation
/apps/:appId/access/invite/:idRemove an invitation - GETGet profiles
/apps/:appId/access/profilesGet all profiles - GETGet police for an user
/apps/:appId/access/:userIdFind policy profile for an user on an app - POSTUpdate police for an user
/apps/:appId/access/:userId?policy_profile_id=0Update police for an user on an app - DELETEDelete police for an user
/apps/:appId/access/:userIdCancel access for an user on an app - POSTCreate many accounts
/apps/:appId/accounts/batch?data={"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"}Create many accounts - GETList banks connected to bankin
/apps/:appId/banks/ - DELETERemove a Bankin synchronization
/apps/:appId/banks/?item_id=0The deletion of the account is irreversible, it will not be possible to resume synchronization as it is afterwards. - If transactions have been exported to… - GETGet the link to the funnel to connect a bank with Sinao
/apps/:appId/banks/connect - POSTTriggers synchronization at Bankin then synchronizes transactions with Sinao
/apps/:appId/banks/synchronize?id=0&is_incremential=true - GETGet the link to the funnel to edit password
/apps/:appId/banks/:id/funnel/edit - GETGet the link to the funnel to start manually a synchronization (SCA)
/apps/:appId/banks/:id/funnel/sync - GETGet the link to the funnel to validate a pro item (SCA)
/apps/:appId/banks/:id/funnel/validate - POSTSelect accounts to synchronize
/apps/:appId/banks/:id/select_accounts?bank_account_ids=0 - POSTMerge many contacts
/apps/:appId/contacts/merge?contacts={"id":0,"type":"organization"} - GETList autoreconciliation logs
/apps/:appId/logs/autoreconcile/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTStart force autoreconciliation
/apps/:appId/logs/autoreconcile/ - DELETEClear autoreconciliation logs
/apps/:appId/logs/autoreconcile/ - GETPing app web hostname
/apps/:appId/pingTry if a specific app is online - GETList product categories
/apps/:appId/productcategory?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get list of product categories - POSTCreate a product category
/apps/:appId/productcategory?name=string&image=&parent_category_id=0Create a new product category - GETGet a product category
/apps/:appId/productcategory/:idGet a Product category object by Id - POSTUpdate a product category
/apps/:appId/productcategory/:id?name=string&image=&parent_category_id=0Update a product category by id - DELETERemove a product category
/apps/:appId/productcategory/:idRemove a product category by id - GETList RecurringInvoice
/apps/:appId/recurringinvoices?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a RecurringInvoice
/apps/:appId/recurringinvoices?contact_infos={"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"}&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"}¤cy=string&legal_notice=string&bank_details_id=0&vat_exemption={"article":"string","exempted":true,"reason":"string"}&tags=&metadata=&payment_period=30&next_invoice_at=2024-01-01T00:00:00Z&end_at=2024-01-01T00:00:00Z&frequency_count=0&frequency_duration=day&discount=0&discount_mode=percent&discount_start_at=2024-01-01T00:00:00Z&discount_end_at=2024-01-01T00:00:00Z&details=string&orders_plan={"end_at":"2024-01-01T00:00:00Z","model":0} - POSTCreate or update many RecurringInvoice
/apps/:appId/recurringinvoices/batch?data={"attachments":["https://example.com"],"author":{"civility":"string","establishments":[{"emails":[],"id":0,"name":"string","nic":"string","phones":[],"place":{"administrative_area_level1":null,"administrative_area_level2":null,"administrative_area_level3":null,"country":null,"countryiso2":null,"formatted_address":null,"id":null,"latitude":null,"locality":null,"longitude":null,"postal_code":null,"route":null,"route2":null,"street_number":null,"sublocality":null}}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[{"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":null,"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":null,"name":null,"parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":null,"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":null,"description":null,"editable":null,"id":null,"is_associate":null,"is_cashflow":null,"is_purchase":null,"is_sales":null,"is_various":null,"journalcode":null,"keywords":null,"name":null,"need_charge":null,"need_employee":null,"need_invoice":null,"technical_name":null},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}],"currency":"string","customer":{"civility":"string","establishments":[{"emails":null,"id":null,"name":null,"nic":null,"phones":null,"place":null}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[]},"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"}Create or update many RecurringInvoice - DELETEDelete many RecurringInvoice
/apps/:appId/recurringinvoices/batch?ids=0Delete many RecurringInvoice - GETGet json of periods_formats for a date.
/apps/:appId/recurringinvoices/periods?date=2024-01-01T00:00:00ZGet json of periods_formats for a date. If request parameter date is null, returns periods_formats for today. - GETGet a RecurringInvoice
/apps/:appId/recurringinvoices/:id - POSTUpdate a RecurringInvoice
/apps/:appId/recurringinvoices/:id?contact_infos={"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"}&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"}¤cy=string&legal_notice=string&bank_details_id=0&vat_exemption={"article":"string","exempted":true,"reason":"string"}&tags=&metadata=&payment_period=30&next_invoice_at=2024-01-01T00:00:00Z&end_at=2024-01-01T00:00:00Z&frequency_count=0&frequency_duration=day&discount=0&discount_mode=percent&discount_start_at=2024-01-01T00:00:00Z&discount_end_at=2024-01-01T00:00:00Z&details=string&orders_plan={"end_at":"2024-01-01T00:00:00Z","model":0} - DELETERemove a RecurringInvoice
/apps/:appId/recurringinvoices/:id - GETPreview next invoices generations
/apps/:appId/recurringinvoices/:id/plan?until=2024-01-01T00:00:00Z - POSTReset all data
/apps/:appId/resetReset everything - GETList rules
/apps/:appId/rules/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a rule
/apps/:appId/rules/?conditions=string&on_event=transaction.created¶meter=account&value=64&priority=0 - POSTExecute all rules
/apps/:appId/rules/execute_on?model=transaction - GETGet a rule
/apps/:appId/rules/:id - POSTUpdate a rule
/apps/:appId/rules/:id?conditions=string&on_event=transaction.creating¶meter=account&value=64&priority=0 - DELETERemove a rule
/apps/:appId/rules/:id - GETList sales documents models
/apps/:appId/salesdocumentmodels?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a sales document model
/apps/:appId/salesdocumentmodels?name=string&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"} - GETGet a sales document model
/apps/:appId/salesdocumentmodels/:id - POSTUpdate a sales document model
/apps/:appId/salesdocumentmodels/:id?name=string&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"} - DELETERemove a sales document model
/apps/:appId/salesdocumentmodels/:id - GETPing Stripe webhook endpoint
/apps/:appId/services/stripe/webhook - POSTWebhook for Stripe
/apps/:appId/services/stripe/webhook - POSTWebhook for Yousign
/apps/:appId/services/yousign/webhook - POSTUpdate anchor date
/apps/:appId/subscription/anchordate - GETGet payment link to Stripe Checkout
/apps/:appId/subscription/checkout_add_source - POSTAdd coupon
/apps/:appId/subscription/coupon?code=string - POSTExtend trial period
/apps/:appId/subscription/extend_trial - POSTEnable plan
/apps/:appId/subscription/extra/:stripe_plan - POSTPay all due invoices
/apps/:appId/subscription/pay_all - GETGet current plan
/apps/:appId/subscription/plan - DELETEEnd current plan
/apps/:appId/subscription/plan - GETGet plans
/apps/:appId/subscription/plans - GETSimulate a plan
/apps/:appId/subscription/plans/:stripe_plan?stripe_coupon=string - POSTChange plan
/apps/:appId/subscription/plans/:stripe_plan?stripe_source=string&stripe_coupon=string - GETGet payment link to Stripe Checkout
/apps/:appId/subscription/plans/:stripe_plan/checkout?stripe_coupon=string - POSTAdd creditcard or sepadebit
/apps/:appId/subscription/source?stripe_source=string - DELETERemove creditcard or sepadebit
/apps/:appId/subscription/source?stripe_source=string - POSTChange default source
/apps/:appId/subscription/source/default?stripe_source=string - GETGet templates
/apps/:appId/templatesGet all templates - POSTCreate a template
/apps/:appId/templatesCreate a template - POSTCreate multiple templates
/apps/:appId/templates/batch?data=Create multiple templates - GETGet default template
/apps/:appId/templates/defaultGet the default template - GETGet a template
/apps/:appId/templates/:idGet a template - POSTUpdate a template
/apps/:appId/templates/:idUpdate a template - POSTChange password
/changepassword?forgotten_password_token=string&password=stringChange password by email forgotten_password_token - POSTLogout
/logoutLog the user out (Invalidate the token) - GETPing server
/ping - POSTCreate an User
/register?email=user@example.com&password=string&cgu=true&firstname=string&lastname=string&metadata=Create a new User from the registration form. The user will be created without an application or access, there is nothing he can do without another step such… - POSTPassword recover by email
/sendpassword?email=user@example.comSend a forgotten_password_token by email to recover password - POSTPush to purchase collector
/services/collector?app_identifiant=string&collector_key=string&invoice= - GETGet VIES database informations from SIREN
/services/vies/:siren
AccountCategories
- GETList categories
/apps/:appId/accountcategories/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a category
/apps/:appId/accountcategories/?name=string&description=string&type=string - GETGet a category
/apps/:appId/accountcategories/:id - POSTUpdate a category
/apps/:appId/accountcategories/:id?name=string&description=string&type=string - DELETERemove a category
/apps/:appId/accountcategories/:id
Entries
- GETList accounting entries
/apps/:appId/accounting_entries/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}
Accounts
- GETList Account
/apps/:appId/accounts/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a Account
/apps/:appId/accounts/?journalcode=string&name=string&description=string&keywords=string&accounting_number=string&is_cashflow=true&is_sales=true&is_purchase=true - GETGet a Account
/apps/:appId/accounts/:id - POSTUpdate a Account
/apps/:appId/accounts/:id?journalcode=string&name=string&description=string&keywords=string&accounting_number=string&is_cashflow=true&is_sales=true&is_purchase=true - DELETERemove a Account
/apps/:appId/accounts/:id
Attachments
- GETList attachments
/apps/:appId/attachments?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get list of attachments - PUTRecreate S.A.P attestations
/apps/:appId/attachments - POSTAttach a file on an object
/apps/:appId/attachments?type=none&attachable_id=0&file= - GETGet attachment by id
/apps/:appId/attachments/:id - DELETEDetach a file from id
/apps/:appId/attachments/:id
attachments
- GETDownload a list of attachments in pdf into a .zip file
/apps/:appId/attachments/download?ids=string&type=sap - GETDownload a list of SAP attestations in pdf into a .zip file
/apps/:appId/attachments/sap-download?ids=string&type=sap - GETDownload the attachment as pdf
/apps/:appId/attachments/:id/pdf?random=0
BankDetails
- GETList BankDetails
/apps/:appId/bankdetails?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a BankDetails
/apps/:appId/bankdetails?name=string&iban=string&bic=string - GETGet a BankDetails
/apps/:appId/bankdetails/:id - POSTUpdate a BankDetails
/apps/:appId/bankdetails/:id?name=string&iban=string&bic=string - DELETERemove a BankDetails
/apps/:appId/bankdetails/:id
Sources
- GETList CashflowSource
/apps/:appId/cashflowsources/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a CashflowSource
/apps/:appId/cashflowsources/?name=string&identifiant=string&type=bank&balance_amount=0&account_type=checking&parent_cashflow_source_id=0 - GETGet a CashflowSource
/apps/:appId/cashflowsources/:id - POSTUpdate a CashflowSource
/apps/:appId/cashflowsources/:id?name=string&identifiant=string&type=bank&balance_amount=0&account_type=checking&parent_cashflow_source_id=0 - DELETERemove a CashflowSource
/apps/:appId/cashflowsources/:id
Emails
- POSTSend emails
/apps/:appId/email/batch?from=user@example.com&messages={"content":"string","documents":[{"id":0,"type":"invoice"}],"recipients":["user@example.com"],"recipients_bcc":["user@example.com"],"recipients_cc":["user@example.com"],"title":"string"}&need_copy_bcc=false - POSTSend an email
/apps/:appId/email/document?from=user@example.com&recipients=user@example.com&recipients_cc=user@example.com&recipients_bcc=user@example.com&title=string&body=string&documents={"id":0,"type":"invoice"}&need_copy_bcc=false
Establishments
- GETGet an establishment
/apps/:appId/establishments/:idGet an establishment by id - POSTUpdate an establishment
/apps/:appId/establishments/:id?name=string&phones=string&emails=string&nic=string&place={"administrative_area_level1":"string","administrative_area_level2":"string","administrative_area_level3":"string","country":"string","countryiso2":"string","formatted_address":"string","latitude":0,"locality":"string","longitude":0,"postal_code":"string","route":"string","route2":"string","street_number":"string","sublocality":"string"}Update an establishment by id - DELETERemove an establishment
/apps/:appId/establishments/:idRemove an establishment
Exports
- GETList ExportEntity
/apps/:appId/exports?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a ExportEntity
/apps/:appId/exports?until=2024-01-01T00:00:00Z - GETGet the ACD UUID for authentification
/apps/:appId/exports/acd_comptaIf response UUID is empty, you must register your identifiants. - POSTRegister ACD identifiants
/apps/:appId/exports/acd_compta?login=string&password=string&base=string&cnx=stringSinao will try to connect ACD authentification with your ids. If succed, Sinao will store your ids. - GETDownload the export entity as zip
/apps/:appId/exports/download?format=universal&export_entities_ids=0&start_at=2024-01-01T00:00:00Z&end_at=2024-01-01T00:00:00Z&since=2024-01-01T00:00:00Z&since_last=true - GETList ExportEntity
/apps/:appId/exports/months - GETGet a ExportEntity
/apps/:appId/exports/:id - DELETERemove a ExportEntity
/apps/:appId/exports/:id
Invoices
- GETList invoices
/apps/:appId/invoices?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get list of invoices - POSTCreate an invoice
/apps/:appId/invoices?contact_infos={"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"}&third_account={"address":"string","id":0,"location":"string","name":"string","type":"organization"}&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"}&reference=string&discount={"amount":0,"name":"string","percent":0}¤cy=string&legal_notice=string&bank_details_id=0&vat_exemption={"article":"string","exempted":true,"reason":"string"}&tags=&metadata=&downpayments=0&downpayment_cash=0&avoid_of=0&delivered_at=2024-01-01T00:00:00Z&payment_period=30&payment_methods=virement bancaire, chèque&number_from_other_software=stringCreate a new invoice with an Organization or a Person. Relationship store notes, metadata and accounting settings parameters - POSTCreate or update many invoices
/apps/:appId/invoices/batch?data={"attachments":["https://example.com"],"author":{"civility":"string","establishments":[{"emails":[],"id":0,"name":"string","nic":"string","phones":[],"place":{"administrative_area_level1":null,"administrative_area_level2":null,"administrative_area_level3":null,"country":null,"countryiso2":null,"formatted_address":null,"id":null,"latitude":null,"locality":null,"longitude":null,"postal_code":null,"route":null,"route2":null,"street_number":null,"sublocality":null}}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[{"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":null,"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":null,"name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":null,"currency":"string","description":"string","image":null,"intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":[],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":null,"future_return_date":null,"invoice":null,"moved_at":null,"product_stock":null}],"purchase":{"account":null,"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":null,"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":null,"supplier_name":"string","tags":[],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}],"currency":"string","customer":{"civility":"string","establishments":[{"emails":null,"id":null,"name":null,"nic":null,"phones":null,"place":null}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[]},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[{"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":null,"id":0,"metadata":[],"product":{"accounting_number":null,"amount_accurately":null,"category":null,"currency":null,"description":null,"image":null,"intangible":null,"lifetime":null,"metadata":null,"name":null,"quantity_name":null,"reference":null,"tags":null,"unity":null,"vat_percent":null},"quantity":0.0,"stock":{"bar_code":null,"cost_amount":null,"entered_at":null,"expired_at":null,"location":null,"product":null,"product_stocks_movements":null,"purchase":null,"sales_lines":null,"use_duration":null},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[{"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":null,"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":null,"currency":"string","description":"string","image":null,"intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":[],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":null,"product_stocks_movements":[],"purchase":null,"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"}Create or update many invoices - DELETEDelete many invoices
/apps/:appId/invoices/batch?ids=0Delete many invoices - GETDownload a list of invoices in pdf into a .zip file
/apps/:appId/invoices/download?ids=0&template=delivery - POSTRegenerate pdf and recalcul amounts of invoice
/apps/:appId/invoices/fresh?ids=0 - GETGet the next invoice number for preview
/apps/:appId/invoices/nextnumber?written_at=2024-01-01T00:00:00Z - GETObtain statistics about invoices
/apps/:appId/invoices/statistics?search=string&filters={"comparator":"=","name":"string","value":"string"} - GETGet an invoice
/apps/:appId/invoices/:idGet an Sales/Invoice object by Id - POSTUpdate an invoice
/apps/:appId/invoices/:id?contact_infos={"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"}&third_account={"address":"string","id":0,"location":"string","name":"string","type":"organization"}&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"}&reference=string&discount={"amount":0,"name":"string","percent":0}¤cy=string&legal_notice=string&bank_details_id=0&vat_exemption={"article":"string","exempted":true,"reason":"string"}&tags=&metadata=&downpayments=0&downpayment_cash=0&avoid_of=0&delivered_at=2024-01-01T00:00:00Z&payment_period=30&payment_methods=virement bancaire, chèqueUpdate an invoice by id - DELETERemove an invoice
/apps/:appId/invoices/:idRemove an invoice by id : only for draft - POSTAttach a file at an invoice
/apps/:appId/invoices/:id/attach?file= - DELETEDetach a file at an invoice
/apps/:appId/invoices/:id/attach?file_id=0 - POSTCreate a creditnote on an invoice
/apps/:appId/invoices/:id/avoid - POSTDuplicate an invoice
/apps/:appId/invoices/:id/duplicate - POSTFinalize an invoice
/apps/:appId/invoices/:id/finalize?force_date=true - GETDownload the invoice as pdf
/apps/:appId/invoices/:id/pdf?template=delivery - GETDownload invoice as jpeg
/apps/:appId/invoices/:id/preview.jpg?template=string&disable_cache=true&base64=true - POSTAdd a tag on an invoice
/apps/:appId/invoices/:id/tag?tag=string - DELETEDelete a tag on an invoice
/apps/:appId/invoices/:id/tag?tag=string - POSTUpdate the status of an invoice
/apps/:appId/invoices/:id/updatestatus?status=draft
Organization profile
- GETGet organization profile for current app
/apps/:appId/organization - POSTUpdate organization profile for current app
/apps/:appId/organization?name=string&billing_name=string&logo=c3dhc3Rpaw==&legal_form=string&country_iso2=string&founding_date=2024-01-01&founding_location=string&dissolution_date=2024-01-01&closeaccounting_period=string&national_id=string&trade_directory_registration=string&vat_id=string&code_naf=string&number_of_employees=string&industry=string&slogan=string&rcs=string&greffe=string&sap_number_registration=string&sap_activities=string&sap_date_registration=string&capital=0
Organizations
- GETList organizations
/apps/:appId/organizations?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}List all organizations - POSTCreate an organization
/apps/:appId/organizations?name=string&billing_name=string&logo=c3dhc3Rpaw==&legal_form=string&country_iso2=string&founding_date=2024-01-01&founding_location=string&dissolution_date=2024-01-01&vat_system=string&closeaccounting_period=string&national_id=string&vat_id=string&code_naf=string&number_of_employees=string&slogan=string&rcs=string&greffe=string&capital=0&metadata=Create a contact organization. This organization will be automatically completed and updated by public data. The public profile will be automatically find by… - POSTCreate multiple organizations
/apps/:appId/organizations/batch?data={"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[{"emails":["user@example.com"],"id":0,"name":"string","nic":"string","phones":["string"],"place":{"administrative_area_level1":"string","administrative_area_level2":"string","administrative_area_level3":"string","country":"string","countryiso2":"string","formatted_address":"string","id":0,"latitude":0,"locality":"string","longitude":0,"postal_code":"string","route":"string","route2":"string","street_number":"string","sublocality":"string"}}],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"}Create a contact organization. This organization will be automatically completed and updated by public data. The public profile will be automatically find by… - GETGet an organization
/apps/:appId/organizations/:idGet an organization by id - POSTUpdate an organization
/apps/:appId/organizations/:id?name=string&billing_name=string&logo=c3dhc3Rpaw==&legal_form=string&country_iso2=string&founding_date=2024-01-01&founding_location=string&dissolution_date=2024-01-01&vat_system=string&closeaccounting_period=string&national_id=string&vat_id=string&code_naf=string&number_of_employees=string&slogan=string&rcs=string&greffe=string&capital=0&metadata=Update an organization by id - DELETERemove an organization
/apps/:appId/organizations/:idRemove an organization - GETRestore an organization
/apps/:appId/organizations/:id/restoreRestore an organization by id
Payments
- GETList payments
/apps/:appId/payments?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get list of payments - GETGet the recipe book
/apps/:appId/payments/recipe_bookGet a Payment object by Id - GETGet a payment
/apps/:appId/payments/:idGet a Payment object by Id - DELETERemove a payment
/apps/:appId/payments/:idRemove a payment by id - POSTReconcile a transaction or a document
/apps/:appId/reconcile?replace_all=false&type=transaction&id=0&movements={"amount":0,"id":0,"type":"account"}&paid_at=2024-01-01T00:00:00Z&rule={"conditions":[["string"]],"on_event":"transaction.created","parameter":"account","value":"64"}Create a new payments and categorizations by one-to-many - DELETERemove payments by an object
/apps/:appId/reconcile?type=transaction&id=0Remove all payments of a parent object - POSTReconcile several transactions
/apps/:appId/reconcile/batch?data={"id":0,"movements":[{"amount":0,"id":0,"type":"account"}],"replace_all":true,"type":"transaction"}Create new payments and categorizations by one-to-many - GETList SEPAMandate
/apps/:appId/sepamandates/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a SEPAMandate
/apps/:appId/sepamandates/?customer_organization_id=0&customer_person_id=0&old_mandate_id=0&mandate_id=string&signed_at=2024-01-01T00:00:00Z&electronic_signature=string&customer_name=string&iban=string&bic=string&is_first=true - GETPreview sepa credit transfer file
/apps/:appId/sepamandates/credittransfer?ids=0 - POSTPreview sepa credit transfer file
/apps/:appId/sepamandates/credittransfer?ids=0&amounts=0&debtor_name=string&debtor_iban=string&debtor_bic=string&btchBookg=0 - GETPreview sepa direct debit file
/apps/:appId/sepamandates/directdebit?invoices_ids=0 - POSTDownload sepa direct debit file
/apps/:appId/sepamandates/directdebit?invoices_ids=0&amounts=0&creditor_name=string&creditor_iban=string&creditor_bic=string&creditor_ics=string&date=2024-01-01T00:00:00Z - GETGet a SEPAMandate
/apps/:appId/sepamandates/:id - POSTUpdate a SEPAMandate
/apps/:appId/sepamandates/:id?customer_organization_id=0&customer_person_id=0&old_mandate_id=0&mandate_id=string&signed_at=2024-01-01T00:00:00Z&electronic_signature=string&customer_name=string&iban=string&bic=string&is_first=true - DELETERemove a SEPAMandate
/apps/:appId/sepamandates/:id - POSTLogin URSSAF
/apps/:appId/urssaf/auth?client_id=string&client_secret=string - GETGet status of a payment
/apps/:appId/urssaf/payment?invoices_ids=0 - POSTSend URSSAF request payment
/apps/:appId/urssaf/payment - GETPreview URSSAF request payment
/apps/:appId/urssaf/preview?type=invoice&ids=0 - POSTRegister a person to URSSAF and create him a mandate
/apps/:appId/urssaf/register_customer
Persons
- GETList persons
/apps/:appId/persons?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get all persons - POSTCreate a person
/apps/:appId/persons?civility=string&lastname=string&firstname=string&picture=c3dhc3Rpaw==&metadata=Create a new person. Represent a private contact - POSTCreate multiple persons
/apps/:appId/persons/batch?data={"civility":"string","establishments":[{"emails":["user@example.com"],"id":0,"name":"string","nic":"string","phones":["string"],"place":{"administrative_area_level1":"string","administrative_area_level2":"string","administrative_area_level3":"string","country":"string","countryiso2":"string","formatted_address":"string","id":0,"latitude":0,"locality":"string","longitude":0,"postal_code":"string","route":"string","route2":"string","street_number":"string","sublocality":"string"}}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[]}Create a new person. Represent a private contact - GETGet a person
/apps/:appId/persons/:idGet a person by id - POSTUpdate a person
/apps/:appId/persons/:id?civility=string&lastname=string&firstname=string&picture=c3dhc3Rpaw==&metadata=Update a person by id - DELETERemove a person
/apps/:appId/persons/:idRemove an person - GETRestore a person
/apps/:appId/persons/:id/restoreRestore a person by id
Products
- GETList products
/apps/:appId/products?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get list of products - POSTCreate a product
/apps/:appId/products?name=string&amount=0&amount_accurately=0&vat_percent=0&image=&lifetime=0&description=string&type=product&quantity_name=string&reference=string&account_id=string&tags=&category_id=0&metadata=Create a new product - POSTCreate multiple products
/apps/:appId/products/batch?data={"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0}Create a new product - GETGet a product
/apps/:appId/products/:idGet a Product object by Id - POSTUpdate a product
/apps/:appId/products/:id?name=string&amount=0&amount_accurately=0&vat_percent=0&image=&lifetime=0&description=string&type=product&quantity_name=string&reference=string&account_id=string&tags=&category_id=0&metadata=Update a product by id - DELETERemove a product
/apps/:appId/products/:idRemove a product by id - POSTAttach a file
/apps/:appId/products/:id/attach?file= - DELETEDetach a file
/apps/:appId/products/:id/attach?file_id=0
Stocks
- GETList stocks
/apps/:appId/productstocks?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get list of stocks - POSTCreate a stocks
/apps/:appId/productstocks?product_id=0&purchase_id=0&quantity=0&bar_code=string&location=string&entered_at=2024-01-01T00:00:00Z&expired_at=2024-01-01T00:00:00Z&cost_amount=0&use_duration=0Create a new stocks - GETGet a stocks
/apps/:appId/productstocks/:idGet a Product object by Id - POSTUpdate a stocks
/apps/:appId/productstocks/:id?purchase_id=0&bar_code=string&location=string&entered_at=2024-01-01T00:00:00Z&expired_at=2024-01-01T00:00:00Z&cost_amount=0&use_duration=0Update a stocks by id - DELETERemove a stocks
/apps/:appId/productstocks/:idRemove a stocks by id - POSTDestruct a quantity of stock (forgotten, destructed, expirated stock...)
/apps/:appId/productstocks/:id/destruct?quantity=0&comment=stringUpdate a stocks by id to reduce quantity of stocks - POSTConsider part of the stock as back
/apps/:appId/productstocks/:id/rental/back?quantity=0¤t_return_date=now&use_duration=0&comment=stringUpdate the amount of stocks available through the return of rented stocks - POSTConsider part of the stock as rented
/apps/:appId/productstocks/:id/rental/exit?quantity=0&future_return_date=2024-01-01T00:00:00Z&comment=stringUpdates the quantity of available stocks and provides for a stocks return date
Purchases
- GETList purchases
/apps/:appId/purchases?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}&expand=accountGet list of purchases - POSTCreate a purchase
/apps/:appId/purchases?invoice=&account_id=0&supplier_organization_id=0&title=string&supplier_name=string&amount=0&amount_tax=0¤cy=string&vat_detail={}&billed_at=2024-01-01&comment=0&tags=&vat_repayment=payment&payment_deadline_at=2024-01-01&payment_account_number=string&payment_routing_number=string&payment_swift=string&payment_iban=stringCreate a new purchase with an Organization. Relationship store notes, metadata and accounting settings parameters - POSTCreate or update many purchases
/apps/:appId/purchases/batch?data={"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[{"emails":["user@example.com"],"id":0,"name":"string","nic":"string","phones":["string"],"place":{"administrative_area_level1":"string","administrative_area_level2":"string","administrative_area_level3":"string","country":"string","countryiso2":"string","formatted_address":"string","id":0,"latitude":0,"locality":"string","longitude":0,"postal_code":"string","route":"string","route2":"string","street_number":"string","sublocality":"string"}}],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"}Create or update many purchases - DELETEDelete many purchases
/apps/:appId/purchases/batch?ids=0Delete many purchases - GETDownload a list of purchases in pdf into a .zip file
/apps/:appId/purchases/download?ids=0 - GETObtain statistics about purchases
/apps/:appId/purchases/statistics?search=string&filters={"comparator":"=","name":"string","value":"string"} - GETGet a purchase
/apps/:appId/purchases/:idGet an Purchase/Purchase object by Id - POSTUpdate a purchase
/apps/:appId/purchases/:id?account_id=0&supplier_organization_id=0&title=string&supplier_name=string&amount=0&amount_tax=0¤cy=string&vat_detail={}&billed_at=2024-01-01&comment=0&tags=&vat_repayment=payment&payment_deadline_at=2024-01-01&payment_account_number=string&payment_routing_number=string&payment_swift=string&payment_iban=string&purchase_lines={"account_id":0,"amount":0}Update a purchase by id - DELETERemove a purchase
/apps/:appId/purchases/:idRemove a purchase by id - POSTAttach a file at a purchase
/apps/:appId/purchases/:id/attach?file= - DELETEDetach a file at a purchase
/apps/:appId/purchases/:id/attach?file_id=0 - GETDownload the purchase as pdf
/apps/:appId/purchases/:id/original - GETDownload purchase as jpeg
/apps/:appId/purchases/:id/preview.jpg - POSTAdd a tag on a purchase
/apps/:appId/purchases/:id/tag?tag=string - DELETEDelete a tag on a purchase
/apps/:appId/purchases/:id/tag?tag=string - GETShow purchase thumbnail as jpeg
/apps/:appId/purchases/:id/thumbnail.jpg - POSTUpdate the status of an invoice
/apps/:appId/purchases/:id/updatestatus?status=completed
Quotes
- GETList quotes
/apps/:appId/quotes?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}Get list of quotes - POSTCreate a quote
/apps/:appId/quotes?contact_infos={"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"}&third_account={"address":"string","id":0,"location":"string","name":"string","type":"organization"}&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"}&reference=string&discount={"amount":0,"name":"string","percent":0}¤cy=string&legal_notice=string&bank_details_id=0&vat_exemption={"article":"string","exempted":true,"reason":"string"}&tags=&metadata=&downpayment_request={"amount":0,"percent":0}&commercialvalidity_deadline=2024-01-01T00:00:00Z&number_from_other_software=stringCreate a new quote with an Organization or a Person. Relationship store notes, metadata and accounting settings parameters - POSTCreate or update many quotes
/apps/:appId/quotes/batch?data={"attachments":["https://example.com"],"author":{"civility":"string","establishments":[{"emails":[],"id":0,"name":"string","nic":"string","phones":[],"place":{"administrative_area_level1":null,"administrative_area_level2":null,"administrative_area_level3":null,"country":null,"countryiso2":null,"formatted_address":null,"id":null,"latitude":null,"locality":null,"longitude":null,"postal_code":null,"route":null,"route2":null,"street_number":null,"sublocality":null}}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[{"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":null,"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":null,"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":null,"name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":null,"currency":"string","description":"string","image":null,"intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":[],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":null,"future_return_date":null,"invoice":null,"moved_at":null,"product_stock":null}],"purchase":{"account":null,"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":null,"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":null,"supplier_name":"string","tags":[],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}],"currency":"string","customer":{"civility":"string","establishments":[{"emails":null,"id":null,"name":null,"nic":null,"phones":null,"place":null}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[]},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"}Create or update many quotes - DELETEDelete many quotes
/apps/:appId/quotes/batch?ids=0Delete many quotes - GETDownload a list of quotes in pdf into a .zip file
/apps/:appId/quotes/download?ids=0&template=delivery - POSTRegenerate pdf and recalcul amounts of quote
/apps/:appId/quotes/fresh?ids=0 - POSTCreate or update many quotes
/apps/:appId/quotes/invoice?ids=0Create or update many quotes - GETGet the next quote number for preview
/apps/:appId/quotes/nextnumber?written_at=2024-01-01T00:00:00Z - GETObtain statistics about quotes
/apps/:appId/quotes/statistics?search=string&filters={"comparator":"=","name":"string","value":"string"} - GETGet a quote
/apps/:appId/quotes/:idGet a Sales/Quote object by Id - POSTUpdate a quote
/apps/:appId/quotes/:id?contact_infos={"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"}&third_account={"address":"string","id":0,"location":"string","name":"string","type":"organization"}&title=string&content={"account":{},"action":"sell","amount":0,"amount_accurately":0,"amount_with_taxes":true,"detail":"string","discount":{"amount":0,"percent":0},"document":{"attachments":["https://example.com"],"author":{"civility":"string","establishments":[],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"bank_detail":{"bic":"string","iban":"string","id":0,"name":"string"},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":{"civility":null,"establishments":null,"firstname":null,"image":null,"lastname":null,"metadata":null},"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":[{}],"by_vat":[{}],"total":0},"taxes":{"total":0,"vat":{"by_account":[{}],"by_vat":[{}],"total":0}}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":{"amount":0,"name":"string","percent":0,"value":0},"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","commercialvalidity_deadline":"2024-01-01T00:00:00Z","status":"draft"},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{"attachments":["https://example.com"],"author":{},"balance":{"completed":null,"due":null,"meaning":null,"paid":null,"remaining":null},"bank_detail":{"bic":null,"iban":null,"id":null,"name":null},"columns":{"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"},"contact_infos":{"address":"string","address2":"string","details":"string","id":0,"location":"string","name":"string","type":"organization"},"content":[],"currency":"string","customer":null,"discount":0,"downpayment_request":{"amount":0,"percent":0},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":"string","id":0,"location":"string","name":"string","type":"organization"},"title":"string","totals":{"due":0,"subtotal":{"by_account":null,"by_vat":null,"total":null},"taxes":{"total":null,"vat":null}},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":"string","exempted":true,"reason":"string"},"written_at":"2024-01-01T00:00:00Z","discount_end_at":"2024-01-01T00:00:00Z","discount_mode":"string","discount_start_at":"2024-01-01T00:00:00Z","end_at":"2024-01-01T00:00:00Z","frequency_count":0,"frequency_duration":"string","next_invoice_at":"2024-01-01T00:00:00Z","orders_plan":[{"end_at":"2024-01-01T00:00:00Z","model":0}],"saving_status":"string"},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"id":0,"metadata":[],"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"quantity":0.0,"stock":{"bar_code":0,"cost_amount":0,"entered_at":0,"expired_at":0,"location":0,"product":{"accounting_number":"string","amount_accurately":0,"category":{"image":"","name":"string","parent":null,"products":null},"currency":"string","description":"string","image":"","intangible":true,"lifetime":0,"metadata":[],"name":"string","quantity_name":"string","reference":"string","tags":["string"],"unity":"string","vat_percent":0},"product_stocks_movements":[{"description":"string","future_return_date":"2024-01-01T00:00:00Z","invoice":{"attachments":[],"author":null,"balance":null,"bank_detail":null,"columns":{"amount":null,"designation":null,"discount":null,"due":null,"info_total_quantity":null,"quantity":null,"quantity_name":null,"subtotal":null,"vat_percent":null},"contact_infos":{"address":null,"address2":null,"details":null,"id":null,"location":null,"name":null,"type":null},"content":[],"currency":"string","customer":null,"discount":{"amount":null,"name":null,"percent":null,"value":null},"downpayment_request":{"amount":null,"percent":null},"email_sent_at":"2024-01-01T00:00:00Z","id":0,"imported_at":"2024-01-01T00:00:00Z","legal_notice":"string","metadata":[],"note":"string","reference":"string","tags":[],"third_account":{"address":null,"id":null,"location":null,"name":null,"type":null},"title":"string","totals":{"due":null,"subtotal":null,"taxes":null},"validated_at":"2024-01-01T00:00:00Z","vat_exemption":{"article":null,"exempted":null,"reason":null},"written_at":"2024-01-01T00:00:00Z","avoid_of":null,"delivered_at":"2024-01-01T00:00:00Z","downpayments":[],"invoice_of":{},"paid_at":"2024-01-01T00:00:00Z","payment_methods":"string","payment_period":0,"related_recurring_invoice":{},"sepa_direct_debit_exported_at":"2024-01-01T00:00:00Z","status":"draft"},"moved_at":"2024-01-01T00:00:00Z","product_stock":null}],"purchase":{"account":{"accounting_number":"string","description":"string","editable":true,"id":0,"is_associate":true,"is_cashflow":true,"is_purchase":true,"is_sales":true,"is_various":true,"journalcode":"string","keywords":"string","name":"string","need_charge":true,"need_employee":true,"need_invoice":true,"technical_name":"string"},"accounted_at":"2024-01-01T00:00:00Z","amount":0,"amount_tax":0,"balance":{"completed":true,"due":0,"meaning":"completed","paid":0,"remaining":0},"billed_at":"2024-01-01T00:00:00Z","comment":"string","completed_at":"2024-01-01T00:00:00Z","id":0,"is_late":true,"md5":"string","paid_at":"2024-01-01T00:00:00Z","payment_account_number":"string","payment_deadline_at":"2024-01-01T00:00:00Z","payment_iban":"string","payment_routing_number":"string","payment_swift":"string","picture":"string","status":"new","supplier":{"billing_name":"string","capital":0,"closeaccounting_period":"string","code_naf":"string","country_iso2":"string","dissolution_date":"2024-01-01","establishments":[],"founding_date":"2024-01-01","founding_location":"string","greffe":"string","id":0,"legal_form":"string","logo":"https://example.com","name":"string","national_id":"string","number_of_employees":"string","rcs":"string","slogan":"string","tax_id":"string","vat_id":"string","vat_system":"string"},"supplier_name":"string","tags":["string"],"title":"string","vat_detail":{},"vat_repayment":"payment","will_be_late_at":"2024-01-01T00:00:00Z"},"sales_lines":[],"use_duration":0},"style":{"position":0,"section_id":0,"type":"section"},"total_quantity":"string","totals":{"due":0,"subtotal":0,"taxes":0},"unity":"string","vat_percent":0}&columns={"amount":"string","designation":"string","discount":"string","due":"string","info_total_quantity":"string","quantity":"string","quantity_name":"string","subtotal":"string","vat_percent":"string"}&reference=string&discount={"amount":0,"name":"string","percent":0}¤cy=string&legal_notice=string&bank_details_id=0&vat_exemption={"article":"string","exempted":true,"reason":"string"}&tags=&metadata=&downpayment_request={"amount":0,"percent":0}&commercialvalidity_deadline=2024-01-01T00:00:00ZUpdate a quote by id - DELETERemove a quote
/apps/:appId/quotes/:idRemove a quote by id : only for draft - POSTAttach a file at a quote
/apps/:appId/quotes/:id/attach?file= - DELETEDetach a file at a quote
/apps/:appId/quotes/:id/attach?file_id=0 - POSTTransform the quote in a downpayment invoice
/apps/:appId/quotes/:id/downpayment?percent=0 - POSTDuplicate a quote
/apps/:appId/quotes/:id/duplicate - POSTFinalize a quote
/apps/:appId/quotes/:id/finalize - POSTTransform the quote in invoice
/apps/:appId/quotes/:id/invoice - GETDownload the quote as pdf
/apps/:appId/quotes/:id/pdf?template=delivery - GETDownload quote as jpeg
/apps/:appId/quotes/:id/preview.jpg?template=delivery - POSTTransform the quote into a situation invoice
/apps/:appId/quotes/:id/situation_invoice?progress=0 - POSTAdd a tag on an quote
/apps/:appId/quotes/:id/tag?tag=string - DELETEDelete a tag on a quote
/apps/:appId/quotes/:id/tag?tag=string - POSTUpdate the status of a quote
/apps/:appId/quotes/:id/updatestatus?status=waiting - GETDownload quote as jpeg
/apps/:appId/quotes/:id/yousign/preview.jpg?template=delivery
Relationships
- GETList relationships
/apps/:appId/relationships?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}List all relationships - GETGet a relationship
/apps/:appId/relationships/:idGet a relationship by id - POSTUpdate a relationship
/apps/:appId/relationships/:id?is_customer=true&is_supplier=true&is_prospect=true&importance_level=0&rating=0&balance_initial_amount=0&is_notifying=true¬e=string&reference=string&tags=string&discount=string&details=string&metadata=Update a relationship by id - POSTAttach a file
/apps/:appId/relationships/:id/attach?file= - DELETEDetach a file
/apps/:appId/relationships/:id/attach?file_id=0
Signature
- POSTCreate a signature
/apps/:appId/signature?documentId=0&email=string&firstname=string&lastname=string&phone=stringCreate a new signature
Statistics
- GETObtain statistics about sales
/apps/:appId/statistics/charts/:type?count=0&period=hourly&start_at=2024-01-01T00:00:00Z&object=invoice&object_property=string&calcul=sum&methods=string&object_date_property=string&group_by=string&group_by_object_name=string&exclude_keys=0&search=string&filters={}&show_details=true - GETObtain statistics about timetable purchases
/apps/:appId/statistics/timetable/purchases?detailed=false&groups=[ [-730, -30], [-30, -1], [-1, 7], [7, 15], [15, 30], [30, 730] ] - GETObtain statistics about sales
/apps/:appId/statistics/timetable/sales?detailed=false&groups=[ [-730, -30], [-30, -1], [-1, 7], [7, 15], [15, 30], [30, 730] ] - GETObtain statistics about vat
/apps/:appId/statistics/vat?detailed=false&start_at=now&period=monthly&end_at=2024-01-01T00:00:00Z - GETGet all existants tags
/apps/:appId/tags?object=invoice
Transactions
- GETList Transaction
/apps/:appId/transactions/?offset=0&limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"} - POSTCreate a Transaction
/apps/:appId/transactions/?contact_organization_id=0&contact_person_id=0&account_id=0&cashflow_source_id=0&contact_name=string&amount=0&method=check&received_at=2024-01-01T00:00:00Z&label=string&details=string - POSTCreate multiple transactions
/apps/:appId/transactions/batch?data={"amount":0,"author":{"civility":"string","establishments":[{"emails":["user@example.com"],"id":0,"name":"string","nic":"string","phones":["string"],"place":{"administrative_area_level1":"string","administrative_area_level2":"string","administrative_area_level3":"string","country":"string","countryiso2":"string","formatted_address":"string","id":0,"latitude":0,"locality":"string","longitude":0,"postal_code":"string","route":"string","route2":"string","street_number":"string","sublocality":"string"}}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[],"password":"********"},"cashflow_source":{"account_type":"string","balance_amount":0,"disabled":0,"id":0,"identifiant":"string","name":"string","parent_cashflow_source":null,"status":"string","type":"string"},"contact":{"civility":"string","establishments":[{"emails":["user@example.com"],"id":0,"name":"string","nic":"string","phones":["string"],"place":{"administrative_area_level1":"string","administrative_area_level2":"string","administrative_area_level3":"string","country":"string","countryiso2":"string","formatted_address":"string","id":0,"latitude":0,"locality":"string","longitude":0,"postal_code":"string","route":"string","route2":"string","street_number":"string","sublocality":"string"}}],"firstname":"string","image":"https://example.com","lastname":"string","metadata":[]},"details":0,"id":0,"label":0,"lettered_at":"2024-01-01T00:00:00Z","metadata":[],"method":0,"received_at":"2024-01-01T00:00:00Z"} - GETGet a Transaction
/apps/:appId/transactions/:id - POSTUpdate a Transaction
/apps/:appId/transactions/:id?contact_organization_id=0&contact_person_id=0&account_id=0&cashflow_source_id=0&contact_name=string&amount=0&method=check&received_at=2024-01-01T00:00:00Z&label=string&details=string - DELETERemove a Transaction
/apps/:appId/transactions/:id - POSTAttach a file
/apps/:appId/transactions/:id/attach?file= - DELETEDetach a file
/apps/:appId/transactions/:id/attach?file_id=0
Authentication
- POSTLogin
/login?email=user@example.com&password=stringUser login by email and password. Used only on Sinao API. CloudAccounting API needs a different API key - GETRefresh a token
/refreshRefresh token without relogin
Account
- GETGet current user
/meGet current logged user, as User object - POSTUpdate current user
/me?civility=string&firstname=string&lastname=string&password=string&email=user@example.com&image=&metadata=Update current user informations
API details
- Base URL
https://api.sinao.app/v1https://api.sinao.dev/v1https://api.sinao.test/v1- Authentication
- HTTP Basic authentication (username and password)
A bearer token in the Authorization header
HTTP Basic authentication (username and password) - Operations
- 272 operations on 176 pathsPOST 117GET 111DELETE 43PUT 1
- Main resources
- hidden 83Quotes 25Invoices 21Payments 21Purchases 17Applications 8Exports 8Products 8Stocks 8Transactions 8
- Response formats
application/jsonapplication/zipapplication/jpegapplication/pdf- Description format
- OpenAPI 3.0.0, API version
1.1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Sinao API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Sinao API collection, without the publisher's secrets.
- Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List apps” (GET /apps?limit=10&search=string&filters={"comparator":"=","name":"string","value":"string"}&order={"direction":"asc","name":"string"}), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Sinao API?
Sinao API for account management, apps administration and network exploration It is listed under Finance & banking and has 272 endpoints.
Who publishes the Sinao API?
It is listed from Sinao's public API description (an OpenAPI document), not published by Sinao on Swastik Codes. Anyone who controls sinao.app can claim the profile by adding a DNS TXT record.
What is the base URL of the Sinao API?
Its description lists 3 base URLs: https://api.sinao.app/v1, https://api.sinao.dev/v1, https://api.sinao.test/v1. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Sinao API?
It accepts 3 methods: HTTP Basic authentication (username and password); A bearer token in the Authorization header; HTTP Basic authentication (username and password).
How many endpoints does the Sinao API have?
272 operations on 176 paths (117 POST, 111 GET, 43 DELETE, 1 PUT). The largest groups are hidden, Quotes, Invoices, Payments.
Is forking the Sinao API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.