Demander API - Branches

This article is part of the REST Integration API documentation.

Documentation for querying, inserting, updating and deleting branches.

Consultation

List the company’s branches. Without filter, considers dataAlteracao from the last 6 months.

Rota: {host}/public/v1/filiais?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Caution

Pagination

• pagina — base 1 (default 1)
• limite — default 100, maximum 500

Filters

• filtroDataAlteracao — Y-m-d format
• operadorFiltro (optional) — <, >, =, <=, >= (default >=)

Return:

{
  "filiais": [
    {
      "codigo": "1",
      "descricao": "MATRIZ",
      "ativo": 1,
      "dataAlteracao": "2026-07-15 10:00:00"
    }
  ]
}

Insert or update

POST upsert by key codigo.

Rota: {host}/public/v1/filiais
Método: POST
Body: json

Property	Type	Size	Mandatory	Description
code	string	15	✓	Branch code. Unique identifier used to insert or update (upsert).
description	string	255	✓	Branch name.
active	int			Values: 0 or 1. Default on inclusion: 1.

Caution

Inclusion

• It is necessary to send all attributes that are mandatory. Return 201.

Update

• Only the codigo attribute is mandatory. Return 200.

Body:

{
  "codigo": "1",
  "descricao": "MATRIZ",
  "ativo": 1
}

Return:

{
  "codigo": "1",
  "descricao": "MATRIZ",
  "ativo": 1,
  "dataAlteracao": "2026-07-15 10:00:00"
}

Delete

Removes the branch.

Rota: {host}/public/v1/filiais?codigo={codigo}
Método: DELETE

Return:

{
  "mensagem": "Registro excluído com sucesso."
}