Inicio rápido

Authenticate, choose a route, test.

Get the X-API-Key and generate the Bearer in Dashboard → API. Enter them below, then use “Test · Generate” on an endpoint to obtain the response and cURL, PHP 8 or JavaScript code.

X-API-Key

Bearer token

Credentials incompleteEnter the X-API-Key and Bearer token to prepare a test.

Credentials remain in memory for this page only. For a customer-related operation, add customer_id.

Keep in mindHTTPS + JSON · keep both credentials server-side · never send tokens to support.

ERP ↔ SellViaApp

Your ERP can drive the complete mobile experience.

The API is not limited to retrieving cases. Your software can configure the module, supply the data used by the app, assign technicians and retrieve actions completed in the field or by customers.

From your ERP to the app

Organise and send work

Intervention types, forms, customers, technicians, cases, appointments, missions, checklists, documents, quotes, recurring work and knowledge base.

From the app to your ERP

Retrieve real activity

Customer requests, statuses, progress, messages, photos, documents, completed steps, time entries, quote decisions, approvals and signatures.

Controlled synchronisation

Keep one business workflow

Your ERP stores the identifiers returned by SellViaApp, retrieves cases and related data, then applies only relevant changes to your system.

1
ConnectUse the X-API-Key and Bearer generated in Dashboard → API.
2
ConfigureCreate the required types, forms, technicians, checklists and technical content.
3
OperateCreate or update cases, then assign interventions.
4
SynchroniseRetrieve cases, messages, documents, time entries and approvals needed by your ERP.

Developer tipStart with Cases and lifecycle, then add the business categories your ERP actually needs. Every endpoint can be tested and generates ready-to-copy code.

Puntos finales

Cases and lifecycle

Create, search, retrieve and update a case: status, priority, progress, appointments, assignment and technician mission.

5 routes

GET /case/list Llav + portador

List the signed-in customer cases; a supplier token can list every case.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Number of results per page.

customer_id entero Optional

Required only with an integration token when the operation targets a specific customer.

status cuerda Optional

Filter by status code.

type_id entero Optional

Filter by intervention type.

priority enum Optional

low | normal | high | urgent

q cuerda Optional

Supplier search by reference, title, description or assignee.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/detail Llav + portador

Retrieve a case with timeline, messages, documents and detailed quotes. The private mission is returned only to the assigned technician and supplier.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

id entero Necesidad

Case identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/create Llav + portador

Create a service request linked to the customer.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Optional

Required only with a supplier token.

type_id entero Optional

Active intervention type.

title cuerda Necesidad

Short request title.

description cuerda Necesidad

Problem or request description.

status cuerda Optional

Supplier only; defaults to new.

priority enum Optional

low | normal | high | urgent

progress entero Optional

0 - 100

address cuerda Optional

Service address.

appointment_start datetime Optional

YYYY-MM-DD HH:MM:SS

appointment_end datetime Optional

YYYY-MM-DD HH:MM:SS

assigned_to cuerda Optional

Assigned person or team.

technician_id entero Optional

Assigned technician; supplier only.

custom_fields object Optional

Values indexed by custom field ID or key.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/update Llav + portador

Update customer, type, status, priority, progress, appointment and assignment.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Case identifier.

customer_id entero Optional

Linked customer; 0 removes the link.

type_id entero Optional

Type; 0 removes the type.

title cuerda Optional

Case title.

description cuerda Optional

Detailed description.

status cuerda Optional

Code returned by case/status/list.

priority enum Optional

low | normal | high | urgent

progress entero Optional

0 - 100

address cuerda Optional

Service address.

appointment_start datetime Optional

Empty to clear the date.

appointment_end datetime Optional

Empty to clear the date.

assigned_to cuerda Optional

Assigned person or team.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/status/list Llav + portador

List workflow statuses and their translated labels.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Types and forms

Let the ERP manage intervention types and custom fields requested in the mobile app.

8 routes

GET /case/type/list Llav + portador

List available intervention types.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

include_inactive boolean Optional

Supplier only; includes hidden types.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/type/add Llav + portador

Create an intervention type.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

name cuerda Necesidad

Type name.

