Fiscalbase
PlataformaEstado del servicio
GuíasReferencia de la APIMCP
Entities

Update an entity

PATCH
/v1/ec/entities/{id}

Only the fields you send change. On a live business, the legal name, the regime and whether it keeps accounting come from the SRI registry and cannot be edited (422). Documents already issued keep the data they were signed with.

Authorization

AuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_sandbox_… issues in sandbox, fb_test_… in test, the tax authority's testing service, and fb_live_… in live.

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

legal_name?string

Only on a sandbox business, whose data is made up. On a live one the legal name is the SRI registry's: 422; use POST /v1/ec/entities/{id}/refresh.

Length1 <= length <= 300
regime?string

Only on a sandbox business; on a live one, 422.

Value in

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

Only on a sandbox business; on a live one, 422.

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

The head office's phone number. It is printed on the RIDE; the SRI's XML does not carry it.

Length5 <= length <= 30
head_office_email?|

The head office's email. It is printed on the RIDE; the SRI's XML does not carry it.

Lengthlength <= 254
reply_to_email?|

Where your customers' replies go when they answer an email from Fiscalbase: it is sent as Reply-To. Without it, they reply to Fiscalbase's sender.

Lengthlength <= 254
footer_legend?|

A line printed at the foot of every RIDE and of the emails to your customers. The SRI's XML does not carry it.

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

Only on a live business: true also shows authorized test documents on its portal. On a sandbox one, 422.

Response Body

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",      "canceled": true    }  },  "logo": {    "url": "http://example.com",    "content_type": "image/png",    "size": 0  },  "created_at": "2019-08-24T14:15:22Z"}

Get an entity GET

The business with its `kind` and its current certificate, if it has one. To find out what it still needs before issuing, use `GET /v1/ec/entities/{id}/readiness`.

Open a series POST

In your key's environment. Outside `sandbox`, the establishment must be listed as open for the RUC in the SRI registry; its address comes from there.