Skip to Content

Update a business

PATCH
/v1/ec/businesses/{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. The portal settings need a plan with portal branding (403 portal_branding_plan_required).

Authorization

headerAuthorizationBearer <token>

Your API key, which acts for the one business it was created for: fb_live_… keys work at api.fiscalbase.io and issue in live, and fb_sandbox_… keys work at api-sandbox.fiscalbase.io and issue in sandbox, on the simulated SRI. A key sent to the other host is refused with api_key_wrong_host, which names its host.

Path Parameters

id*string
Formatuuid

Header Parameters

Fiscalbase-Environment?string

The environment the call acts in. Required with a person's session; a key's own environment is the one that counts, so a key may leave it out, and naming another is 422 environment_mismatch.

Value in"sandbox""test""live"
Fiscalbase-Business?string

The business the call acts for. With a person's session, the one the call is about (without it, a call about one business is 422 business_required and a list covers every business of the organization); a key acts for its own, so naming another is 422 business_mismatch.

Formatuuid
Fiscalbase-Channel?string

Which of Fiscalbase's own integrations a key's call comes from, recorded as the channel of the documents it issues: a record, not a permission. Without it, api. A person's call is always console.

Value in"api""mcp"
Fiscalbase-Agent?string

The AI agent a key's call comes from, as its client names itself (the MCP server sets it); recorded with the request and shown in the console's request log.

Request Body

application/json
  1. body
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; read it again with GET /v1/ec/businesses/{id}/registry and take it with POST /v1/ec/businesses/{id}/registry/apply.

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?

How the portal looks. Only the settings you send change. Only Pro and A medida: another plan is refused with 403 portal_branding_plan_required.

Response Body

The business

application/json
  1. response
id*string
Formatuuid
object*"business"
Value in"business"
kind*string

sandbox: a practice business, with made-up data and the practice RUC 9999999999001; it issues only in sandbox, is free and can be deleted. live: a real RUC; it issues in test and live, is paid and cannot be deleted. Chosen on creation and never changes.

Value in"sandbox""live"
country*"ec"

The country, as its lowercase ISO 3166-1 alpha-2 code, the same as in the path (/v1/ec/…). New countries may appear.

Value in"ec"
ruc*string
legal_name*string
trade_name*string|null
head_office_address*string
head_office_phone*string|null
head_office_email*string|null
reply_to_email*string|null
footer_legend*string|null
keeps_accounting*boolean
regime*string
Value in"general""rimpe_emprendedor""rimpe_negocio_popular"
special_taxpayer_resolution*string|null
withholding_agent_resolution*string|null
large_taxpayer_resolution*string|null
certificate*|

The certificate that signs test and live documents: the most recent one you uploaded, while it is still valid; null if it is missing or expired, and then nothing is issued in test or live, even if an earlier one is still valid.

issuing*
portal*

What the business set about how its portal looks, each setting null while it sets nothing (the portal's default). The business keeps what it set when it moves to a plan without portal branding.

logo*|

The issuer's logo, shown on its portal, on the RIDE and in the emails to its customers.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X PATCH 'https://api.fiscalbase.io/v1/ec/businesses/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "business",
  "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"
  },
  "issuing": {
    "allowed": true,
    "lock": {
      "code": "plan_required",
      "message": "string",
      "canceled": true,
      "trial_ended": true
    },
    "state": "off",
    "active_since": "2019-08-24T14:15:22Z"
  },
  "portal": {
    "brand_color": "string",
    "title_font": "sora",
    "corners": "square",
    "layout": "split",
    "cover": "brand",
    "cover_url": "http://example.com",
    "heading": "string",
    "lead": "string",
    "tagline": "string",
    "top_bar": "white",
    "whatsapp": "string",
    "website": "string"
  },
  "logo": {
    "url": "http://example.com",
    "content_type": "image/png",
    "size": 0
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}