MixFiscal

A MixFiscal

Apresentação

Um dos maiores desafios das redes varejistas do ramo de supermercados é a manutenção de uma base de cadastro de produtos corretamente classificado, que a cada dia modificam suas regras e exige atualização constante. Para isso, a Mix Fiscal desenvolveu ferramentas exclusivas de serviço de Classificação Fiscal de Mercadorias, em tempo real.

Missão

Encantar nossos clientes com soluções criativas, éticas e que produzam resultados reais no dia a dia de cada um deles. Acordar todo dia com o impulso de atender, servir e cuidar daqueles que escolheram confiar na nossa empresa e em cada colaborador que compartilha da nossa visão, indo além do mero dever contratual, e excedendo ao limite do alcance de cada um.

Visão

Sermos os líderes nacionais em Soluções tributárias e mercadológicas para o Varejo, de maneira a criar um impacto marcante e positivo nos nossos clientes, transformando as suas realidades e os resultados do varejo nacional.

Valores

Para nós não vale gol de mão. Nem vale tratar as pessoas como se não fossem únicas, capazes e especiais. Nem vale tratar os clientes como se não fosse o único motivo da empresa estar aberta. Mas vale muito esforço pessoal, comprometimento uns com os outros e muita paixão pelo que fazemos!

GET | Arquivos por tipo

Este endpoint lista todos os arquivos separados pelo tipo informado.

Propriedade	Descrição
`type`	(obrigatório) Tipo de arquivo a ser buscado

GET

/templates/files/type/{type}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/templates/files/type/{type}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "data": [
        {
            "_id": "5fe1ed7b7ec0970009809aba",
            "fileName": "1608641903055_IMPORT_FILE_SAMPLE.csv",
            "fileType": "csv",
            "uploadDate": "Tue Dec 22 2020 12:58:35 GMT+0000"
        },
        ...
    ]
}

GET | Arquivo por id

Este endpoint traz o arquivo de acordo com o ID informado

Propriedade	Descrição
`id`	(obrigatório) ID do arquivo
`field`	(opcional) Campo do arquivo (Válido para sped)

GET

/templates/files/file/{id}/?{field}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/templates/files/file/{id}/?{field}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "item": {
        "_id": "1a2b3c4d1a2b",
        "body": [
            {
                "data": [
                    ["C100", "00"],
                    ["C100", "00"],
                    ...
            }
    }
}

GET | Arquivo (SPED) por id

Este endpoint pega dados de um arquivo sped

Propriedade	Descrição
`id`	(obrigatório) Tipo de arquivo a ser buscado
`uuid`	(opcional) Pesquisa pelo UUID de um field (linha do arquivo sped)
`fatherUUID`	(opcional) Pesquisa pelos linhas de um arquivo que tem esse relacionamento
`fieldType`	(opcional) Tipo de linha no sped (Ex: C100)
`hasChilds`	(opcional) Lista os relacionamentos com os filhos dentro do sped (value: 1 ou true)
`hasParsed`	(opcional) Aplica os modelos de sped (linha Ex: C100) ao resultado deixando os campos com as referencias (value: 1 ou true)

GET

/templates/files/sped/{id}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/templates/files/sped/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "data": {
        "template": {
        "_id": "60935a82b5df330019ef0be4",
        "status": "valid",
        "body": [],
        "deleted": false,
        "userId": "5fb13d4beca4280040e73b42",
        "fileName": "1620269691916_1615685975095_sped_grande.txt",
        "fileType": "sped",
        "uploadDate": "Thu May 06 2021 02:54:58 GMT+0000 (Coordinated Universal Time)",
        "__v": 0,
        "tags": {
            "tipo": "contribuicoes",
            "versao": "003",
            "dtIni": "2015-09-01T00:00:00+00:00",
            "dtFin": "2015-09-30T00:00:00+00:00",
            "empresa": "SUPERMERCADO ZONA SUL SA DEP1",
            "cnpj": "33381286000151",
            "uf": "33381286000151"
        }
        },
        "items": [
        {
            "id": "60935bffffb8af000a36949b",
            "uuid": "e7bb0a6b-bbc0-4481-a059-d9e3b1791012",
            "fatherUUID": "c75268d1-aa75-465f-ab08-06860f8cb7df",
            "templateId": "60935a82b5df330019ef0be4",
            "fields": [
            "C100",
            "0",
            "1",
            "48771",
            "55",
            "00",
            "1",
            "3460",
            "33150833280439000174550010000034601000034680",
            "2015-08-29T00:00:00+00:00",
            "2015-09-01T00:00:00+00:00",
            122.64,
            "1",
            0,
            0,
            122.64,
            "9",
            0,
            0,
            0,
            45,
            8.55,
            112.04,
            5.14,
            0,
            2.01,
            9.31,
            0,
            0
            ],
            "parsed": {}
        }
        ]
    }
}

GET | Arquivo Linhas (SPED) por id

Este endpoint pega dados de um arquivo sped

Propriedade	Descrição
`id`	(obrigatório) Tipo de arquivo a ser buscado
`uuid`	(opcional) Pesquisa pelo UUID de um field (linha do arquivo sped)
`fatherUUID`	(opcional) Pesquisa pelos linhas de um arquivo que tem esse relacionamento
`fieldType`	(opcional) Tipo de linha no sped (Ex: C100)
`hasChilds`	(opcional) Lista os relacionamentos com os filhos dentro do sped (valores: 1 ou true)
`hasParsed`	(opcional) Aplica os modelos de sped (linha Ex: C100) ao resultado deixando os campos com as referencias (valores: 1 ou true)

GET

/templates/files/sped/{id}/fields

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/templates/files/sped/{id}/fields' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "data": [
        {
        "id": "60935bffffb8af000a36949b",
        "uuid": "e7bb0a6b-bbc0-4481-a059-d9e3b1791012",
        "fatherUUID": "c75268d1-aa75-465f-ab08-06860f8cb7df",
        "templateId": "60935a82b5df330019ef0be4",
        "fields": [
            "C100",
            "0",
            "1",
            "48771",
            "55",
            "00",
            "1",
            "3460",
            "33150833280439000174550010000034601000034680",
            "2015-08-29T00:00:00+00:00",
            "2015-09-01T00:00:00+00:00",
            122.64,
            "1",
            0,
            0,
            122.64,
            "9",
            0,
            0,
            0,
            45,
            8.55,
            112.04,
            5.14,
            0,
            2.01,
            9.31,
            0,
            0
        ],
        "parsed": {}
        }
    ]
}

GET | Campos específicos

Este endpoint valida a veracidade do arquivo, salva o conteúdo no banco de dados e envia o arquivo para um diretório S3 da Amazon.

Propriedade	Descrição
`type`	(obrigatório) Tipo de arquivo a ser buscado
`field`	(obrigatório) Campo a ser buscado no arquivo
`limit`	(obrigatório) Quantidade de campos a serem retornados

Exemplos de arquivos aceitos

sped
csv
xml
xlsx | excel | xls

Exemplos de campos aceitos

C100
C200
Outro campo qualquer do sped

GET

/templates/files/type/{type}/field/{field}/limit/{limit}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/templates/files/type/{type}/field/{field}/limit/{limit}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "data": [
        {
            "REG": "C100",
            "IND_OPER": "0",
            "IND_EMIT": "1",
            "COD_PART": "2700",
            "COD_MOD": "55",
            "COD_SIT": "00",
            "SER": "100",
            "NUM_DOC": "2",
            "CHV_NFE": "41151207375191000115551000000000027209338140",
            "DT_DOC": "03122015",
            "DT_E_S": "08122015",
            "VL_DOC": "782",
            "IND_PGTO": "1",
            "VL_DESC": "0",
            "VL_ABAT_NT": "",
            "VL_MERC": "782",
            "IND_FRT": "0",
            "VL_FRT": "0",
            "VL_SEG": "0",
            "VL_OUT_DA": "0",
            "VL_BC_ICMS": "0",
            "VL_ICMS": "0",
            "VL_BC_ICMS_ST": "0",
            "VL_ICMS_ST": "0",
            "VL_IPI": "0",
            "VL_PIS": "0",
            "VL_COFINS": "0",
            "VL_PIS_ST": "",
            "VL_COFINS_ST": ""
        },
        ...
    ]
}

