Envoyer des documents typés (achats, ventes, avoirs, notes de frais)
Ce guide a pour objectif de vous aider à envoyer des documents typés à un dossier comptable.
Un document typé est un document de nature comptable définie. Dans MyUnisoft on retrouve cinq types de documents rattachables à une écriture :
- Factures d'achats
- Factures de ventes
- Avoirs sur achats
- Avoirs sur Ventes
- Notes de frais
Ils peuvent être transmis via le système automatisé d'OCR, en flux manuel par l'utilisateur, ou via Facture X.
Dans l'application MyUnisoft, ces documents peuvent être importés après avoir sélectionné un dossier comptable par le bouton "Déposer un nouveau document".
Vous obtenez la page suivante :
API
La route https://api.myunisoft.fr/api/v1/invoice vous permet d'envoyer des documents typés.
curl --location 'https://api.myunisoft.fr/api/v1/invoice?invoice_type_id=1&ocr_type_id=2&name=facture&extension=png' \
--header 'X-Third-Party-Secret: {{X-Third-Party-Secret}}' \
--header 'Authorization: Bearer {{API_TOKEN}}' \
--header 'Content-Type: application/octet-stream' \
--header 'society-id: 1' \
--data-binary '@/C:/facture.png'
IMPORTANT
Penser à préciser l'en-tête society-id.
La route requiert des paramètres (query string) suivants :
clé | description | valeurs | obligatoire |
---|---|---|---|
invoice_type_id | l'id du type de document | 1 = Achat 2 = Note de frais 3 = Vente 4 = Avoir | ✅ |
ocr_type_id | l'id de type d'OCR utilisé | 2 = MANUEL 3 = OCR MyUnisoft 6 = Factur-X | ✅ |
name | le nom du document | ❌ | |
return_type | permet de préciser le type de retour | 1 = "Pas de contenu" (Default) 2 = retourne les infos du document | ❌ |
extension | l'extension de fichier du document | formats supportés : jpg, jpeg, tiff, tif, bmp, png, pdf Taille maximale : 15 Mégaoctets (15Mo) | ✅ |
En cas de succès, l'API retournera un status code 200
avec la réponse JSON suivante :
return_type
par défaut :
{
"result": "success"
}
return_type
enrichis (contenant les infos du document) :
{
"id": 1234567,
"token": "8a6ec632125eeedc7008xxxxxxxx5512",
"link": "https://api.myunisoft.fr/api/ged/ged/document/1-8a6ec632125eeedc7008xxxxxxxx5512",
"thumbnail": "https://api.myunisoft.fr/api/ged/ged/document/1-8a6ec632125eeedc7008xxxxxxxx5512/preview?x=90&y=120",
"download": "https://api.myunisoft.fr/api/ged/ged/document/1-8a6ec632125eeedc7008xxxxxxxx5512/download",
"baseURL": "https://x.xxxxxxxx.myunisoft.fr",
"label": "facture.png",
"OCR": false
}