description cuerda Optional

Maximum 2,000 characters.

sort_order entero Optional

Display order.

active boolean Optional

Active by default.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/type/update Llav + portador

Edit, reorder or hide an intervention type.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Type identifier.

name cuerda Necesidad

Type name.

description cuerda Optional

Description.

sort_order entero Optional

Display order.

active boolean Optional

Type availability.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/type/delete Llav + portador

Delete an unused type or archive a linked type.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

A type in use will be archived.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/form/list Llav + portador

List custom service-request fields.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

type_id entero Optional

Limit to global fields and the selected type.

include_inactive boolean Optional

Supplier only.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/form/add Llav + portador

Add information to request from customers.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

type_id entero Optional

0 or omitted for every type.

label_fr cuerda Necesidad

French label.

label_en cuerda Optional

English label.

field_type enum Necesidad

options array Optional

Required for select.

required boolean Optional

Required answer.

sort_order entero Optional

Display order.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/form/update Llav + portador

Update a custom request field.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Field identifier.

type_id entero Optional

Linked type or 0.

label_fr cuerda Necesidad

French label.

label_en cuerda Optional

English label.

field_type enum Necesidad

options array Optional

Menu options.

required boolean Optional

Required answer.

active boolean Optional

Visible field.

sort_order entero Optional

Order.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/form/delete Llav + portador

Delete or archive a custom request field.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Field identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Technicians and assignments

Synchronise field teams, skills and roles, then assign every intervention to the right technician.

5 routes

GET /case/technician/list Llav + portador

List technicians separately with job, skills, availability and workload.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/technician/detail Llav + portador

Retrieve a technician’s complete professional record.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

technician_id entero Necesidad

Technician identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/technician/profile Llav + portador

Create or update a technician account’s professional profile.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

technician_id entero Necesidad

Mobile account to configure as technician.

employee_code cuerda Optional

Employee or internal code.

job_title cuerda Optional

Technician job title.

specialties cuerda Optional

Field specialities.

skills cuerda Optional

Skills and certifications.

service_area cuerda Optional

Service area.

availability_notes cuerda Optional

Usual availability.

emergency_available boolean Optional

Available for emergencies.

internal_notes cuerda Optional

Internal notes hidden in the app.

profile_color cuerda Optional

#RRGGBB

active boolean Optional

Active technician.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/technician/role Llav + portador

Assign the Customer or Technician role to a mobile account.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

customer_id entero Necesidad

Mobile account.

role enum Necesidad

client | technician

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/technician/update Llav + portador

Allow the assigned technician to update status and progress.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Service assigned to the signed-in technician.

status enum Necesidad

planned | in_progress | waiting_customer | completed

progress entero Optional

0 - 100

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Missions and checklists

Prepare procedures, retrieve applied steps and record field completion.

7 routes

GET /case/checklist/list Llav + portador

Retrieve the checklist and progress for an authorised case.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

case_id entero Necesidad

Case authorised for the signed-in account.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/mission/update Llav + portador

Set the private mission visible only to the assigned technician.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case whose mission is being set.

mission_note cuerda Optional

Private technician instruction, maximum 10,000 characters. An empty value clears the mission.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/checklist/item/update Llav + portador

Complete or reopen a step; assigned technician or supplier only.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case assigned to the technician.

item_id entero Necesidad

Checklist step.

completed boolean Necesidad

Complete or reopen the step.

note cuerda Optional

Optional field note.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/checklist/template/list Llav + portador

List checklist templates and their steps.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/checklist/template/add Llav + portador

Create a global checklist or one linked to an intervention type.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

type_id entero Optional

Omit or use 0 for every type.

title_fr cuerda Necesidad

French title.

title_en cuerda Optional

English title.

items array Necesidad

Steps as strings or objects with label_fr, label_en, required and sort_order.

active boolean Optional

Active by default.

sort_order entero Optional

Template order.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/checklist/template/update Llav + portador

Update a template and safely replace its steps.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Template identifier.

type_id entero Optional

Linked type or 0.

title_fr cuerda Necesidad

French title.

title_en cuerda Optional

English title.

items array Necesidad

