History

Search what your business sells

GET
/v1/ec/items

The products and services your key's business has issued in its environment, from the lines of its own documents, most recently used first. Use it to draft the lines of a new document with the business's own descriptions, codes, prices and taxes. used_count says in how many documents each was issued.

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

Query Parameters

limit?integer

How many per page, from 1 to 100.

Range1 <= value <= 100
Default20
cursor?string

The next_cursor or prev_cursor of a previous response. Without a cursor, the first page.

Lengthlength <= 200
q?string

Words of the description (ignoring case and accents), or part of a code or auxiliary code. Every word must match.

Length1 <= length <= 100
document_type?string

Whose lines to read: invoice (the default), credit_note or purchase_settlement. The other types have no products.

Default"invoice"

Value in

  • "invoice"
  • "credit_note"
  • "purchase_settlement"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/ec/items"
{  "object": "list",  "data": [    {      "object": "item_suggestion",      "code": "string",      "auxiliary_code": "string",      "description": "string",      "unit": "string",      "unit_price": "string",      "discount_percent": "string",      "taxes": [        {          "type": "iva",          "rate": "string"        }      ],      "used_count": 0,      "last_used": "2019-08-24"    }  ],  "next_cursor": "string",  "prev_cursor": "string"}