GET | Listar todos arquivos

Este endpoint lista todos os arquivos enviados.

GET

/templates/files/all

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/templates/files/all' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "data": [
        {
            "type": "xls",
            "files": [
                {
                    "_id": "7yeg12hf012fr23",
                    "file": "item.xlsx",
                    "uploadDate": "Mon Dec 21 2020 22:54:01 GMT+0000"
                },
                {
                    "_id": "7yeg12hf012fr23",
                    "file": "item.xlsx",
                    "uploadDate": "Mon Dec 21 2020 22:54:01 GMT+0000"
                },
            ]
        }
    ]
}

GET | Fluxo por id

Este endpoint traz um fluxo de acordo com o ID do banco de dados.

Propriedade	Descrição
`id`	(opcional) ID do fluxo

GET

/templates/flows/flow/{id}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/templates/flows/flow/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
  "item": {
      "body": [
          {
              "foo": "bar"
          }
      ],
      "deleted": false,
      "_id": "f0qh0832hf7832h02f11f1",
      "name": "Flow de teste 4",
      "isDraft": true,
      "userId": "fr127t812y9uf29fy32h0",
      "createdAt": "2021-02-09T03:40:08.231Z",
      "updatedAt": "2021-02-09T03:42:43.648Z",
      "__v": 0
  }
}

GET | Fluxos publicados

Este endpoint lista todos os fluxos publicados

GET

/templates/flows/publisheds

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/templates/flows/publisheds' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

[
  {
    "item": {
        "body": [
            {
                "foo": "bar"
            }
        ],
        "deleted": false,
        "_id": "f0qh0832hf7832h02f11f1",
        "name": "Flow de teste 4",
        "isDraft": false,
        "userId": "fr127t812y9uf29fy32h0",
        "createdAt": "2021-02-09T03:40:08.231Z",
        "updatedAt": "2021-02-09T03:42:43.648Z",
        "__v": 0
    }
  },
]

GET | Fluxos rascunhos

Este endpoint lista todos os fluxos rascunhos

GET

/templates/flows/drafts

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/templates/flows/drafts' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

[
  {
    "item": {
        "body": [
            {
                "foo": "bar"
            }
        ],
        "deleted": false,
        "_id": "f0qh0832hf7832h02f11f1",
        "name": "Flow de teste 4",
        "isDraft": true,
        "userId": "fr127t812y9uf29fy32h0",
        "createdAt": "2021-02-09T03:40:08.231Z",
        "updatedAt": "2021-02-09T03:42:43.648Z",
        "__v": 0
    }
  },
]

PUT | Alterar fluxo

Este endpoint altera um fluxo no banco de dados.

Propriedade	Descrição
`id`	(opcional) ID do fluxo
`name`	(opcional) Nome do fluxo
`body`	(opcional) Corpo do fluxo
`isDraft`	(opcional) Se é rascunho
`userId`	(opcional) Usuário responsável pelo fluxo

PUT

/templates/flows/flow/{id}

Exemplo de Requisição

curl --location --request PUT 'https://api.builder.mixfiscal.com.br/templates/flows/flow/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Flow de teste 4"
}'

Exemplo de Resposta

{
  "item": {
      "body": [
          {
              "foo": "bar"
          }
      ],
      "deleted": false,
      "_id": "f0qh0832hf7832h02f11f1",
      "name": "Flow de teste 4",
      "isDraft": true,
      "userId": "fr127t812y9uf29fy32h0",
      "createdAt": "2021-02-09T03:40:08.231Z",
      "updatedAt": "2021-02-09T03:42:43.648Z",
      "__v": 0
  }
}

Este endpoint irá retornar o token no qual será usado para fazer as outras requisições.

Propriedade	Descrição
`email`	(obrigatório) email cadastrado
`hash`	(obrigatório) hash que corresponde ao usuário

POST

/templates/login

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/templates/login' \
--header 'Content-Type: application/json' \
--data-raw '{
     "email": "email@teste.com",
     "hash": "a1b2c3"
}'

Exemplo de Resposta

{
    "token": "afe129vadva68fewvf9n0b2ufh28rfh308tyhf02jf03q8uvn"
}

POST | Enviar Arquivo

Este endpoint valida a veracidade do arquivo, salva o conteúdo no banco de dados e envia o arquivo para um diretório S3 da Amazon.

Propriedade	Descrição
`file`	(obrigatório) Arquivo a ser enviado
`userId`	(obrigatório) ID do usuário responsável pelo arquivo

POST

/templates/sendFile

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/templates/sendFile' \
--header 'Authorization: Bearer {token}' \
--form 'file=@"/C:/Users/user/Documents/file.txt"' \
--form 'userId="{userID}"'

Exemplo de Resposta

{
    "status": true,
    "message": "File uploaded.",
    "data": [
        {
            "id": 1,
            "destination": "S3",
            "name": "file.txt",
            "type": "sped",
            "mimetype": "text/plain",
            "checked": {
                "status": true,
                "message": ""
            },
            "sended": true
        }
    ]
}

POST | Arquivo por fluxo

Este endpoint lista os arquivos pelo fluxo

Propriedade	Descrição
`type`	(obrigatório) Tipo de arquivo a ser buscado

Tipos de arquivos aceitos

sped
csv
xml
xlsx | excel | xls

POST

/templates/files/flow

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/templates/files/flow' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payload": [
        { "type": "C100", "fileExtension": "txt", "fileId": null },
        { "type": "C170", "fileExtension": "txt", "fileId": null },
        { "type": "CSV", "fileExtension": "csv", "fileId": "9hf310f3mv3" },
        { "type": "EXCEL", "fileExtension": "xls", "fileId": "fm0q3ufh0q3vnq30u8" }
    ]
}'

Exemplo de Resposta

{
    "data": [
        {
            "type": "C100",
            "body": [
                {
                    "data": []
                }
            ]
        },
        {
            "type": "C170",
            "body": [
                {
                    "data": []
                }
            ]
        },
        ...
    ]
}

POST | Inserir Fluxo

Este endpoint insere um fluxo no banco de dados.

Propriedade	Descrição
`name`	(obrigatório) Nome do fluxo
`body`	(obrigatório) Corpo do fluxo
`isDraft`	(obrigatório) Se é rascunho
`userId`	(obrigatório) Usuário responsável pelo fluxo

POST

/templates/flows/flow

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/templates/flows/flow' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Flow de teste",
    "body": [{
        "foo": "bar"
    }],
    "isDraft": true,
    "userId": "afa1fewf243f3qfq23"
}'

Exemplo de Resposta

{
  "item": {
      "body": [
          {
              "foo": "bar"
          }
      ],
      "_id": "f9fj9328jf0232vqhy2",
      "deleted": false,
      "name": "Flow de teste",
      "isDraft": true,
      "userId": "nvu8ewfn0ewjfew9fjwef",
      "createdAt": "2021-02-09T03:40:08.231Z",
      "updatedAt": "2021-02-09T03:40:08.231Z",
      "__v": 0
  }
}

POST | Publica fluxo

Este endpoint publica um fluxo que estava como rascunho

Propriedade	Descrição
`id`	(opcional) ID do fluxo

POST

/templates/flows/flow/{id}/publish

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/templates/flows/flow/{id}/publish' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
  "item": {
      "body": [
          {
              "foo": "bar"
          }
      ],
      "deleted": false,
      "_id": "f0qh0832hf7832h02f11f1",
      "name": "Flow de teste 4",
      "isDraft": false,
      "userId": "fr127t812y9uf29fy32h0",
      "createdAt": "2021-02-09T03:40:08.231Z",
      "updatedAt": "2021-02-09T03:42:43.648Z",
      "__v": 0
  }
}

