API documentation
To use the API you must have credits available and have purchased a pack at least once.
POST
/API/authenticate
Get your token to use the API.
Application with data in format “application/json”:
{
"email": "string",
"password": "string"
}
Answer:
{
"token": "string",
"status_code": 0,
"message": "string",
"errorMessageTranslationKey": "string"
}
Get your token to use the API.
Request with data in "application/json" format:
{
"email": "string",
"password": "string"
}
Answer:
{
"token": "string",
"status_code": 0,
"message": "string",
"errorMessageTranslationKey": "string"
}
POST
/API/document
Upload a document for Braulio to process.
Request with data type "multipart/form-data":
file: document to upload
Answer:
{
"data": {
"internal_id": 0
},
"status_code": 0,
"message": "string",
"errorMessageTranslationKey": "string"
}
GET
/API/document/{id}
Obtain the document processed by Braulio.
Parameters:
id: the ID of the required document
Answer:
{
"data": {
"tenant_id": 0,
"status_id": 0,
"status": {
"id": 0,
"code": "string",
"name": "string",
"description": "string",
"translation_key": "string"
},
"filename": "string",
"receipt_type_id": 0,
"receipt_type": {
"code": "string",
"name": "string",
"description": "string",
"active": true,
"translation_key": "string"
},
"receipt_letter_id": 0,
"receipt_letter": {
"id": 0,
"code": "string",
"name": "string",
"description": "string",
"active": true,
"translation_key": "string"
},
"payment_method": "string",
"receipt_number": "string",
"receipt_date": "string",
"receipt_file_id": 0,
"receipt_file": {
"filename": "string",
"mimetype": "string",
"encoding": "string",
"file": "string"
},
"receipt_detail": [
{
"receipt_header_id": 0,
"code": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"discount_price": 0,
"discount_percentage": 0,
"unit": "string",
"product_id": 0,
"product": {
"code": "string",
"description": "string",
"tenant_id": 0,
"id": 0
},
"subtotal": 0,
"subtotal_without_tax": 0,
"tax_rate": 0,
"cost_center_id": "string",
"receipt_line_number": 0,
"receipt_line_tax_total": 0,
"receipt_line_discount_total": 0
}
],
"has_details": true,
"receipt_period": "string",
"receipt_currency_id": 0,
"currency_type": {
"code": "string",
"name": "string",
"description": "string",
"active": true,
"translation_key": "string"
},
"receipt_total": 0,
"receipt_tax_total": 0,
"receipt_subtotal": 0,
"receipt_discount_total": 0,
"status_code": 0,
"message": "string",
"errorMessageTranslationKey": "string"
}
Get the document processed by Braulio.
Parameters:
id: the ID of the required document
Response:
{
"data": {
"tenant_id": 0,
"status_id": 0,
"status": {
"id": 0,
"code": "string",
"name": "string",
"description": "string",
"translation_key": "string"
},
"filename": "string",
"receipt_type_id": 0,
"receipt_type": {
"code": "string",
"name": "string",
"description": "string",
"active": true,
"translation_key": "string"
},
"receipt_letter_id": 0,
"receipt_letter": {
"id": 0,
"code": "string",
"name": "string",
"description": "string",
"active": true,
"translation_key": "string"
},
"payment_method": "string",
"receipt_number": "string",
"receipt_date": "string",
"receipt_file_id": 0,
"receipt_file": {
"filename": "string",
"mimetype": "string",
"encoding": "string",
"file": "string"
},
"receipt_detail": [
{
"receipt_header_id": 0,
"code": "string",
"description": "string",
"quantity": 0,
"unit_price": 0,
"discount_price": 0,
"discount_percentage": 0,
"unit": "string",
"product_id": 0,
"product": {
"code": "string",
"description": "string",
"tenant_id": 0,
"id": 0
},
"subtotal": 0,
"subtotal_without_tax": 0,
"tax_rate": 0,
"cost_center_id": "string",
"receipt_line_number": 0,
"receipt_line_tax_total": 0,
"receipt_line_discount_total": 0
}
],
"has_details": true,
"receipt_period": "string",
"receipt_currency_id": 0,
"currency_type": {
"code": "string",
"name": "string",
"description": "string",
"active": true,
"translation_key": "string"
},
"receipt_total": 0,
"receipt_tax_total": 0,
"receipt_subtotal": 0,
"receipt_discount_total": 0,
"status_code": 0,
"message": "string",
"errorMessageTranslationKey": "string"
}
Links
Braulio®, all rights reserved.
Links
Braulio®, all rights reserved.
Links
Braulio®, all rights reserved.