Complete list replacing template steps.

active boolean Optional

Availability.

sort_order entero Optional

Order.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/checklist/template/delete Llav + portador

Delete an unused template or archive an applied template.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

An applied template will be archived.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Time tracking

Start, stop, add and audit technician time for every case.

5 routes

GET /case/time/list Llav + portador

List time entries and total tracked time for an authorised case.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

case_id entero Necesidad

Case assigned to the technician; supplier access is read-only.

technician_id entero Optional

Supplier access only; assigned technician by default.

include_deleted boolean Optional

Supplier access only; include deleted entries and their reason.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/time/start Llav + portador

Start a live timer for the assigned technician.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case assigned to the signed-in technician.

note cuerda Optional

Optional note, maximum 1,000 characters.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/time/stop Llav + portador

Stop and calculate the active time entry.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case containing the active time entry.

entry_id entero Optional

Active entry; the current case entry is used when omitted.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/time/add Llav + portador

Manually add a date, start time and end time.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case assigned to the signed-in technician.

started_at datetime Necesidad

ISO 8601 date and time with timezone.

ended_at datetime Necesidad

After started_at; duration from 1 minute to 48 hours, without overlap.

note cuerda Optional

Optional note.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/time/delete Llav + portador

Soft-delete a time entry with a mandatory reason retained in the audit trail.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

entry_id entero Necesidad

Completed entry belonging to the technician.

reason cuerda Necesidad

Mandatory reason from 5 to 1,000 characters.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Messages, photos and documents

Exchange data with the app, classify documents, send photos and retrieve authorised files.

10 routes

POST /case/message/send Llav + portador

Add a message to the case; the sender is identified automatically from the authenticated account.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case identifier.

message cuerda Necesidad

Message to add.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/document-type/list Llav + portador

List document types visible in the mobile app.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

include_inactive boolean Optional

Supplier token only; includes archived types.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/document-type/add Llav + portador

Create a document type for the shop.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

label_fr cuerda Necesidad

French type name.

label_en cuerda Optional

English name; falls back to French.

icon enum Optional

color hex Optional

#RRGGBB

sort_order entero Optional

Display order.

active boolean Optional

Active by default.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/document-type/update Llav + portador

Edit, reorder or hide a document type.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Type identifier.

label_fr cuerda Necesidad

French type name.

label_en cuerda Optional

English name.

icon enum Optional

color hex Optional

#RRGGBB

sort_order entero Optional

Display order.

active boolean Optional

Type availability.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/document-type/delete Llav + portador

Delete an unused type or archive a type already in use.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Type identifier. A type in use will be archived.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/document/list Llav + portador

List all authorised documents newest first with their customer, technician or administrator source.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

page entero Optional

Número de página, empezando a 1.

per_page entero Optional

Number of results per page.

customer_id entero Optional

Supplier-only filter.

case_id entero Optional

Limit to one case.

unlinked_only boolean Optional

Return only documents not linked to a case.

document_type_id entero Optional

Limit to one document type.

folder_path cuerda Optional

Limit to an exact path, for example Reports / 2026.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/document/add Llav + portador

Add one or more photos, PDFs, documents or signatures, optionally linked to a checklist step.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Optional

Optional case. Required when checklist_item_id is provided.

customer_id entero Optional

Required with a supplier token when case_id is absent; ignored for an authenticated customer.

document_type_id entero Optional

Classification type; an active default is used when omitted.

checklist_item_id entero Optional

Checklist step that must belong to the specified case. Repeat the call to link multiple files.

title cuerda Optional

Readable title; falls back to the file name.

folder_path cuerda Optional

Free folder structure separated by /, maximum 8 levels.

note cuerda Optional

Optional note, maximum 5,000 characters.

customer_visible boolean Optional

A supplier token can keep the document internal with false; mobile uploads remain visible.

kind enum Optional

photo | document | signature

photo_stage enum Optional

general | before | after

file_name cuerda Necesidad

File name.

mime_type enum Necesidad

image/jpeg | image/png | image/webp | application/pdf

content_base64 base64 Necesidad

Encoded file, maximum 6 MB.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/document/get Llav + portador

