Retención

Listar, editar crear y eliminar retenciones.

Estructura JSON

Al realizar una petición HTTP, el servicio retornara un JSON con la siguiente estructura:

Response /withholding.json

{
    "href": "https://api.bsale.com.mx/v1/withholding.json",
    "count": 5,
    "limit": 25,
    "offset": 0,
    "items": [
        {
            "href": "https://api.bsale.com.mx/v1/withholding/3.json",
            "id": 3,
            "name": "Retención ISR",
            "percentage": 1.25,
            "code": "001",
            "state": 0
        }
    ]
}

Atributos

Atributo	Descripción	Tipo dato
href	url del retención	String
id	identificador único de la retención	Integer
name	nombre de la retención	String
percentage	Porcentaje de la retención	Double
code	código tributario de la retención	String
state	estado de la retención activo(0) o inactivo (1)	Integer

GET lista de retención

• GET /v1/withholding.json retornará todas las retenciones.

Parámetros

• limit, limita la cantidad de items de una respuesta JSON, por defecto el limit es 25, el máximo permitido es 50.
• offset, permite paginar los items de una respuesta JSON, por defecto el offset es 0.
• fields, solo devolver atributos específicos de un recurso
• expand, permite expandir instancias y colecciones para traer relaciones en una sola petición.
• name, Permite filtrar por nombre de las retención.
• percentage, Porcentaje de la retención.
• code, Código tributario de la retención.
• state, Integer (0 o 1) indica si las retención están activas(0) inactivas (1).

Ejemplos

• GET /v1/withholding.json?limit=10&offset=0
• GET /v1/withholding.json?fields=[name,percentage]
• GET /v1/withholding.json?state=0

Response /withholding.json

{
    "href": "https://api.bsale.com.mx/v1/withholding.json",
    "count": 2,
    "limit": 25,
    "offset": 0,
    "items": [
        {
            "href": "https://api.bsale.com.mx/v1/withholding/1.json",
            "id": 1,
            "name": "Retención",
            "percentage": 1.25,
            "code": "001",
            "state": 1
        },
        {
            "href": "https://api.bsale.com.mx/v1/withholding/2.json",
            "id": 2,
            "name": "Retención ISR",
            "percentage": 1.25,
            "code": "001",
            "state": 0
        }
    ]
}

GET una retención

• GET /v1/withholding/1.json retornará una retención específica.

Response /withholding/1.json

{
    "href": "https://api.bsale.com.mx/v1/withholding/1.json",
    "id": 1,
    "name": "Retención",
    "percentage": 10.6667,
    "code": "002",
    "state": 0
}

POST una retención

• POST /v1/withholding.json

Para crear una retención, se debe enviar un JSON con la siguiente estructura:

Ejemplo JSON

Envío

{
    "name" : "Nombre de la nueva retención",
    "percentage": 1.25,
    "state": 0,
    "code": "001"
}

Respuesta

{
    "href": "https://api.bsale.com.mx/v1/withholding/10.json",
    "id": 10,
    "name": "Nombre de la nueva retención",
    "percentage": 1.25,
    "code": "001",
    "state": 0
}

PUT una retención

• PUT /v1/witholding/5.json

Se debe enviar un Json con la siguiente estructura

Ejemplo JSON

Envío

{
    "name" : "Nombre de la nueva retención",
    "percentage": 1.25,
    "state": 0,
    "code": "001"
}

Respuesta

{
    "href": "https://api.bsale.com.mx/v1/withholding/10.json",
    "id": 10,
    "name": "Nombre de la nueva retención",
    "percentage": 1.25,
    "code": "001",
    "state": 0
}

DELETE una retención virtualmente

• DELETE /v1/withholding/5.json Cambia el estado de la retención

danger

La retención no estará visible mediante interfaz y tendrá un state 99. Sus documentos asociados NO se eliminarán.

{
    "href": "https://api.bsale.com.mx/v1/withholding/9.json",
    "id": 9,
    "name": "Pruea retencion API - EDIT",
    "percentage": 1.25,
    "code": "001",
    "state": 1
}