DELETE | Deletar arquivo

Este endpoint remove o arquivo enviado de acordo com o ID informado.

Propriedade	Descrição
`id`	(obrigatório) ID do arquivo

DELETE

/templates/files/file/{id}

Exemplo de Requisição

curl --location --request DELETE 'https://api.builder.mixfiscal.com.br/templates/files/file/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "item": true
}

DELETE | Deletar fluxo

Este endpoint deleta um fluxo no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do fluxo

DELETE

/templates/flows/flow/{id}

Exemplo de Requisição

curl --location --request DELETE 'https://api.builder.mixfiscal.com.br/templates/flows/flow/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "item": {
        "n": 1,
        "nModified": 1,
        "ok": 1,
    }
}

GET | Empresas

Este endpoint lista todas as empresas cadastradas.

GET

/authorizations/companies

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/companies' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "companies": [
        {
            "_id": "r398r0j351r267g87yhi2uf",
            "company_name": "Mixfiscal",
            "jwt_token": "Bearer f9823h8023028j20j2-23jf-2",
            "createdAt": "2020-11-15T14:38:03.635Z",
            "updatedAt": "2020-11-15T14:38:03.635Z",
            "__v": 0
        },
        ...
    ]
}

GET | Dados da empresa

Este endpoint retorna os dados da empresa associada ao usuário autenticado.

GET

/authorizations/company

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/company' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "company": {
        "_id": "6f729r8h2398rh23",
        "company_name": "Mixfiscal",
        "jwt_token": "Bearer 4152e6fg1287e128eg12e12",
        "createdAt": "2020-11-15T14:38:03.635Z",
        "updatedAt": "2020-11-15T14:38:03.635Z",
        "__v": 0
    }
}

GET | Funcionários

Este endpoint lista todos os funcionários

GET

/authorizations/employees

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/employees' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "employees": {
        "docs": [],
        "totalDocs": 0,
        "offset": null,
        "limit": 0,
        "totalPages": null,
        "page": null,
        "pagingCounter": null,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": null,
        "nextPage": null
    }
}

GET | Funcionário

Este endpoint traz os detalhes de um usuário de acordo com o ID fornecido.

Propriedade	Descrição
`id`	(obrigatório) ID do fluxo

GET

/authorizations/employee/{id}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/employee/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "user": {
        "_id": "17526879218r129hrff",
        "name": "Usuario Teste",
        "email": "teste@hotmail.com",
        "country": "brazil",
        "cpf": "67890128412",
        "is_admin": true,
        "birth": "1993-01-11",
        "salt": "8129rh12rh9128r012",
        "hash": "b8r12ye9h1298e1283eu1290j0129ej120jd0129dj0219jd0129jd12",
        "type": "admin",
        "company": "219eh0821d12udj120dj12-",
        "createdAt": "2020-11-15T14:38:03.655Z",
        "updatedAt": "2021-02-06T19:33:51.266Z",
        "__v": 0
    }
}

GET | Modelos de Sped

Este endpoint traz todos os modelos de sped

Propriedade	Descrição
`type`	(opcional) tipo do campo
`version`	(opcional) versão do sped

GET

/authorizations/spedmodelsList

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/spedmodelsList?type={type}&version={version}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "spedmodels": [
        {
            "_id": "18e7912ey1279ey1297ey1278hd128dn",
            "name": "C001 - Abertura do Bloco C"
        },
        ...
    ]
}

GET | Sped por String

Este endpoint traz todos os modelos de sped filtrados por string

Propriedade	Descrição
`type`	(obrigatório) tipo do campo
`version`	(obrigatório) versão do sped
`string`	(obrigatório) termo a ser buscado

GET

/authorizations/spedmodelsList/:string

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/spedmodelsList/{string}?type={type}&version={version}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "spedmodels": [
        {
            "_id": "r5816r712rh29rh21rh120f",
            "fields": [
                {
                    "_id": "r5816r712rh29rh21rh120f",
                    "name": "REG",
                    "field_number": 1,
                    "description": "Texto fixo contendo C100",
                    "type": "String",
                    "size": "4",
                    "required": false,
                    "validation_rule": "",
                    "regex_validation": "",
                    "validation_only_warning": true
                },
                ...
            ],
            "father_id": "r5816r712rh29rh21rh120f",
            "name": "C100 - Documento - NF, NF Avulsa, NF de Produtor e NFe",
            "type": "contribuicoes",
            "version": "100",
            "register": "C100",
            "createdAt": "2021-01-06T14:49:57.720Z",
            "updatedAt": "2021-01-06T14:49:57.720Z",
            "__v": 0
        }
    ]
}

GET | Modelo de Sped por parametros (Id)

Este endpoint traz um modelo sped que se encaixe nos parametros passados

Propriedade	Descrição
`id`	(obrigatório) tipo do campo
`version`	(não obrigatório) versão do sped
`type`	(não obrigatório) tipo do sped

GET

/authorizations/spedmodelsList/:string

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/spedmodel?id={id}&type={type}&version={version}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "spedmodel": {
        "_id": "r5816r712rh29rh21rh120f",
        "fields": [
            {
                "_id": "r5816r712rh29rh21rh120f",
                "name": "REG",
                "field_number": 1,
                "description": "Texto fixo contendo C100",
                "type": "String",
                "size": "4",
                "required": false,
                "validation_rule": "",
                "regex_validation": "",
                "validation_only_warning": true
            },
            ...
        ],
        "father_id": "r5816r712rh29rh21rh120f",
        "name": "C100 - Documento - NF, NF Avulsa, NF de Produtor e NFe",
        "type": "contribuicoes",
        "version": "100",
        "register": "C100",
        "createdAt": "2021-01-06T14:49:57.720Z",
        "updatedAt": "2021-01-06T14:49:57.720Z",
        "__v": 0
    }
}

GET | Versões do Sped

Este endpoint lista todas as versões do Sped

GET

/authorizations/spedVersions?type=fiscal

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/spedVersions?type=fiscal' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "spedmodels": [
        "100",
        "101",
        "102",
        "103",
        "104",
        "105",
        "106",
        "107",
        "108",
        "109",
        "110",
        "111",
        "112",
        "113"
    ]
}

GET | Modelos de Xml

Este endpoint traz todos os modelos de Xml

Propriedade	Descrição
`version`	(opcional) versão do Xml

GET

/authorizations/xmlmodelsList

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/xmlmodelsList?version={version}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "xmlmodels": [
        {
            "_id": "e8721eh812e012",
            "name": "- TAG raiz do CF-e"
        },
        ...
    ]
}

GET | Xml por String

Este endpoint traz todos os modelos de Xml filtrados por string

Propriedade	Descrição
`version`	(obrigatório) versão do Xml
`string`	(obrigatório) termo a ser buscado

GET

/authorizations/xmlmodelsList/:string

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/xmlmodelsList/{string}?version={version}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "xmlmodels": [
        {
            "_id": "101829e2108fn12fn012fn12",
            "fields": [
                {
                    "_id": "17208dj12uf12uf120f1f1h2f",
                    "name": "infCFe",
                    "field_group": "A01",
                    "description": "Os campos: versao versaoDadosEnt versaoSB e Id são atributos neste campo (infCFe).",
                    "type": "Object",
                    "size": "255",
                    "required": false,
                    "validation_rule": "",
                    "regex_validation": "",
                    "validation_only_warning": true
                }
            ],
            "father_id": "",
            "name": "A01 - Grupo de informações do CF-e SAT",
            "version": "0.06",
            "register": "A01",
            "createdAt": "2021-02-07T13:52:33.552Z",
            "updatedAt": "2021-02-07T13:52:33.552Z",
            "__v": 0
        },
        ...
    ]
}

GET | Versões do XML

Este endpoint lista todas as versões do XML

GET