Download the Base64 content of an authorised document.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

id entero Necesidad

Document identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/document/preview Llav + portador

Load an optimised image thumbnail before opening and zooming.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

id entero Necesidad

Authorised image-document identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/document/delete Llav + portador

Delete a document that is not attached to a quote.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Document identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Quotes, approval and signature

Create detailed quotes, retrieve customer decisions and manage final intervention approval.

4 routes

POST /case/quote/create Llav + portador

Create and send a detailed quote with lines, discounts, VAT and an optional attachment.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case identifier.

lines array Necesidad

1 to 100 objects: description, quantity, unit_price, discount_percent and tax_rate.

notes cuerda Optional

Maximum 5,000 characters.

valid_until Fecha Optional

YYYY-MM-DD

attachment object Optional

file_name, mime_type and content_base64; maximum 6 MB.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/quote/respond Llav + portador

Accept or reject a quote sent to the customer.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case identifier.

quote_id entero Necesidad

Quote identifier.

decision enum Necesidad

accepted | rejected

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/validation/request Llav + portador

Request customer approval and signature.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case identifier.

validation_type cuerda Optional

Defaults to completion.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/validation/send Llav + portador

Record the customer signature, either directly by the customer or on the assigned technician’s phone.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

case_id entero Necesidad

Case identifier accessible to the customer or assigned technician.

validation_type cuerda Optional

Defaults to completion.

signature_name cuerda Necesidad

Name of the customer signing.

signature_base64 base64 Necesidad

PNG signature image encoded as Base64.

comment cuerda Optional

Optional customer comment.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Planning, recurrence and reports

Automate recurring interventions and produce structured final-report data.

6 routes

GET /case/recurrence/list Llav + portador

List recurring services.

Input

Available parameters

URL query

No business parameter is expected. Send only the indicated authentication headers.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/recurrence/add Llav + portador

Create a recurrence from a source case.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

source_case_id entero Necesidad

Case used as the template.

frequency enum Necesidad

daily | weekly | monthly | yearly

interval_value entero Optional

1 - 52

next_run_at datetime Necesidad

YYYY-MM-DD HH:MM:SS

end_at datetime Optional

Optional end date.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/recurrence/update Llav + portador

Update a recurring service.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Recurrence identifier.

source_case_id entero Necesidad

Source case.

frequency enum Necesidad

daily | weekly | monthly | yearly

interval_value entero Optional

1 - 52

next_run_at datetime Necesidad

YYYY-MM-DD HH:MM:SS

end_at datetime Optional

Optional end date.

active boolean Optional

Active recurrence.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/recurrence/delete Llav + portador

Stop a recurring service.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Recurrence identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/recurrence/process Llav + portador

Generate recurring services that are due.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

limit entero Optional

Maximum 200 creations per call.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/report/summary Llav + portador

Prepare the final report with fields and before/after photos.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

case_id entero Necesidad

Report case.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Notificaciones

Retrieve customer or technician alerts and synchronise their read status.

2 routes

GET /case/notification/list Llav + portador

List automatic notifications for the signed-in customer or technician.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

limit entero Optional

1 - 100

recipient_type enum Optional

Supplier token only: customer or technician.

recipient_id entero Optional

Supplier token only.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "items": [],
        "pagination": {
            "page": 1,
            "per_page": 25,
            "total": 0,
            "last_page": 1
        }
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/notification/read Llav + portador

Mark one or every notification as read.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Optional

Omit to mark all notifications as read.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Puntos finales

Knowledge base

Supply procedures, FAQs and technical documents available to technicians in the mobile app.

12 routes

GET /case/knowledge/categories Llav + portador

List knowledge-base categories. On mobile, access is restricted to active technicians.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

include_inactive boolean Optional

Supplier token only.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/knowledge/search Llav + portador

Quickly search FAQs, information, procedures and documents by keyword. Mobile access is technician-only.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

q cuerda Optional

Keyword or phrase, maximum 120 characters.

category_id entero Optional

Filter by category.

type enum Optional

faq | information | procedure | document

page entero Optional

Page, defaults to 1.

limit entero Optional

1 to 50 results.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/knowledge/detail Llav + portador

