Search entities
POST /co/contaduria-chip/entities-search/v1 Dataset
Lists the entities that report to CHIP. Combine the filters.
as_of, query, total, page, per_page, total_pages, count and entities[]: entity_code, name, tax_id, tax_id_check_digit, address, phone, department, municipality, status, sector and nature.
Report index
POST /co/contaduria-chip/report-index/v1 Live
Lists what an entity reported, one step at a time: categories, then periods, then forms.
found, entity, categories[] (category_code, name, retired), category_code, periods[] (period, label, start_date, end_date), period, forms[] (form_code, name) and checked_at.
Report
POST /co/contaduria-chip/report/v1 Live
Returns one reported form with its rows.
found, entity, category, form, period, scope, submission_number, received_at, columns[], rows[] with their paging (total, page, per_page, total_pages, count), document_url, checked_at and served_from (see below). found is false, never an error, when the entity has not reported that form for that period.
This read can take longer than a typical request. It’s an
async job. By default the request waits inline and returns
{ data }, or you can poll / use a callback_url. A report read recently
answers at once: served_from says which, and checked_at when the
source was last asked.Search financial statements
POST /co/contaduria-chip/statements-search/v1 Dataset
Searches the full text of the financial statements and their notes. Combine the words with the filters.
as_of, the filters as read, total, total_is_exact, page, per_page, total_pages, count and results[]: each statement (statement_id, entity_code, entity_name, tax_id, department, municipality, sector, category_code, category_name, year, start_date, end_date, scope, submission_number, document_name, document_url, document_bytes, pages, text_length, checked_at) with matches[]: up to three passages, each with its page_number, text, start and end.
Financial statements
POST /co/contaduria-chip/statement/v1 Dataset
Returns one entity’s statements for a year and the text of the document.
as_of, found, entity_code, year and statement: the fields of a search result plus text_url, page_number and content (text, offset, total_length, has_more, next_offset, from_page, to_page). found is false, never an error, when no statements of that entity are held for that year.
How the three fit together
Start from the entity search to get a CHIP code. Ask the report index what that entity reported: its categories, then the periods of one category, then the forms of one period. Pass the four values (entity_code, category_code, period, form_code) to the report endpoint.
columns[] and rows[]
Every form has its own columns, so a report describes them instead of fixing them:
A parent row already totals its children: add up rows of one level, never of several.
submission_number and received_at say which submission the report shows. An entity that corrects a period sends a new one, so a later read of the same period can carry a new number.
document_url is Croma’s copy of the report as the source exports it, an Excel workbook with every row at every level.
Full reference
Schemas, all response fields, and an interactive playground.