/authorizations/xmlVersions

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/authorizations/xmlVersions' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "xmlmodels": [
        "0.06"
    ]
}

GET | Listas de Relatórios

Este endpoint lista todas as Listas de Relatórios

GET

/reports

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/reports?page=1&limit=10' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "reports": {
        "docs": [            {
                "_id": "08f32h023h0qun30qu",
                "name": "Relatório de Envios",
                "content": "Este é o relatório atualizado...",
                "comments": [
                    {
                        "_id": "r0u32hr023g2n-39hj23",
                        "content": "O relatório contem o valor X!",
                        "created_at": "2021-02-28T22:57:10.067Z"
                    }
                ],
                "createdAt": "2021-02-28T22:57:10.073Z",
                "updatedAt": "2021-02-28T22:57:59.959Z",
                "__v": 0
            }
        ],
        "totalDocs": 2,
        "offset": 0,
        "limit": 100,
        "totalPages": 1,
        "page": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": null,
        "nextPage": null
    }
}

GET | Relatório por id

Este endpoint retorna o relatório pelo id informado

GET

/report/:id

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/report/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "reports": {
        "_id": "1f08h021hf012fh",
        "name": "Relatório de Envios",
        "content": "Lorem ipsum dolor sit amet",
        "comments": [
            {
                "_id": "d120hd821hd012d89120h",
                "content": "O relatório contem o valor X!",
                "created_at": "2021-02-28T21:48:11.077Z"
            }
        ],
        "createdAt": "2021-02-28T21:48:11.078Z",
        "updatedAt": "2021-02-28T21:48:11.078Z",
        "__v": 0
    }
}

GET | Listas de Chaves da API

Este endpoint lista todas as Chaves da API

GET

/apiKeys

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/apiKeys?page=1&limit=10' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "reports": {
        "docs": [
            {
                "getRequest": false,
                "putRequest": false,
                "deleteRequest": false,
                "_id": "fu32f80qh23hq238fh02",
                "name": "API KEY",
                "isPublic": true,
                "key": "eyJhbGciO9.U3VuIEOjQ2IEdNVC0wMzAwIChHTVQtMDM6MDApbWl4RmlzY2Fs.-OHHFcF_ikoeshl69QPtdFY84h7eR8",
                "createdAt": "2021-02-28T23:31:46.676Z",
                "updatedAt": "2021-02-28T23:31:46.676Z",
                "__v": 0
            }
        ],
        "totalDocs": 6,
        "offset": 0,
        "limit": 100,
        "totalPages": 1,
        "page": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": null,
        "nextPage": null
    }
}

GET | Chave de Api por id

Este endpoint retorna a Chave de Api pelo id informado

GET

/apiKey/:id

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/apiKey/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "reports": {
        "getRequest": false,
        "putRequest": false,
        "deleteRequest": false,
        "_id": "603c240aacc31e18f0f0b114",
        "name": "API KEY",
        "key": "fiuoaf0h28f23fh30g02h23",
        "isPublic": true,
        "createdAt": "2021-02-28T23:15:22.105Z",
        "updatedAt": "2021-02-28T23:15:22.105Z",
        "__v": 0
    }
}

GET | Grupos de Acesso

Este endpoint retorna todos os grupos de acesso

GET

/accessGroups

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/accessGroups?page=1&limit=10' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "accessGroups": {
        "docs": [
            {
                "_id": "u9810912fj90128hf9012",
                "groupName": "Administradores",
                "modules": [
                    {
                        "rules": {
                            "read": true,
                            "edit": true,
                            "record": true,
                            "remove": true
                        },
                        "father_id": "",
                        "_id": "f9128fj12908fj12098fj12",
                        "name": "Dashboard"
                    }
                ],
                "createdAt": "2021-03-01T02:15:36.514Z",
                "updatedAt": "2021-03-01T02:15:36.514Z",
                "__v": 0
            }
        ],
        "totalDocs": 1,
        "offset": 0,
        "limit": 100,
        "totalPages": 1,
        "page": 1,
        "pagingCounter": 1,
        "hasPrevPage": false,
        "hasNextPage": false,
        "prevPage": null,
        "nextPage": null
    }
}

GET | Grupos de Acesso

Este endpoint retorna todos os grupos de acesso

GET

/accessGroups/{id}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/accessGroups/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "accessGroups": {
        "_id": "9rj21jf021j9120jf21",
        "groupName": "Administradores",
        "modules": [
            {
                "rules": {
                    "read": true,
                    "edit": true,
                    "record": true,
                    "remove": true
                },
                "father_id": "",
                "_id": "90gj4q309gjq394gj",
                "name": "Dashboard"
            }
        ],
        "createdAt": "2021-03-01T02:17:10.127Z",
        "updatedAt": "2021-03-01T02:17:10.127Z",
        "__v": 0
    }
}

GET | Usuário pelo email

Este endpoint retorna os usuários buscando pelo email

Propriedade	Descrição
`email`	(obrigatório) email a ser buscado

GET

/users/email/{email}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/users/email/{email}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "user": {
        "officeHour": {
            "afterHoursAccess": true,
            "entryTime": "00:00",
            "departureTime": "23:59"
        },
        "permissions": {
            "export": {
                "xml": false,
                "pdf": false,
                "csv": false,
                "txt": false
            },
            "import": {
                "xml": false,
                "pdf": false,
                "csv": false,
                "txt": false
            }
        },
        "contractService": true,
        "isActive": true,
        "acceptInvite": false,
        "classification": 4,
        "_id": "812f12fh9128fh12",
        "name": "User",
        "email": "email@teste.com",
        "country": "brazil",
        "cpf": "00000000000",
        "birth": "1994-11-23",
        "type": "admin",
        "browser_id": "any",
        "company": "f012hf0182fh128fh21",
        "googleKey": null,
        "department": "Geral",
        "responsibility": "Desenvolvedor",
        "accessGroup": "f8u012h712hf2189f12",
        "qrCode": "+OhAAAABlBMVEX///8AAABVwtN+AAABIUlEQVRIib2VO5LEIAxE2+XAIUfgKL7YlhluxlF8BEICytqWmN9uTThIRcJzgNxqScCHSMIoa903kRb10r7OfvhOKB3QW7wBixML0kNZRRBzi1kke7IeRE7AnQF7+5/LZDa0D0XOA3/rMZUNr5FZLu/+m8tGrEIZ0uPmwZhLV/lZ80QZNirhwtjNbKyOXT2OY5ObD0tVBeCxLA5TwoNpN+sgKTpI4uXJNOpuRsvmtW+zpI4ynbFYK+nTDoz9S1M9bHxtZ2o+LAittVaMVm5aYhemudz30YjmwkZQe/v7RbSPPNhzTupk5l7QLx5s7AVqbxthHBdme1BekV1ZVe0NAK6MXrtsTr40mMtMe5YdkSvpvR5z2fAaDzeRLqMoPuxD/AICqMhj6ORAQgAAAABJRU5ErkJggg==",
        "createdAt": "2021-03-01T03:56:20.378Z",
        "updatedAt": "2021-03-01T03:56:20.378Z",
        "__v": 0
    }
}

GET | Usuário pelo id

Este endpoint retorna os usuários buscando pelo id

Propriedade	Descrição
`id`	(obrigatório) id a ser buscado

GET

/users/{id}

Exemplo de Requisição

