API documentation

v1.0

Contactos

Gestiona personas y empresas que puedan ser futuros clientes, clientes y proveedores.

Crear un contacto

Este endpoint permite la creación de un nuevo contacto en tu aplicación.

Petición HTTP

POST/contacts

Parámetros

NombreTipoDescripción
nameCadena / ObligatoriaNombre o nombre comercial
typesArray / OpcionalArray de identificadores de tipos de contactos
Tipos disponibles en data.options.contact_types del endpoint: /info.
tax_nameCadena / OpcionalNombre fiscal
tax_numberCadena / OpcionalIdentificador fiscal
phoneCadena / OpcionalTeléfono
phone_secondaryCadena / OpcionalTeléfono secundario
phone_mobileCadena / OpcionalTeléfono móvil
emailCadena / OpcionalCorreo electrónico
webCadena / OpcionalSitio web
bank_nameCadena / OpcionalNombre del banco
bank_ibanCadena / OpcionalNúmero cuenta IBAN
addressObjecto / OpcionalDirección por defecto
personObjecto / OpcionalPersona de contacto por defecto

Puedes crear una dirección y una persona de contacto por defecto, en el momento de crear el contacto, son opcionales, si se envían, la información de sus propiedades es la siguiente:

Address

NombreTipoDescripción
streetCadena / ObligatoriaCalle
cityCadena / OpcionalCiudad / Población
postal_codeCadena / OpcionalCódigo postal
provinceCadena / OpcionalProvincia / Estado
countryCadena / ObligatoriaCódigo del país
Códigos disponibles en data.options.countries del endpoint: /info.
receptorCadena / OpcionalReceptor del documento para esta dirección

Person

NombreTipoDescripción
nameCadena / ObligatoriaNombre
positionCadena / OpcionalCargo o puesto
phoneCadena / OpcionalTeléfono
emailCadena / OpcionalCorreo electrónico

Datos petición

{
    "name": "Acme",
    "types": [1,3],
    "tax_name": "Acme S.L.",
    "tax_number": "ESB2700001",
    "phone": "999999999",
    "phone_mobile": "66666666",
    "email": "info@acme.com",
    "web": "www.acme.com",
    "bank_name": "Bank name",
    "bank_iban": "ES005555999922223333",
    "person": {
        "name":"John Doe",
        "email": "john@acme.com"
    },
    "address": {
        "receptor": "John Doe",
        "street": "Acme address nº 99",
        "city": "My City",
        "postal_code": "55555",
        "province": "My Province",
        "country": "ES",
    }
}

201Respuesta

