Fiscalbase
PlataformaEstado del servicio
GuíasReferencia de la APIMCP
Entities

Open a series

POST
/v1/ec/entities/{id}/series

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.

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.

document_type*string

Value in

  • "invoice"
  • "credit_note"
  • "debit_note"
  • "withholding"
  • "delivery_note"
  • "purchase_settlement"
establishment*string
Match^\d{3}$
emission_point*string
Match^\d{3}$
establishment_address?string
Length1 <= length <= 300
establishment_name?string

A name for the establishment, which is not printed on documents. All the establishment's series share it: it is stored on each one.

Length1 <= length <= 80
emission_point_name?string

A name for the emission point, which is not printed.

Length1 <= length <= 80
next_number?integer

The first number to hand out, if another system already used the earlier ones. 1 by default.

Range1 <= value <= 999999999

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/ec/entities/497f6eca-6276-4993-bfeb-53cbbbba6f08/series" \  -H "Content-Type: application/json" \  -d '{    "document_type": "invoice",    "establishment": "string",    "emission_point": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "object": "series",  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",  "country": "ec",  "environment": "sandbox",  "document_type": "invoice",  "establishment": "string",  "emission_point": "string",  "establishment_address": "string",  "establishment_name": "string",  "emission_point_name": "string",  "last_number": 0,  "issued_today": 0,  "active": true,  "created_at": "2019-08-24T14:15:22Z"}

Update an entity PATCH

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.

List an entity's series GET

Each series with its environment, its last number handed out and how many documents it issued today.