curl --location --request GET 'https://api.builder.mixfiscal.com.br/v1/users/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true,
    "user": {
        "officeHour": {
            "afterHoursAccess": true,
            "entryTime": "00:00",
            "departureTime": "23:59"
        },
        "permissions": {
            "export": {
                "xml": false,
                "pdf": false,
                "csv": false,
                "txt": false
            },
            "import": {
                "xml": false,
                "pdf": false,
                "csv": false,
                "txt": false
            }
        },
        "contractService": true,
        "isActive": true,
        "acceptInvite": false,
        "classification": 4,
        "_id": "812f12fh9128fh12",
        "name": "User",
        "email": "email@teste.com",
        "country": "brazil",
        "cpf": "00000000000",
        "birth": "1994-11-23",
        "type": "admin",
        "browser_id": "any",
        "company": "f012hf0182fh128fh21",
        "googleKey": null,
        "department": "Geral",
        "responsibility": "Desenvolvedor",
        "accessGroup": "f8u012h712hf2189f12",
        "qrCode": "+OhAAAABlBMVEX///8AAABVwtN+AAABIUlEQVRIib2VO5LEIAxE2+XAIUfgKL7YlhluxlF8BEICytqWmN9uTThIRcJzgNxqScCHSMIoa903kRb10r7OfvhOKB3QW7wBixML0kNZRRBzi1kke7IeRE7AnQF7+5/LZDa0D0XOA3/rMZUNr5FZLu/+m8tGrEIZ0uPmwZhLV/lZ80QZNirhwtjNbKyOXT2OY5ObD0tVBeCxLA5TwoNpN+sgKTpI4uXJNOpuRsvmtW+zpI4ynbFYK+nTDoz9S1M9bHxtZ2o+LAittVaMVm5aYhemudz30YjmwkZQe/v7RbSPPNhzTupk5l7QLx5s7AVqbxthHBdme1BekV1ZVe0NAK6MXrtsTr40mMtMe5YdkSvpvR5z2fAaDzeRLqMoPuxD/AICqMhj6ORAQgAAAABJRU5ErkJggg==",
        "createdAt": "2021-03-01T03:56:20.378Z",
        "updatedAt": "2021-03-01T03:56:20.378Z",
        "__v": 0
    }
}

PUT | Alterar usuário

Este endpoint altera um usuário no banco de dados.

Propriedade	Descrição
`name`	(opcional) Nome do usuário
`email`	(opcional) Email do usuário
`country`	(opcional) País do usuário
`cpf`	(opcional) CPF do usuário
`is_admin`	(opcional) Tipo de Usuário
`birth`	(opcional) Dt. Nascimento

PUT

/authorizations/user

Exemplo de Requisição

curl --location --request PUT 'https://api.builder.mixfiscal.com.br/authorizations/user' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nome de teste 4"
}'

Exemplo de Resposta

{
    "response": true,
    "user": {
        "_id": "812eg79h129eh12e12",
        "name": "Usuario",
        "email": "usuario@hotmail.com",
        "country": "brazil",
        "cpf": "9318231241",
        "is_admin": true,
        "birth": "1993-01-11",
        "salt": "0f2263c5f6f5e68e7b4a0b789c80c4e2",
        "hash": "fewofminwae12ej12-e12fj6",
        "type": "admin",
        "company": "f937hf18fh18f01f",
        "createdAt": "2020-11-15T14:38:03.655Z",
        "updatedAt": "2021-02-10T02:14:30.857Z",
        "__v": 0
    }
}

PUT | Alterar modelo do Sped

Este endpoint altera um modelo de sped no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do usuário
`fields`	(opcional) campos do modelo de sped
`father_id`	(opcional) id do item pai
`name`	(opcional) nome da regra
`type`	(opcional) tipo de sped
`version`	(opcional) versão da regra
`register`	(opcional) registro do sped

PUT

/authorizations/spedmodels/{id}

Exemplo de Requisição

curl --location --request PUT 'https://api.builder.mixfiscal.com.br/authorizations/spedmodels/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nome da regra"
}'

Exemplo de Resposta

{
    "_id": "182e9hd182hd128fh012f",
    "fields": [
        {
            "_id": "r9378fh83h2f80h23uf23f",
            "name": "REG",
            "field_number": 1,
            "description": "Texto fixo contendo  0000.",
            "type": "String",
            "size": "4",
            "required": false,
            "validation_rule": "",
            "regex_validation": "",
            "validation_only_warning": true
        },
    ],
    "father_id": "",
    "name": "0000 - Abertura do Arquivo Digital e Identificacao da entidade",
    "type": "fiscal",
    "version": "100",
    "register": "0000",
    "createdAt": "2021-01-06T14:40:18.073Z",
    "updatedAt": "2021-01-06T14:40:18.073Z",
    "__v": 0,
    "id": "e921eh120ufh12-f821fh12",
    "fatherDetails": ""
}

PUT | Alterar modelo do Xml

Este endpoint altera um modelo de xml no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do usuário
`fields`	(opcional) campos do modelo de xml
`father_id`	(opcional) id do item pai
`name`	(opcional) nome da regra
`type`	(opcional) tipo de xml
`version`	(opcional) versão da regra
`register`	(opcional) registro do xml

PUT

/authorizations/xmlmodels/{id}

Exemplo de Requisição

curl --location --request PUT 'https://api.builder.mixfiscal.com.br/authorizations/xmlmodels/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nome da regra"
}'

Exemplo de Resposta

{
    "_id": "179he0128eh1208j120hf",
    "fields": [
        {
            "_id": "d1278dh01208d7h120d12",
            "name": "CFe",
            "field_group": "-",
            "description": "TAG raiz do CF-e",
            "type": "Object",
            "size": "255",
            "required": false,
            "validation_rule": "",
            "regex_validation": "",
            "validation_only_warning": true
        }
    ],
    "father_id": "",
    "name": "- - TAG raiz do CF-e",
    "version": "0.06",
    "register": "-",
    "createdAt": "2021-02-09T02:07:05.837Z",
    "updatedAt": "2021-02-09T02:07:05.837Z",
    "__v": 0,
    "id": "e1280hej128eh1208eh12",
    "fatherDetails": ""
}

PUT | Atualizar Relatório

Este endpoint altera um relatório no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do relatorio
`name`	(opcional) nome do relatório
`content`	(opcional) conteúdo do relatório
`comments.name`	(opcional) comentários do relatório

PUT

/report/{id}

Exemplo de Requisição

curl --location --request PUT 'https://api.builder.mixfiscal.com.br/v1/report/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nome do relatório"
}'

Exemplo de Resposta

{
    "response": {
        "_id": "603c0f9b28d9b9080c7241b9",
        "name": "Nome do relatório",
        "content": "Este é o relatório atualizado...",
        "comments": [
            {
                "_id": "603c0f9b28d9b9080c7241ba",
                "content": "O relatório contem o valor X!",
                "created_at": "2021-02-28T21:48:11.077Z"
            }
        ],
        "createdAt": "2021-02-28T21:48:11.078Z",
        "updatedAt": "2021-03-01T00:50:29.970Z",
        "__v": 0
    }
}

PUT | Atualizar Chave de API

Este endpoint altera uma chave de api no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID da chave
`name`	(opcional) nome da chave
`getRequest`	(opcional) habilita/desabilita get
`putRequest`	(opcional) habilita/desabilita put
`deleteRequest`	(opcional) habilita/desabilita delete
`isPublic`	(opcional) habilita/desabilita chave para ser pública

PUT

/apiKey/{id}

Exemplo de Requisição

curl --location --request PUT 'https://api.builder.mixfiscal.com.br/v1/apiKey/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nome da Chave"
}'

Exemplo de Resposta

{
    "response": {
        "getRequest": false,
        "putRequest": false,
        "deleteRequest": false,
        "_id": "ej012e912e0-j12-0120-",
        "name": "Api Key Atualizado.",
        "isPublic": true,
        "key": "eyJhbGciOiJIJ9.U3VuIEZC0wMzAwIChHTVQtMDM6MDApbWl4RmlzY2Fs.xOGbPDb5RZpUt_m2FC15EHzXKWInpdpW6y",
        "createdAt": "2021-02-28T23:31:48.248Z",
        "updatedAt": "2021-02-28T23:35:43.989Z",
        "__v": 0
    }
}

PUT | Atualizar grupo

