Fiscalbase
PlataformaEstado de la API
GuíasReferencia de la API
Emisores

Actualizar una entidad

PATCH
/v1/ec/entities/{id}

Solo cambia los campos que envías. En un negocio en vivo, la razón social, el régimen y si lleva contabilidad vienen del registro del SRI y no se editan (422). Los comprobantes ya emitidos conservan los datos con que se firmaron.

Autorización

AutorizaciónBearer <tu clave API>

Tu clave API: fb_sandbox_… emite en Sandbox, fb_test_… en test, el servicio de pruebas de la autoridad tributaria, y fb_live_… en live, su producción.

En: header

Parámetros de ruta

id*string
Formatouuid

Cuerpo de la solicitud

application/json

Tipos de TypeScript

Usa el tipo request body en TypeScript.

legal_name?string

Solo en un negocio de Sandbox, cuyos datos son inventados. En uno en vivo la razón social es la del registro del SRI: 422; usa POST /v1/ec/entities/{id}/refresh.

Longitud1 <= length <= 300
regime?string

Solo en un negocio de Sandbox; en uno en vivo, 422.

Valores posibles

  • "general"
  • "rimpe_emprendedor"
  • "rimpe_negocio_popular"
keeps_accounting?boolean

Solo en un negocio de Sandbox; en uno en vivo, 422.

trade_name?|
Longitud1 <= length <= 300
head_office_address?string
Longitud1 <= length <= 300
head_office_phone?|

El teléfono de la matriz. Se imprime en el RIDE; el XML del SRI no lo lleva.

Longitud5 <= length <= 30
head_office_email?|

El correo de la matriz. Se imprime en el RIDE; el XML del SRI no lo lleva.

Longitudlength <= 254
reply_to_email?|

A dónde responden tus clientes cuando contestan un correo de Fiscalbase: va como Reply-To. Sin él, responden al remitente de Fiscalbase.

Longitudlength <= 254
footer_legend?|

Una línea que se imprime al pie de cada RIDE y de los correos a tus clientes. El XML del SRI no la lleva.

Longitud1 <= length <= 160
special_taxpayer_resolution?|
Patrón^[A-Za-z0-9]{3,5}$
withholding_agent_resolution?|
Patrón^0*[1-9]\d{0,7}$
large_taxpayer_resolution?|
Patrón^[^\n\r]*$
Longitud1 <= length <= 300
portal_shows_test?boolean

Solo en un negocio en vivo: true muestra en su portal también los comprobantes autorizados de Pruebas. En uno de Sandbox, 422.

Cuerpo de la respuesta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X PATCH "https://example.com/v1/ec/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "entity",  "kind": "sandbox",  "country": "ec",  "ruc": "string",  "legal_name": "string",  "trade_name": "string",  "head_office_address": "string",  "head_office_phone": "string",  "head_office_email": "string",  "reply_to_email": "string",  "footer_legend": "string",  "keeps_accounting": true,  "regime": "general",  "special_taxpayer_resolution": "string",  "withholding_agent_resolution": "string",  "large_taxpayer_resolution": "string",  "certificate": {    "holder": "string",    "holder_identification": "string",    "holder_identification_type": "cedula",    "kind": "natural_person",    "issuer_name": "string",    "subject": "string",    "issuer": "string",    "serial_number": "string",    "valid_from": "2019-08-24T14:15:22Z",    "valid_until": "2019-08-24T14:15:22Z"  },  "portal_shows_test": true,  "live_since": "2019-08-24T14:15:22Z",  "issuing": {    "allowed": true,    "lock": {      "code": "plan_required",      "message": "string"    }  },  "logo": {    "url": "http://example.com",    "content_type": "image/png",    "size": 0  },  "created_at": "2019-08-24T14:15:22Z"}

Consultar una entidad GET

El negocio con su `kind` y su certificado vigente si lo tiene. Para saber qué le falta antes de emitir usa `GET /v1/ec/entities/{id}/readiness`.

Abrir una numeración POST

En el ambiente de tu clave. Fuera de Sandbox, el establecimiento debe constar abierto para el RUC en el registro del SRI; su dirección sale de ahí.