Skip to Content

Retrieve a product

GET
/v1/ec/products/{id}

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.

Response Body

The product

application/json
  1. response
id*string
Formatuuid
object*"product"
Value in"product"
business_id*string
Formatuuid
environment*string
Value in"sandbox""test""live"
description*string

What the line says it sells, and what the catalog shows.

price_with_iva*|

What one unit costs on the shelf, IVA included. null for a product sold at an open_price that has none proposed. The ICE and IRBPNR a line carries are charged on top.

unit_price*|

The line's unit_price for this product: price_with_iva without its IVA, to six decimals. null when there is no price.

sold_by*string
Value in"unit""weight""open_price"
barcode*string|null
code*|

The line's code: the product's main code.

auxiliary_code*|

The line's auxiliary_code.

unit*|

The line's unit of measure.

taxes*array<||>

The line's taxes: one iva, and at most one ice and one irbpnr.

additional_info*array<>

The line's additional_info.

category_id*|
Formatuuid
favorite*boolean
position*integer
image*|null
archived_at*|

When it was archived: an archived product is out of the lists, the barcode lookup and the sale, and its barcode is free for another.

Formatdate-time
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X GET 'https://api.fiscalbase.io/v1/ec/products/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "object": "product",
  "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
  "environment": "sandbox",
  "description": "string",
  "price_with_iva": "string",
  "unit_price": "string",
  "sold_by": "unit",
  "barcode": "string",
  "code": "string",
  "auxiliary_code": "string",
  "unit": "string",
  "taxes": [
    {
      "type": "iva",
      "rate": "iva_15"
    }
  ],
  "additional_info": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "category_id": "8de4c9fd-61a4-4c0b-bf88-0ed3a0fe3fa2",
  "favorite": true,
  "position": 0,
  "image": {
    "url": "http://example.com",
    "width": 0,
    "height": 0
  },
  "archived_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}