Este endpoint altera um grupo de acesso no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do grupo
`groupName`	(opcional) nome do grupo
`modules[]`	(opcional) array de modulos
`modules.rules`	(opcional) objeto do modulo
`modules.father_id`	(opcional) Caso haja hierarquia, será o módulo pai
`modules.name`	(opcional) nome do módulo

PUT

/accessGroup/{id}

Exemplo de Requisição

curl --location --request PUT 'https://api.builder.mixfiscal.com.br/v1/accessGroup/{id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupName": "Nome do Grupo"
}'

Exemplo de Resposta

{
    "response": {
        "_id": "603c4e481b568f1564903588",
        "groupName": "Administradores",
        "modules": [
            {
                "rules": {
                    "read": true,
                    "edit": true,
                    "record": true,
                    "remove": true
                },
                "father_id": "",
                "_id": "603c4e481b568f1564903589",
                "name": "Dashboard"
            }
        ],
        "createdAt": "2021-03-01T02:15:36.514Z",
        "updatedAt": "2021-03-01T02:16:52.728Z",
        "__v": 0
    }
}

Este endpoint fará a autenticação do usuário na aplicação.

Propriedade	Descrição
`email`	(obrigatório) email cadastrado
`password`	(obrigatório) senha cadastrada
`browser_id`	(opcional) id do navegador
`googleAuth`	(opcional) hash caso login seja feito usando autenticação do google.

POST

/authorizations/login

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/authorizations/login' \
--header 'Content-Type: application/json' \
--data-raw '{
     "email": "email@teste.com",
     "password": "a1b2c3"
}'

Exemplo de Resposta

{
    "response": true,
    "token": "Bearer eyhf018hf01fh12fh012fhjn12ufn12ufn120ufb12ifpjbn12fi12jnf1i2ofbh120fhb12u0",
    "user": {
        "_id": "h0128hf0128fh210r42",
        "name": "Usuario",
        "email": "usuarioteste@hotmail.com",
        "country": "brazil",
        "cpf": "2213921312",
        "is_admin": true,
        "birth": "1993-01-11",
        "salt": "9ej129je129nf129gbnu12gh2",
        "hash": "5un0ufnuw10u102eh1208eh218rh081th10g",
        "type": "admin",
        "company": "d129dj1280hf1082gh128gh12",
        "createdAt": "2020-11-15T14:38:03.655Z",
        "updatedAt": "2021-02-10T02:14:30.857Z",
        "__v": 0
    }
}

POST | Esqueci minha senha

Este endpoint irá recuperar a senha esquecida

Propriedade	Descrição
`email`	(obrigatório) email cadastrado

POST

/authorizations/forgetPassword

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/authorizations/forgetPassword' \
--header 'Content-Type: application/json' \
--data-raw '{
     "email": "email@teste.com"
}'

Exemplo de Resposta

{
    "response": true
}

POST | Criação de usuário

Este endpoint criar um usuario

Propriedade	Descrição
`name`	(obrigatório) Nome do Usuário
`surname`	(obrigatório) Sobrenome
`email`	(obrigatório) Email
`responsibility`	(obrigatório) Cargo
`password`	(obrigatório) Senha
`type`	(obrigatorio) Default = admin
`officeHour.afterHoursAccess`	(opcional) Permitir login após horário de trabalho
`officeHour.entryTime`	(obrigatório) Horario de Entrada
`officeHour.departureTime`	(obrigatório) Horario de Saida
`permissions.export.xml`	(obrigatório) Exportar XML
`permissions.export.pdf`	(obrigatório) Exportar PDF
`permissions.export.csv`	(obrigatório) Exportar CSV
`permissions.export.txt`	(obrigatório) Exportar TXT
`permissions.import.xml`	(obrigatório) Importar XML
`permissions.import.pdf`	(obrigatório) Importar PDF
`permissions.import.csv`	(obrigatório) Importar CSV
`permissions.import.txt`	(obrigatório) Importar TXT
`contractService`	(opcional) Autorização para contratar servicos
`isActive`	(opcional) Se o usuario esta ativo (default = false)
`groupPermissions`	(opcional) Tipo array
`groupPermissions.company`	(obrigatório) Id da Empresa
`groupPermissions.store`	(obrigatório) Id da Loja
`groupPermissions.accessGroup`	(obrigatório) Id do Grupo de acesso

POST

/authorizations/user

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/authorizations/user' \
--header 'Content-Type: application/json' \
--data-raw '{
   "officeHour":{
      "afterHoursAccess":"true",
      "entryTime":"",
      "departureTime":""
   },
   "permissions":{
      "export":{
         "xml":true,
         "pdf":true,
         "csv":true,
         "txt":true
      },
      "import":{
         "xml":true,
         "pdf":true,
         "csv":true,
         "txt":true
      }
   },
   "contractService":"true",
   "isActive":"true",
   "externalUserID":"",
   "acceptInvite":"true",
   "classification":0,
   "_id":"60eedf0088ee130041c7c4fa",
   "groupPermissions":[
      {
         "company":"5fb13d4beca4280040e73b41",
         "store":"604e4a64dbe10747b720617c",
         "accessGroup":"6088e5bdfc9e4500415808fd"
      },
      {
         "company":"5fb13d4beca4280040e73b41",
         "store":"6060d17a20dab44562b8d81c",
         "accessGroup":"6060eb2312a9e04add1299c0"
      },
      {
         "company":"603cf86a2d5177324ca89e9c",
         "store":"606465a8e68fcd0042e3b914",
         "accessGroup":"6088e5bdfc9e4500415808fd"
      },
      {
         "company":"603cf86a2d5177324ca89e9c",
         "store":"609c60f687935f0042accef4",
         "accessGroup":"6088e5bdfc9e4500415808fd"
      }
   ],
   "name":"William",
   "surname":"Vilas Boas",
   "email":"william.vboas@gmail.com",
   "responsibility":"Administrador",
   "type":"admin",
   "createdAt":"2021-07-14T12:56:32.571Z",
   "updatedAt":"2021-07-14T19:10:09.369Z",
}'

Exemplo de Resposta

{
   "response":true,
   "user":{
      "officeHour":{
         "afterHoursAccess":true,
         "entryTime":"",
         "departureTime":""
      },
      "permissions":{
         "export":{
            "xml":true,
            "pdf":true,
            "csv":true,
            "txt":true
         },
         "import":{
            "xml":true,
            "pdf":true,
            "csv":true,
            "txt":true
         }
      },
      "contractService":true,
      "isActive":true,
      "externalUserID":"",
      "acceptInvite":true,
      "classification":0,
      "_id":"60eedf0088ee130041c7c4fa",
      "groupPermissions":[
         {
            "_id":"60ef36911d0fe70041ec7e6d",
            "company":"5fb13d4beca4280040e73b41",
            "store":"604e4a64dbe10747b720617c",
            "accessGroup":"6088e5bdfc9e4500415808fd"
         },
         {
            "_id":"60ef36911d0fe70041ec7e6e",
            "company":"5fb13d4beca4280040e73b41",
            "store":"6060d17a20dab44562b8d81c",
            "accessGroup":"6060eb2312a9e04add1299c0"
         },
         {
            "_id":"60ef36911d0fe70041ec7e6f",
            "company":"603cf86a2d5177324ca89e9c",
            "store":"606465a8e68fcd0042e3b914",
            "accessGroup":"6088e5bdfc9e4500415808fd"
         },
         {
            "_id":"60ef36911d0fe70041ec7e70",
            "company":"603cf86a2d5177324ca89e9c",
            "store":"609c60f687935f0042accef4",
            "accessGroup":"6088e5bdfc9e4500415808fd"
         }
      ],
      "name":"William",
      "surname":"Vilas Boas",
      "email":"william.vboas@gmail.com",
      "responsibility":"Administrador",
      "type":"admin",
      "createdAt":"2021-07-14T12:56:32.571Z",
      "updatedAt":"2021-07-14T19:10:09.369Z",
   }
}

POST | Inserir Empresa

Este endpoint irá cadastrar uma empresa.