{
    "data": {
        "id": 102,
        "name": "Acme",
        "types": [1,3],
        "tax_name": "Acme S.L.",
        "tax_number": "ESB2700001",
        "phone": "999999999",
        "phone_secondary": "",
        "phone_mobile": "66666666",
        "email": "info@acme.com",
        "web": "www.acme.com",
        "notes": "",
        "bank_name": "Bank name",
        "bank_iban": "ES005555999922223333",
        "address": {
            "id": 37,
            "receptor": "John Doe",
            "street": "Acme address nº 99",
            "city": "My City",
            "postal_code": "55555",
            "province": "My Province",
            "country": "ES",
            "default": true,
            "contact_id": 102,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        "person": {
            "id": 52,
            "name": "John Doe",
            "position": "",
            "phone": "",
            "email": "john@acme.com",
            "default": true,
            "contact_id": 102,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}

Listar contactos

Este endpoint permite la consulta de los contactos de tu aplicación. Si existen, obtiene también los datos de la dirección y persona de contacto por defecto, si no existen datos por defecto, obtiene el primer contacto y la primera dirección.

Petición HTTP

GET/contacts

Parámetros GET

NombreTipoDescripción
pageEntero / Opcional / Min:1Página
per_pageEntero / Opcional / Min:1 Max:100Elementos por página
typesString / OpcionalFiltrar identificadores de tipos de contactos separados por coma
/contacts?types=2,3 ...
Tipos disponibles en data.options.contact_types del endpoint: /info.
searchCadena / Opcional / Min:3Buscar por cadena de al menos 3 caracteres
orderCadena / OpcionalOrdenar por un campo de forma ascendente o descendente, descendente por defecto, en formato "{field},desc" o "{field},asc" donde {field} puede ser:
id, name

200 Respuesta


{
    "data": [
        {
            "id": 116,
            "name": "Mary Doe",
            "types": [
                2
            ],
            "tax_name": "Mary Doe",
            "tax_number": "33333333P",
            "phone": "678678678",
            "phone_secondary": "",
            "phone_mobile": "",
            "email": "mary@mary.com",
            "web": "www.mary.com",
            "notes": "",
            "bank_name": "",
            "bank_iban": "",
            "address": null,
            "person": null,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        {
            "id": 115,
            "name": "Acme",
            "types": [
                1,
                3
            ],
            "tax_name": "Acme SL",
            "tax_number": "B27999999",
            "phone": "987987987",
            "phone_secondary": "",
            "phone_mobile": "",
            "email": "info@acme.com",
            "web": "www.acme.com",
            "notes": "",
            "bank_name": "",
            "bank_iban": "",
            "address": {
                "id": 52,
                "receptor": "John Doe",
                "street": "Acme street n12",
                "city": "Lugo",
                "postal_code": "27001",
                "province": "Lugo",
                "country": "ES",
                "default": true,
                "contact_id": 115,
                "created_at": "2022-09-30T15:30:15+00:00",
                "updated_at": "2022-09-30T15:30:15+00:00"
            },
            "person": {
                "id": 61,
                "name": "John Doe",
                "position": "Boss",
                "phone": "654654654",
                "email": "JohnDoe@gmail.com",
                "default": false,
                "contact_id": 115,
                "created_at": "2022-09-30T15:30:15+00:00",
                "updated_at": "2022-09-30T15:30:15+00:00"
            }
        }
    ],
    "links": {
        "first": "http:\/\/api.orzame.com\/v1\/contacts?page=1",
        "last": "http:\/\/api.orzame.com\/v1\/contacts?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http:\/\/api.orzame.com\/v1\/contacts",
        "per_page": 100,
        "to": 2,
        "total": 2
    }
}

Obtener un contacto

Este endpoint permite la consulta de un contacto de tu aplicación. Si existen, obtiene también los datos de la dirección y persona de contacto por defecto, si no existen datos por defecto, obtiene el primer contacto y la primera dirección.

Petición HTTP

GET/contacts/{id}

200 Respuesta

{
    "data": {
        "id": 102,
        "name": "Acme",
        "types": [1,3],
        "tax_name": "Acme S.L.",
        "tax_number": "ESB2700001",
        "phone": "999999999",
        "phone_secondary": "",
        "phone_mobile": "66666666",
        "email": "info@acme.com",
        "web": "www.acme.com",
        "notes": "",
        "bank_name": "Bank name",
        "bank_iban": "ES005555999922223333",
        "address": {
            "id": 37,
            "receptor": "John Doe",
            "street": "Acme address nº 99",
            "city": "My City",
            "postal_code": "55555",
            "province": "My Province",
            "country": "ES",
            "default": true,
            "contact_id": 102,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        "person": {
            "id": 52,
            "name": "John Doe",
            "position": "",
            "phone": "",
            "email": "john@acme.com",
            "default": true,
            "contact_id": 102,
            "created_at": "2022-09-30T15:30:15+00:00",
            "updated_at": "2022-09-30T15:30:15+00:00"
        },
        "created_at": "2022-09-30T15:30:15+00:00",
        "updated_at": "2022-09-30T15:30:15+00:00"
    }
}

Actualizar un contacto

Este endpoint permite la actualización de un contacto de tu aplicación.

Petición HTTP

PATCH/contacts/{id}

Parámetros

NombreTipoDescripción
nameCadena / OpcionalNombre o nombre comercial
typesArray / OpcionalArray de identificadores de tipos de contactos
Tipos disponibles en data.options.contact_types del endpoint: /info.
tax_nameCadena / OpcionalNombre fiscal
tax_numberCadena / OpcionalIdentificador fiscal
phoneCadena / OpcionalTeléfono
phone_secondaryCadena / OpcionalTeléfono secundario
phone_mobileCadena / OpcionalTeléfono móvil
emailCadena / OpcionalCorreo electrónico
webCadena / OpcionalSitio web
bank_nameCadena / OpcionalNombre del banco
bank_ibanCadena / OpcionalNúmero cuenta IBAN

Todos los parámetros son opcionales pero al menos un parámetro con valor debe ser enviado.

Datos petición

{
    "name": "Acme Enterprises",
    "email": "newemail@acme.com",
}

204 Respuesta

Respuesta sin cuerpo.

Eliminar un contacto

Este endpoint permite la eliminación de una contacto de tu aplicación.

Petición HTTP

DELETE/contacts/{id}

204 Respuesta

Respuesta sin cuerpo.