Open an entry and list its attachments without loading large files.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

id entero Necesidad

Entry identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

GET /case/knowledge/document Llav + portador

Download an authorised Base64 attachment.

Input

Available parameters

URL query

NombreTipoRequirementDescripción

id entero Necesidad

Attachment identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/knowledge/category/add Llav + portador

Create a knowledge category.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

title_fr cuerda Necesidad

French title.

title_en cuerda Optional

English title with French fallback.

description_fr cuerda Optional

French description.

description_en cuerda Optional

English description.

color hex Optional

#RRGGBB

active boolean Optional

Visible by default.

sort_order entero Optional

Order.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/knowledge/category/update Llav + portador

Edit, reorder or hide a category.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Category identifier.

title_fr cuerda Necesidad

French title.

title_en cuerda Optional

English title.

active boolean Optional

Visibility.

sort_order entero Optional

Order.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/knowledge/category/delete Llav + portador

Delete a category while retaining its entries as uncategorised.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Category identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/knowledge/article/add Llav + portador

Create a FAQ, information entry, procedure or documentation.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

category_id entero Optional

Optional category.

content_type enum Necesidad

faq | information | procedure | document

title_fr cuerda Necesidad

French title.

title_en cuerda Optional

English title.

summary_fr cuerda Optional

French summary.

summary_en cuerda Optional

English summary.

content_fr cuerda Optional

French content.

content_en cuerda Optional

English content.

keywords cuerda Optional

Comma-separated keywords.

featured boolean Optional

Featured.

active boolean Optional

Published.

sort_order entero Optional

Order.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

PATCH /case/knowledge/article/update Llav + portador

Edit and publish an entry.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Entry identifier.

content_type enum Necesidad

faq | information | procedure | document

title_fr cuerda Necesidad

French title.

title_en cuerda Optional

English title.

content_fr cuerda Optional

French content.

content_en cuerda Optional

English content.

active boolean Optional

Published.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/knowledge/article/delete Llav + portador

Delete an entry and its attachments.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Entry identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

POST /case/knowledge/document/add Llav + portador

Attach a document up to 8 MB.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

article_id entero Necesidad

Parent entry.

title_fr cuerda Optional

French title.

title_en cuerda Optional

English title.

file_name cuerda Necesidad

File name.

mime_type cuerda Necesidad

Allowed MIME type.

content_base64 base64 Necesidad

Maximum 8 MB.

Output

Possible results

201Resource created

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

DELETE /case/knowledge/document/delete Llav + portador

Delete an attachment.

Input

Available parameters

Cuerpo JSON

NombreTipoRequirementDescripción

id entero Necesidad

Attachment identifier.

Output

Possible results

200Successful operation

400Invalid request or JSON

401Missing or invalid authentication

403Insufficient access

404Requested resource not found

409Conflict with existing data

422Parameter rejected by validation

429Request limit reached

5xxTemporary technical incident

Success example

{
    "success": true,
    "message": "Operation successful",
    "data": {
        "id": 123,
        "status": "ok"
    },
    "error": null
}

Error example

{
    "success": false,
    "message": "The request cannot be processed.",
    "data": null,
    "error": {
        "code": "VALIDATION_ERROR",
        "category": "validation",
        "message": "Check the indicated parameters.",
        "details": {
            "field": "parameter_name"
        }
    }
}

Reference

Responses and errors

Each row has a “Parameters and responses” button showing required or optional fields, possible statuses and JSON examples. An empty list means the resource is not populated yet, not that the endpoint is down.

400Solicitud de invalidez

401Autenticación necesaria

403Acceso denegado

404Recursos o ruta no encontrada

409Conflicto comercial

422Falló la validación

429Demasiadas solicitudes

5xxIncidencia técnica

Conecta tu software al seguimiento de casos de SellViaApp.

Authenticate, choose a route, test.

Your ERP can drive the complete mobile experience.

Organise and send work

Retrieve real activity

Keep one business workflow

Cases and lifecycle

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Types and forms

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Technicians and assignments

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Missions and checklists

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Time tracking

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Messages, photos and documents

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results

Available parameters

Possible results