Propriedade	Descrição
`email`	(obrigatório) email cadastrado
`company`	(obrigatório) Nome empresa
`country`	(obrigatório) País
`name`	(obrigatório) Nome do usuário
`cpf`	(obrigatório) CPF do usuário
`birth`	(obrigatório) Dt. de Nascimento
`password`	(obrigatório) Senha
`type`	(opcional) Tipo de usuário
`browser_id`	(opcional) ID do navegador
`googleKey`	(opcional) Chave caso autentique pelo botão do Google

POST

/authorizations/register

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/authorizations/register' \
--header 'Content-Type: application/json' \
--data-raw '{
        "email": "email@teste.com",
        "company": "Empresa",
        "country": "brazil",
        "name": "Fulano sila",
        "cpf": "111111111111",
        "birth": "1994-11-01",
        "password": "123",
}'

Exemplo de Resposta

{
    "response": true
}

POST | Inserir modelo de Sped

Este endpoint cria um modelo de sped no banco de dados.

Propriedade	Descrição
`fields`	(opcional) campos do modelo de sped
`father_id`	(opcional) id do item pai
`name`	(opcional) nome da regra
`type`	(opcional) tipo de sped
`version`	(opcional) versão da regra
`register`	(opcional) registro do sped

POST

/authorizations/spedmodels

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/authorizations/spedmodels' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nome da regra",
    "fields": [],
    "father_id": null,
    "name": "Regra de teste",
    "type": "fiscal",
    "version": "100",
    "register": "RegTest",
}'

Exemplo de Resposta

{
    "_id": "182e9hd182hd128fh012f",
    "fields": [
        {
            "_id": "r9378fh83h2f80h23uf23f",
            "name": "REG",
            "field_number": 1,
            "description": "Texto fixo contendo  0000.",
            "type": "String",
            "size": "4",
            "required": false,
            "validation_rule": "",
            "regex_validation": "",
            "validation_only_warning": true
        },
    ],
    "father_id": "",
    "name": "0000 - Abertura do Arquivo Digital e Identificacao da entidade",
    "type": "fiscal",
    "version": "100",
    "register": "0000",
    "createdAt": "2021-01-06T14:40:18.073Z",
    "updatedAt": "2021-01-06T14:40:18.073Z",
    "__v": 0,
    "id": "e921eh120ufh12-f821fh12",
    "fatherDetails": ""
}

POST | Inserir modelo do Xml

Este endpoint insere um modelo de xml no banco de dados.

Propriedade	Descrição
`fields`	(opcional) campos do modelo de xml
`father_id`	(opcional) id do item pai
`name`	(opcional) nome da regra
`type`	(opcional) tipo de xml
`version`	(opcional) versão da regra
`register`	(opcional) registro do xml

POST

/authorizations/xmlmodels

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/authorizations/xmlmodels' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Nome da regra",
    "fields": [],
    "father_id": null,
    "name": "Regra de teste",
    "type": "fiscal",
    "version": "100",
    "register": "RegTest",
}'

Exemplo de Resposta

{
    "_id": "179he0128eh1208j120hf",
    "fields": [
        {
            "_id": "d1278dh01208d7h120d12",
            "name": "CFe",
            "field_group": "-",
            "description": "TAG raiz do CF-e",
            "type": "Object",
            "size": "255",
            "required": false,
            "validation_rule": "",
            "regex_validation": "",
            "validation_only_warning": true
        }
    ],
    "father_id": "",
    "name": "- - TAG raiz do CF-e",
    "version": "0.06",
    "register": "-",
    "createdAt": "2021-02-09T02:07:05.837Z",
    "updatedAt": "2021-02-09T02:07:05.837Z",
    "__v": 0,
    "id": "e1280hej128eh1208eh12",
    "fatherDetails": ""
}

POST | Inserir Relatório

Este endpoint insere um relatório no banco de dados.

Propriedade	Descrição
`name`	(opcional) nome do relatório
`content`	(opcional) conteúdo do relatório
`comments.name`	(opcional) comentários do relatório

POST

/report

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/v1/report' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Relatório de Envios",
    "content": "Este é o relatório...",
    "comments": [
        {
            "content": "O relatório contem o valor X!"
        }
    ]
}'

Exemplo de Resposta

{
    "response": true,
    "report": {
        "_id": "je219e12908ej12908ej",
        "name": "Relatório de Envios",
        "content": "Este é o relatório...",
        "comments": [
            {
                "_id": "e89-12e098eh12908eh12",
                "content": "O relatório contem o valor X!",
                "created_at": "2021-02-28T22:57:10.067Z"
            }
        ],
        "createdAt": "2021-02-28T22:57:10.073Z",
        "updatedAt": "2021-02-28T22:57:10.073Z",
        "__v": 0
    }
}

POST | Inserir Chave da API

Este endpoint insere uma chave de api no banco de dados.

Propriedade	Descrição
`name`	(opcional) nome da chave
`getRequest`	(opcional) habilita/desabilita get
`putRequest`	(opcional) habilita/desabilita put
`deleteRequest`	(opcional) habilita/desabilita delete
`isPublic`	(opcional) habilita/desabilita chave para ser pública

POST

/apiKey

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/v1/apiKey' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "API KEY",
    "isPublic": true
}'

Exemplo de Resposta

{
    "response": true,
    "user": {
        "getRequest": false,
        "putRequest": false,
        "deleteRequest": false,
        "_id": "19rj912rj12980rjh1290rh12",
        "name": "API KEY",
        "isPublic": true,
        "key": "eyJhbGciOiJIUzDApbWl4RmlzY2Fs",
        "createdAt": "2021-02-28T23:31:48.248Z",
        "updatedAt": "2021-02-28T23:31:48.248Z",
        "__v": 0
    }
}

POST | Inserir Grupo

Este endpoint insere um grupo de acesso no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do grupo
`groupName`	(opcional) nome do grupo
`modules[]`	(opcional) array de modulos
`modules.rules`	(opcional) objeto do modulo
`modules.father_id`	(opcional) Caso haja hierarquia, será o módulo pai
`modules.name`	(opcional) nome do módulo

POST

/accessGroup

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/v1/accessGroup' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupName": "Grupo",
}'

Exemplo de Resposta

{
    "response": true,
    "accessGroups": {
        "_id": "f9jh9130fh190f1",
        "groupName": "Administradores",
        "modules": [
            {
                "rules": {
                    "read": true,
                    "edit": true,
                    "record": true,
                    "remove": true
                },
                "father_id": "",
                "_id": "0f921h09f8h2190fh12f12",
                "name": "Dashboard"
            },
        ],
        "createdAt": "2021-03-01T02:17:10.127Z",
        "updatedAt": "2021-03-01T02:17:10.127Z",
        "__v": 0
    }
}

POST | Enviar Convite

Este endpoint envia o convite para um usuário.

Propriedade	Descrição
`idOrEmail`	(obrigatório) ID do usuário ou email

POST

/user/sendInvite/:idOrEmail

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/v1/user/sendInvite/{idOrEmail}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json'

Exemplo de Resposta

{
    "response": true,
    "sended": true
}

DELETE | Modelo de sped

Este endpoint deleta um modelo de sped no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do fluxo

DELETE

/authorizations/spedmodels/{id}

Exemplo de Requisição

curl --location --request DELETE 'https://api.builder.mixfiscal.com.br/authorizations/spedmodels/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true
}

POST | Criar Loja

Este endpoint criar uma loja para uma companyId

