Compañía

Objeto compañía

tax_idstringrequired

ID tributario de la empresa, para Perú número de RUC

business_namestringrequired

Nombre oficial de la empresa, para Perú Razón social

trade_namestringrequired

Nombre comercial o de marca de la empresa.

phonestringrequired

Número de teléfono de contacto de la empresa.

emailstringrequired

Correo electrónico de contacto de la empresa.

countrystringrequired

Código del país de la empresa

addressobjectrequired

Dirección de la empresa

web_hookstringoptional

URL del webhook para notificaciones

La API de Facturación permite obtener información correspondiente sobre las compañías que una cuenta maneja.

Lista de compañías

El servicio trae todas las compañías que se encuentren registradas con el usuario que haya iniciado sesión.

GET /api/account/companies
Host: invoice.tandia.io
Content-Type: application/json
Authorization: Bearer token-de-api

Query Params

limit: indica el límite de cuántos registros de compañías se quiere obtener por solicitud.
next_token: token requerido para acceder a la siguiente página de registros. Este es enviado tras la primera solicitud si es que hubiera más registros en la siguiente página, considerando el límite previamente establecido.

Ejemplo de solicitud

GET https://invoice.tandia.io/api/account/companies?limit=2&next_token=abcd12345

Respuesta

Al realizar la solicitud GET, la API responderá con un estado 200 si la solicitud fue exitosa y devolverá la respuesta en formato JSON. A continuación, la estructura de la respuesta.

{
    "data": [
        {
            "business_name": "Tandia Test 0 S.A.C.",
            "country": "PE",
            "metadata": null,
            "address": {
                "country": "PE",
                "address": "SAN MIGUEL DE MIRAFLORES",
                "city_subdivision": "MIRAFLORES",
                "city": "LIMA",
                "district": "MIRAFLORES",
                "postal_zone": "12345",
                "country_subentity": "LIMA",
                "type_code": null
            },
            "web_hook": "https://invoice.tandia.local/test/webhook/",
            "tax_id": "011223344",
            "trade_name": "Tandia Test 0 S.A.C.",
            "environment": "TEST",
            "account_id": "acc_7449a64d83b17ba",
            "entity_type": "company",
            "phone": "+51 986187825",
            "logo": null,
            "id": "com_61a80925017e4",
            "email": "cuenta_test@tandia.pe"
        }
    ],
    "meta": {
        "next_token": "next_token_aqui"
    }
}

Búsqueda de compañías por País y RUC

El servicio realiza un filtro en las compañías del usuario por medio de País y RUC.

GET /api/company/search/country/{countryCode}/taxId/{taxId}
Host: invoice.tandia.io
Content-Type: application/json
Authorization: Bearer token-de-api

Path Params

countryCode: Se debe especificar el país del cual se quiere obtener los tipos de documentos electrónicos, enviando código ISO del país (ej. PE para Perú).
taxId: RUC sobre el cual se filtrará las compañías.

Query Params

limit: indica el límite de cuántos registros de compañías se quiere obtener por solicitud.
next_token: token requerido para acceder a la siguiente página de registros. Este es enviado tras la primera solicitud si es que hubiera más registros en la siguiente página, considerando el límite previamente establecido.

Ejemplo de solicitud

GET https://invoice.tandia.io/api/company/search/country/PE/taxId/01234567891?limit=10&next_token=abcd12345

Respuesta

Al realizar la solicitud GET, la API responderá con un estado 200 si la solicitud fue exitosa y devolverá la respuesta en formato JSON. A continuación, la estructura de la respuesta.


{
     "data": [
        {
            "business_name": "Tandia Test 0 S.A.C.",
            "country": "PE",
            "metadata": null,
            "address": {
                "country": "PE",
                "address": "SAN MIGUEL DE MIRAFLORES",
                "city_subdivision": "MIRAFLORES",
                "city": "LIMA",
                "district": "MIRAFLORES",
                "postal_zone": "12345",
                "country_subentity": "LIMA",
                "type_code": null
            },
            "web_hook": "https://invoice.tandia.local/test/webhook/",
            "tax_id": "011223344",
            "trade_name": "Tandia Test 0 S.A.C.",
            "environment": "TEST",
            "account_id": "acc_7449a64d83b17ba",
            "entity_type": "company",
            "phone": "+51 986187825",
            "logo": null,
            "id": "com_61a80925017e4",
            "email": "cuenta_test@tandia.pe"
        }
    ],
    "meta": {
        "next_token": "next_token_aqui"
    }
}