Propriedade	Descrição
`companyId`	(obrigatório) id da empresa relacionada
`companyName`	(obrigatório) Nome da Loja*
`name`	(obrigatório) Nome da Loja
`cnpj`	(obrigatório) CNPJ
`storySize`	(opcional) Nome da Empresa
`address`	(obrigatório) Endereço
`cell`	(obrigatório) Celular
`state`	(obrigatório) Estado
`city`	(obrigatório) Cidade
`district`	(obrigatório) Bairro
`complement`	(opcional) Complemento
`number`	(obrigatório) Numero endereco
`zipcode`	(obrigatório) CEP
`employees`	(opcional) Null
`isActive`	(opcional) Boolean ( default = true)
`logo`	(opcional) URL de apontamento da marca no S3
`mainActivity`	(obrigatório) Atividade principal
`namePartnerOne`	(opcional) Nome socio 1
`namePartnerTwo`	(obrigatório) Nome socio 2
`openDate`	(opcional) Data de Abertura
`openingTime`	(opcional) Horario de abertua
`phone`	(opcional) Telefone
`secondaryActivity`	(opcional) Atividades secondarias
`phone`	(obrigatório) Telefone
`taxRegime`	(opcional) Nome da Empresa
`type`	(obrigatorio) Loja
`tradeName`	(obrigatório) Nome Fantasia

POST

/authorizations/store

Exemplo de Requisição

curl --location --request POST 'https://api.builder.mixfiscal.com.br/authorizations/store' \
--header 'Content-Type: application/json' \
--data-raw '{
    "isActive":"true",
    "name":"Loja Matriz",
    "createdAt":"2021-03-14T17:39:48.256Z",
    "updatedAt":"2021-07-27T12:36:05.803Z",
    "cnpj":"07.408.983/0001-49",
    "address":"AV ANTONIO DA SILVA NUNES",
    "city":"BIRIGUI",
    "closingTime":"",
    "companyName":"BANDEIRANTE SUPERMERCADOS BRASIL LTDA.",
    "complement":"-",
    "employees":"",
    "number":"837",
    "openingTime":"",
    "state":"SP",
    "taxRegime":"",
    "tradeName":"BANDEIRANTE SUPERMERCADOS",
    "weekendClosingTime":"",
    "weekendOpeningTime":"",
    "zipcode":"16.201-106",
    "district":"ESTANCIA CAICARA",
    "cell":"",
    "certificatePassword":"12345678",
    "lastUpdate":"2021-06-24T22:29:01.099Z",
    "legalNature":"206-2 - Sociedade Empresária Limitada",
    "namePartnerOne":"SEIJI TAKATA - SÓCIO","namePartnerTwo":"PAULO MASSAHARU TAKATA - SÓCIO",
    "openDate":"01/06/2005",
    "phone":"(18) 3649-8888/ (18) 3649-6611",
    "storeSize":"",
    "logo":"",
    "mainActivity":"47.11-3-02",
    "secondaryActivity":"56.11-2-01, 64.99-9-99, 82.99-7-99, 46.91-5-00, 53.20-2-02, 10.13-9-01",
    "type":"Filial",
    "companyType":"Filial"
}'

Exemplo de Resposta

{
    "isActive":"true",
    "_id":"604e4a64dbe10747b720617c",
    "name":"Loja Matriz",
    "createdAt":"2021-03-14T17:39:48.256Z",
    "updatedAt":"2021-07-27T12:36:05.803Z",
    "cnpj":"07.408.983/0001-49",
    "address":"AV ANTONIO DA SILVA NUNES",
    "city":"BIRIGUI",
    "closingTime":"",
    "companyName":"BANDEIRANTE SUPERMERCADOS BRASIL LTDA.",
    "complement":"-",
    "employees":"",
    "number":"837",
    "openingTime":"",
    "state":"SP",
    "taxRegime":"Yes",
    "tradeName":"BANDEIRANTE SUPERMERCADOS",
    "weekendClosingTime":"",
    "weekendOpeningTime":"",
    "zipcode":"16.201-106",
    "district":"ESTANCIA CAICARA",
    "cell":"",
    "certificatePassword":"12345678",
    "lastUpdate":"2021-06-24T22:29:01.099Z",
    "legalNature":"206-2 - Sociedade Empresária Limitada",
    "namePartnerOne":"SEIJI TAKATA - SÓCIO",
    "namePartnerTwo":"PAULO MASSAHARU TAKATA - SÓCIO",
    "openDate":"01/06/2005",
    "phone":"(18) 3649-8888/ (18) 3649-6611",
    "storeSize":"",
    "logo":"",
    "certificate":"",
    "mainActivity":"47.11-3-02",
    "secondaryActivity":"56.11-2-01, 64.99-9-99, 82.99-7-99, 46.91-5-00, 53.20-2-02, 10.13-9-01",
    "type":"Filial",
    "companyType":"Filial"
}

DELETE | Modelo de Xml

Este endpoint deleta um modelo de xml no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do fluxo

DELETE

/authorizations/xmlmodels/{id}

Exemplo de Requisição

curl --location --request DELETE 'https://api.builder.mixfiscal.com.br/authorizations/xmlmodels/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true
}

DELETE | Relatório

Este endpoint deleta um relatório no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do relatório

DELETE

/report/{id}

Exemplo de Requisição

curl --location --request DELETE 'https://api.builder.mixfiscal.com.br/v1/report/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true
}

DELETE | Chave da API

Este endpoint deleta uma chave da API no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID da chave da API

DELETE

/apiKey/{id}

Exemplo de Requisição

curl --location --request DELETE 'https://api.builder.mixfiscal.com.br/v1/apiKey/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true
}

DELETE | Grupo de acesso

Este endpoint deleta um Grupo de acesso no banco de dados.

Propriedade	Descrição
`id`	(obrigatório) ID do grupo de acesso

DELETE

/accessGroup/{id}

Exemplo de Requisição

curl --location --request DELETE 'https://api.builder.mixfiscal.com.br/v1/accessGroup/{id}' \
--header 'Authorization: Bearer {token}'

Exemplo de Resposta

{
    "response": true
}

Exemplo de requisição em:

cURL

A MixFiscal

GET | Arquivos por tipo

Exemplo de Requisição

Exemplo de Resposta

GET | Arquivo por id

Exemplo de Requisição

Exemplo de Resposta

GET | Arquivo (SPED) por id

Exemplo de Requisição

Exemplo de Resposta

GET | Arquivo Linhas (SPED) por id

Exemplo de Requisição

Exemplo de Resposta

GET | Campos específicos

Exemplo de Requisição

Exemplo de Resposta

GET | Listar todos arquivos

Exemplo de Requisição

Exemplo de Resposta

GET | Fluxo por id

Exemplo de Requisição

Exemplo de Resposta

GET | Fluxos publicados

Exemplo de Requisição

Exemplo de Resposta

GET | Fluxos rascunhos

Exemplo de Requisição

Exemplo de Resposta

PUT | Alterar fluxo

Exemplo de Requisição

Exemplo de Resposta

POST | Login

Exemplo de Requisição

Exemplo de Resposta

POST | Enviar Arquivo

Exemplo de Requisição

Exemplo de Resposta

POST | Arquivo por fluxo

Exemplo de Requisição

Exemplo de Resposta

POST | Inserir Fluxo

Exemplo de Requisição

Exemplo de Resposta

POST | Publica fluxo

Exemplo de Requisição

Exemplo de Resposta

DELETE | Deletar arquivo

Exemplo de Requisição

Exemplo de Resposta

DELETE | Deletar fluxo

Exemplo de Requisição

Exemplo de Resposta

GET | Empresas

Exemplo de Requisição

Exemplo de Resposta

GET | Dados da empresa

Exemplo de Requisição

Exemplo de Resposta

GET | Funcionários

Exemplo de Requisição

Exemplo de Resposta

GET | Funcionário

Exemplo de Requisição

Exemplo de Resposta

GET | Modelos de Sped

Exemplo de Requisição

Exemplo de Resposta

GET | Sped por String

Exemplo de Requisição

Exemplo de Resposta

GET | Modelo de Sped por parametros (Id)

Exemplo de Requisição

Exemplo de Resposta

GET | Versões do Sped

Exemplo de Requisição

Exemplo de Resposta

GET | Modelos de Xml

Exemplo de Requisição

Exemplo de Resposta

GET | Xml por String