Accountants

Api

Attachments

Batches

Booking accounts

Booking plans

Business activities

Categories

Classification rules

Customer providers

Entries

Historical imports

Juridical people

Modality accounts

CONTROLE DE ACESSO

A autenticação no ContabilOne é feita apartir de um “authentication_token” de uma account.

Este authentication_token é gerado automaticamente quando a compra de um pacote através do PassaportWeb é confirmada. Em todas as requisições, é necessário autenticação.

O método de autenticação usado é HTTP Basic (RFC2617) utilizando as credenciais fornecidas pela conta do usuário, via Https, deixando o token não interceptável devido ao uso de SSL/TLS na conexão.

SERIALIZAÇÃO DE DADOS

Datas como date devem ser informadas para o formato ‘YYYY-MM-DD’ de acordo com a ISO8601

Datas como datetime devem ser informadas para o formato ‘YYYY-MM-DDTHH:MM:SS’ de acordo com a ISO8601

Timezone padrão utilizado: UTC



GET /api/accountants
Lista os responsáveis contábeis cadastrados na conta do token passado

Exemplo de requisição
curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api/accountants

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 13:27:00 GMT
Corpo
{
  "links": [
    {
      "rel":"self",
      "method":"get",
      "href":"https://app.contabilone.com.br/api/accountants"
    },{
      "rel":"create",
      "method":"post",
      "href":"https://app.contabilone.com.br/api/accountants"
    }
  ],
  "accountants": [
    {
      "accountant": {
        "id":3,
        "full_name":"Some name",
        "person_type":1,
        "cpf_cnpj":"11554812836",
        "crc_state":"AL",
        "crc_number":"1234563",
        "account_id":1,
        "created_at":"2013-05-17T10:26:26-03:00",
        "updated_at":"2013-05-20T10:28:43-03:00",
        "links": [
          {
            "rel":"self",
            "method":"get",
            "href":"https://app.contabilone.com.br/api/accountants/3"
          },{
            "rel":"update",
            "method":"put",
            "href":"https://app.contabilone.com.br/api/accountants/3"
          },{
            "rel":"destroy",
            "method":"delete",
            "href":"https://app.contabilone.com.br/api/accountants/3"
          }
        ]
      }
    },
  ]
}

GET /api/accountants/:id
Exibe um responsável contábil.

Retorna os atributos de um responsável contábil especificado (via id) com uma resposta 200 Ok.

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 13:27:00 GMT
Corpo
{
  "accountant":{
    "id":4,
    "full_name":"Some name",
    "person_type":1,
    "cpf_cnpj":"94180875292",
    "crc_state":"AL",
    "crc_number":"21345612312",
    "account_id":1,
    "created_at":"2013-05-20T10:06:03-03:00",
    "updated_at":"2013-05-20T10:28:59-03:00",
    "links": [
      {
        "rel":"self",
        "method":"get",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      },{
        "rel":"update",
        "method":"put",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      },{
        "rel":"destroy",
        "method":"delete",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      }
    ]
  }
}

POST /api/accountants
Cria um responsável relacionado a conta(account) autenticada

Para criação de novo responsável, deve ser passado um CPF ou um CNPJ válido (de acordo com o person_type) e uma razão social. A account usada nas requisições sempre será a account que está autenticada na requisição.

Exemplo de corpo da requisição

{
  "accountant":{
    "full_name":"Some name",
    "person_type":1,
    "cpf_cnpj":"11554812836",
    "crc_state":"AL",
    "crc_number":"1234563
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/accountants/11
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 15:31:00 GMT
Corpo
{
  "accountant":{
    "id":4,
    "full_name":"Some name",
    "person_type":1,
    "cpf_cnpj":"94180875292",
    "crc_state":"AL",
    "crc_number":"21345612312",
    "account_id":1,
    "created_at":"2013-05-20T10:06:03-03:00",
    "updated_at":"2013-05-20T10:28:59-03:00",
    "links": [
      {
        "rel":"self",
        "method":"get",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      },{
        "rel":"update",
        "method":"put",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      },{
        "rel":"destroy",
        "method":"delete",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      }
    ]
  }
}

Params

Param name Description
accountants
required

Validations:

  • Must be a Hash

accountants[full_name]
required

Nome completo do responsável

Validations:

  • Must be String

accountants[person_type]
required

Tipo do responsável: 1 - Pessoa Física; 2 - Pessoa Jurídica

Validations:

  • Must be Integer

accountants[cpf_cnpj]
required

CPF ou CNPJ válido.

Validations:

  • Must be String

accountants[crc_state]
required

Sigla do estado de registro do CRC do responsável. Deve ser a sigla de um estado brasileiro válido.

Validations:

  • Must be String

accountants[crc_number]
required

Registro CRC do responsável.

Validations:

  • Must be String


PUT /api/accountants/:id
Altera um responsável

Altera um responsável específico. Retornando o responsável alterado e status 200 Ok em caso de sucesso ou uma resposta 422 Unprocessable entity com a descrição dos erros em caso de falha.

Exemplo de corpo da requisição

{
  "accountant":{
    "full_name":"Some name",
    "person_type":1,
    "cpf_cnpj":"11554812836",
    "crc_state":"AL",
    "crc_number":"1234563
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 15:41:00 GMT
Corpo
{
  "accountant":{
    "id":4,
    "full_name":"Some name",
    "person_type":1,
    "cpf_cnpj":"94180875292",
    "crc_state":"AL",
    "crc_number":"21345612312",
    "account_id":1,
    "created_at":"2013-05-20T10:06:03-03:00",
    "updated_at":"2013-05-20T10:28:59-03:00",
    "links": [
      {
        "rel":"self",
        "method":"get",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      },{
        "rel":"update",
        "method":"put",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      },{
        "rel":"destroy",
        "method":"delete",
        "href":"https://app.contabilone.com.br/api/accountants/4"
      }
    ]
  }
}

Params

Param name Description
accountants
required

Validations:

  • Must be a Hash

accountants[full_name]
required

Nome completo do responsável

Validations:

  • Must be String

accountants[person_type]
required

Tipo do responsável: 1 - Pessoa Física; 2 - Pessoa Jurídica

Validations:

  • Must be Integer

accountants[cpf_cnpj]
required

CPF ou CNPJ válido.

Validations:

  • Must be String

accountants[crc_state]
required

Sigla do estado de registro do CRC do responsável. Deve ser a sigla de um estado brasileiro válido.

Validations:

  • Must be String

accountants[crc_number]
required

Registro CRC do responsável.

Validations:

  • Must be String


DELETE /api/accountants/:id
Excluir um responsável contábil

Exclui um responsável especificado (via id) com resposta 204 Ok.

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GMT
  • Valida as credenciais de uma conta do usuário

  • Não recebe parâmetros

  • Autenticação utilizando token da conta do usuário


GET /api
Endpoint de testes de autenticação do ContabilOne

Requisição

'curl -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api --basic'

Retorno com Sucesso:

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GMT
Retorno
{"status":"Authenticated"}

Resposta com Erro:

Cabeçalho
HTTP/1.1 401 Unauthorized
Date: Mon, 17 Jan 2011 19:54:21 GMT
Content-Type: application/json; charset=utf-8
Retorno
{"error":"unauthorized"}

GET /api/jp/:juridical_person_id/entries/:entries_id/attachments/:id
Exibe um Anexo

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "attachment":{
    "id":28,
    "description":"Fíquissa",
    "source_content_type":"image/jpeg",
    "source_file_name":"fixared.jpg",
    "links":[
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://sandbox.contabilone.com.br/jp/6/entries/53/attachments/28"
      },
      {
        "rel":"download",
        "method":"get",
        "href":"http://sandbox.contabilone.com.br/jp/6/entries/53/attachments/28/download"
      },
      {
        "rel":"self",
        "method":"get",
        "href":"http://sandbox.contabilone.com.br/jp/6/entries/53/attachments/28"
      }
    ]
  }
}

DELETE /api/jp/:juridical_person_id/entries/:entries_id/attachments/:id
Exclui um anexo

Exclui um anexo especificado (via id) com uma resposta 204 Ok.

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GMT

GET /api/jp/:juridical_person_id/entries/:entries_id/attachments/:id/download
Redireciona para a URL de download do anexo

Redireciona para a url de visualização/download do anexo com resposta 302.

Exemplo de resposta

HTTP/1.1 302 Redirect
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GMT
Location: https://cdn-contabilone-development.s3.amazonaws.com/attachments/....

GET /api/jp/:juridical_person_id/batches
Lista os Lotes de uma empresa

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "batches":[
    {
      "batch":{
        "id":1,
        "description":"01",
        "juridical_person_id":6,
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://localhost:3000/api/jp/6/batches/1"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://localhost:3000/api/jp/6/batches/1"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://localhost:3000/api/jp/6/batches/1"
          }
        ]
      }
    },
    {
      "batch":{
        "id":2,
        "description":"02",
        "juridical_person_id":6,
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://localhost:3000/api/jp/6/batches/2"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://localhost:3000/api/jp/6/batches/2"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://localhost:3000/api/jp/6/batches/2"
          }
        ],
      }
    }
  ],
  "links":[
    {
      "rel":"self",
      "method":"get",
      "href":"http://localhost:3000/api/jp/6/batches"
    },
    {
      "rel":"create",
      "method":"post",
      "href":"http://localhost:3000/api/jp/6/batches"
    }
  ]
}

GET /api/jp/:juridical_person_id/batches/:id
Detalhes de um lote de uma empresa

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "batch":{
    "id":1,
    "description":"01",
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      }
    ]
  }
}

POST /api/jp/:juridical_person_id/batches
Cria um lote para uma pessoa juridica

Exemplo de corpo da requisição

{
  "batch" : {
    "description" : "03"
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/jp/:juridical_person_id/batch/:id
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "batch":{
    "id":3,
    "description":"03",
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      }
    ]
  }
}

PUT /api/jp/:juridical_person_id/batches/:id
altera um lote específico

Exemplo de corpo da requisição

{
  "batch" : {
    "description" : "01 2014"
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Location: https://app.contabilone.com.br/jp/:juridical_person_id/batch/1
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "batch":{
    "id":1,
    "description":"01 2014",
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://localhost:3000/api/jp/6/batches/1"
      }
    ]
  }
}

DELETE /api/jp/:juridical_person_id/:batches/:id

Exclui um lote

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 24 Jan 2015 11:40:01 GMT

GET /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/booking_accounts
Lista as contas contábeis do plano de contas

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "links":[
    {
      "rel":"next_page",
      "method":"get",
      "href":"http://sandbox.contabilone.com.br/api/jp/4%2F/booking_plans/16/booking_accounts?page=2"
    },
    {
      "rel":"previous_page",
      "method":"get",
      "href":null
    },
    {
      "rel":"create",
      "method":"post",
      "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts"
    },
    {
      "rel":"self",
      "method":"get",
      "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts"
    }
  ],
  "booking_accounts":[
    {
      "booking_account":{
        "number":"1",
        "name":"ATIVO",
        "nature":1,
        "small_id":null,
        "origin":1,
        "initial_balance":
          {
            "id":7,
            "booking_account_id":1712,
            "accounting_period_id":73,
            "initial_balance":"500.0",
            "normal_balance":"credit",
            "created_at":"2015-11-09T14:23:25.841-02:00",
            "updated_at":"2015-11-09T14:23:25.841-02:00"
          },
        "links":[
          {
            "rel":"update",
            "method":"put",
            "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
          },
          {
            "rel":"self",
            "method":"get",
            "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
          }
        ]
      }
    },
    {
      "booking_account":{
        "number":"2",
        "name":"Circulante",
        "nature":1,
        "small_id":null,
        "origin":1,
        "initial_balance": null,
        "links":[
          {
            "rel":"update",
            "method":"put",
            "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2958"
          },
          {
            "rel":"self",
            "method":"get",
            "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2958"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2958"
          }
        ]
      }
    }
  ]
}

Params

Param name Description
page
optional

Numero da Página que deseja acessar

Validations:

  • Must be Integer


GET /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/booking_account/:id
Lista as contas contábeis do plano de contas

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "booking_account":{
    "id":1,
    "number":"1",
    "name":"ATIVO",
    "nature":1,
    "small_id":null,
    "origin":1,
    "initial_balance":
    {
      "id":7,
      "booking_account_id":1712,
      "accounting_period_id":73,
      "initial_balance":"500.0",
      "normal_balance":"credit",
      "created_at":"2015-11-09T14:23:25.841-02:00",
      "updated_at":"2015-11-09T14:23:25.841-02:00"
    },
    "links":[
      {
        "rel":"update",
        "method":"put",
        "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
      },
      {
        "rel":"self",
        "method":"get",
        "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
      }
    ]
  }
}

Params

Param name Description
page
optional

Numero da Página que deseja acessar

Validations:

  • Must be Integer


POST /api/jp/:juridical_person_id/booking_plan/:booking_plan_id/booking_accounts
Cria uma conta contábel para um plano de contas

Exemplo de corpo da requisição

{
  "booking_account":{
    "name":"Conta contábil dos vencedores",
    "number":2,
    "nature":"1",
    "small_id":352,
    "origin":"1",
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/jp/:juridical_person_id/:juridical_person_id/booking_accounts
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "booking_account":{
    "id":1,
    "number":"159",
    "name":"Conta contábil dos vencedores",
    "nature":1,
    "small_id":352,
    "origin":1,
    "start_at":"2015-01-27",
    "end_at":"2015-01-28",
    "initial_balance": null,
    "links":[
      {
        "rel":"update",
        "method":"put",
        "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/3171"
      },
      {
        "rel":"self",
        "method":"get",
        "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/3171"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/3171"
      }
    ]
  }
}

Params

Param name Description
booking_account
required

Validations:

  • Must be a Hash

booking_account[number]
required

Numero da conta, ex: 1.001.001.01, (deve estar de acordo com a mascara definida no plano de contas)

Validations:

  • Must be String

booking_account[name]
required

Nome da conta

Validations:

  • Must be String

booking_account[small_id]
optional

Identificador personalizado da conta

Validations:

  • Must be String

booking_account[origin]
required

Origem do lançamento, (1 para devedora e 2 para credora)

Validations:

  • Must be Integer

booking_account[nature]
optional

Identificador da natureza da conta

Validations:

  • Must be Integer

booking_account[account_type]
optional

Tipo de conta (synthetic ou analytic)

Validations:

  • Must be String

booking_account[initial_balance_attributes]
optional

Atributos do saldo inicial

Validations:

  • Must be an Array of nested elements

booking_account[initial_balance_attributes][initial_balance]
required

Balanço Inicial

Validations:

  • Must be Float

booking_account[initial_balance_attributes][normal_balance]
optional

Tipo de balanço (“credit” e “debit”)

Validations:

  • Must be Integer


PUT /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/booking_accounts/:id
Altera a conta contábel de um plano de contas

Exemplo de corpo da requisição

{
  "booking_account":
  {
    "small_id": 1969
  }
  "initial_balance_attributes":
  {
    normal_balance:"credit",
    initial_balance:100
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
 {
        "booking_account":{
  "id":1,
  "number":"1",
  "name":"ATIVO",
  "nature":1,
  "small_id":1969,
  "origin":1,
   "initial_balance":
   {
     "id":1,
     "booking_account_id":1,
     "accounting_period_id":73,
     "initial_balance":100,
     "normal_balance":"credit",
     "created_at":"2015-11-09T14:23:25.841-02:00",
     "updated_at":"2015-11-09T14:23:25.841-02:00"
   },
  "links":[
    {
      "rel":"update",
      "method":"put",
      "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
    },
    {
      "rel":"self",
      "method":"get",
      "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
    },
    {
      "rel":"destroy",
      "method":"delete",
      "link":"http://sandbox.contabilone.com.br/api/jp/4/booking_plans/16/booking_accounts/2957"
    }]
   }
 }

Params

Param name Description
booking_account
required

Validations:

  • Must be a Hash

booking_account[number]
required

Numero da conta, ex: 1.001.001.01, (deve estar de acordo com a mascara definida no plano de contas)

Validations:

  • Must be String

booking_account[name]
required

Nome da conta

Validations:

  • Must be String

booking_account[small_id]
optional

Identificador personalizado da conta

Validations:

  • Must be String

booking_account[origin]
required

Origem do lançamento, (1 para devedora e 2 para credora)

Validations:

  • Must be Integer

booking_account[nature]
optional

Identificador da natureza da conta

Validations:

  • Must be Integer

booking_account[account_type]
optional

Tipo de conta (synthetic ou analytic)

Validations:

  • Must be String

booking_account[initial_balance_attributes]
optional

Atributos do saldo inicial

Validations:

  • Must be an Array of nested elements

booking_account[initial_balance_attributes][initial_balance]
required

Balanço Inicial

Validations:

  • Must be Float

booking_account[initial_balance_attributes][normal_balance]
optional

Tipo de balanço (“credit” e “debit”)

Validations:

  • Must be Integer


DELETE /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/booking_accounts/:id
Exclui o plano de contas

Exclui uma conta contábil e todas as contas contábeis abaixo dela, os lançamento dependentes, perdem sua classificação

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 24 Jan 2015 11:40:01 GMT

GET /api/jp/:juridical_person_id/booking_plans
Lista os planos de contas da empresa

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "booking_plan":{
    "id":8,
    "name":"Plano de contas - Minha Empresa Radical",
    "mask":"X.XXX.XXX.XXX.XXX.XXXX",
    "links":[
      {
        "rel":"update",
        "method":"put",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      },
      {
        "rel":"self",
        "method":"get",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      },
      {
        "rel":"booking_accounts",
        "method":"get",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8/booking_accounts"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      }
    ]
  }
}

PUT /api/jp/:juridical_person_id/booking_plans
Altera o plano de contas de uma pessoa júridica

Exemplo de corpo da requisição

{
	"booking_plan" : {
		"name" : "Plano de Contas Atualizado 2015"
	}
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "booking_plan":{
    "id":8,
    "name":"Plano de Contas Atualizado 2015",
    "mask":"X.XXX.XXX.XXX.XXX.XXXX",
    "links":[
      {
        "rel":"update",
        "method":"put",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      },
      {
        "rel":"self",
        "method":"get",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      }
    ]
  }
}

Params

Param name Description
booking_plan
required

Validations:

  • Must be a Hash

booking_plan[name]
optional

Nome do plano de contas

Validations:

  • Must be String

booking_plan[mask]
optional

Mascara das contas contábeis, padrão: X.XXX.XXX.XXX.XXX.XXXX

Validations:

  • Must be String


GET /api/jp/:juridical_person_id/booking_plans/:booking_plan_id
detalhes de um plano de contas da empresa

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "booking_plan":{
    "id":8,
    "name":"Plano de contas - Minha Empresa Radical",
    "mask":"X.XXX.XXX.XXX",
    "links":[
      {
        "rel":"update",
        "method":"put",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      },
      {
        "rel":"self",
        "method":"get",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      },
      {
        "rel":"booking_accounts",
        "method":"get",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8/booking_accounts"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "link":"http://sandbox.contabilone.com.br/api/jp/1/booking_plans/8"
      }
    ]
  }
}

DELETE /api/jp/:juridical_person_id/booking_plans/:id
Exclui o plano de contas

Exclui um plano de contas (e todas as contas contábeis, se ja houverem lançamentos classificados, os mesmos perderão a classificação ) especificado (via id) com uma resposta 204 Ok e cria um novo.

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 24 Jan 2015 11:40:01 GMT

GET /api/business_activities
Lista os ramos de atividades disponiveis para cadastrar pessoas jurídicas

Exemplo de requisição
curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api/business_activities

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 13:27:00 GMT
Corpo
{
  "links": [
    {
      "rel":"self",
      "method":"get",
      "href":"https://app.contabilone.com.br/api/business_activities"
    }
  ],
  "business_activities": [
    {
      "business_activity": {
        "id": 1,
        "active":"1",
        "code": 111301,
        "name":"Cultivo de Arroz",
        "created_at":"2013-05-17T10:26:26-03:00",
        "updated_at":"2013-05-20T10:28:43-03:00",
        "links": [
          {
            "rel":"self",
            "method":"get",
            "href":"https://app.contabilone.com.br/api/business_activities/3"
          }
        ]
      }
    },
    {
      "business_activity": {
        "id": 2,
        "name": "Cultivo de milho",
        "code": 111302,
        "active": "1",
        "created_at": "2013-09-11T17:07:40-03:00",
        "updated_at": "2013-09-11T17:07:40-03:00",
        "links": [
          {
          "rel": "self",
          "method": "get",
          "href": "https://app.contabilone.com.br/api/business_activities/2"
          }
        ]
      }
    }
  ]
}

Params

Param name Description
limit
optional

Utilizado para limitar o número de registros retornados, Valor Padrão: 100

Validations:

  • Must be Integer


GET /api/business_activities/:id
Exibe um ramo de atividade.

Retorna os atributos de um ramo de atividade especificado (via id) com uma resposta 200 Ok.

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 13:27:00 GMT
Corpo
{
  "business_activity": {
    "id": 1,
    "name": "Cultivo de arroz",
    "code": 111301,
    "active": "1",
    "created_at": "2013-09-11T17:07:40-03:00",
    "updated_at": "2013-09-11T17:07:40-03:00",
    "links": [
      {
        "rel": "self",
        "method": "get",
        "href": "https://app.contabilone.com.br/api/business_activities/1"
      }
    ]
  }
}

GET /api/jp/:juridical_person_id/categories
Lista as categorias cadastradas na conta do token passado

Exemplo de requisição
curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api/categories

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 13:27:00 GMT
Corpo
{
  "links": [
    {
      "rel":"self",
      "method":"get",
      "href":"https://app.contabilone.com.br/api/jp/1/categories"
    },{
      "rel":"create",
      "method":"post",
      "href":"https://app.contabilone.com.br/api/jp/1/categories"
    }
  ],
  "categories": [
    {
      "category": {
        "name":some:name,
        "links": [
          {
            "rel":"self",
            "method":"get",
            "href":"https://app.contabilone.com.br/api/jp/1/categories/3"
          },{
            "rel":"update",
            "method":"put",
            "href":"https://app.contabilone.com.br/api/jp/1/categories/3"
          },{
            "rel":"destroy",
            "method":"delete",
            "href":"https://app.contabilone.com.br/api/jp/1/categories/3"
          }
        ]
      }
    },
  ]
}

GET /api/jp/:juridical_person_id/categories/:id
Exibe uma categoria.

Retorna os atributos de uma categoria especificado (via id) com uma resposta 200 Ok.

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 13:27:00 GMT
Corpo
{
  "category":{
    "name":"Some name",
    "links": [
      {
        "rel":"self",
        "method":"get",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      },{
        "rel":"update",
        "method":"put",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      },{
        "rel":"destroy",
        "method":"delete",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      }
    ]
  }
}

POST /api/jp/:juridical_person_id/categories
Cria um responsável relacionado a conta(account) autenticada

Cria uma categoria

Exemplo de corpo da requisição

{
  "category":{
    "name":"Some name",
    "parent_id": 1
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/categories/11
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 15:31:00 GMT
Corpo
{
  "category":{
        "id": 4,
    "name":"Some name",
    "links": [
      {
        "rel":"self",
        "method":"get",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      },{
        "rel":"update",
        "method":"put",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      },{
        "rel":"destroy",
        "method":"delete",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      }
    ]
  }
}

Params

Param name Description
category
required

Validations:

  • Must be a Hash

category[name]
required

Nome da Categoria

Validations:

  • Must be String


PUT /api/jp/:juridical_person_id/categories/:id
Altera um responsável

Altera uma categoria especifica. Retornando a categoria e status 200 Ok em caso de sucesso ou uma resposta 422 Unprocessable entity com a descrição dos erros em caso de falha.

Exemplo de corpo da requisição

{
  "category":{
    "name":"Other name",
    "parent_id": 1
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 20 Mai 2013 15:41:00 GMT
Corpo
{
  "category":{
    "id":4,
    "name":"Other name",
    "links": [
      {
        "rel":"self",
        "method":"get",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      },{
        "rel":"update",
        "method":"put",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      },{
        "rel":"destroy",
        "method":"delete",
        "href":"https://app.contabilone.com.br/api/jp/1/categories/4"
      }
    ]
  }
}

Params

Param name Description
category
required

Validations:

  • Must be a Hash

category[name]
required

Nome da Categoria

Validations:

  • Must be String


DELETE /api/jp/:juridical_person_id/categories/:id
Excluir uma categoria

Exclui uma categoria especificada (via id) com resposta 204 Ok.

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GMT

GET /api/jp/:juridical_person_id/classification_rules
Lista as regras de classificação dos recursos de uma pessoa jurídica

Exemplo de requisição
curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api/jp/5/classification_rules?object=entry

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "links":[],
  "classification_rules": [
    {"classification_rule": {
      "id":13,
      "juridical_person_id":8,
      "name":"Imposto ISS",
      "created_at":"2013-11-22T14:14:58-02:00",
      "updated_at":"2013-11-22T14:14:58-02:00",
      "links":[]
      }
    },
    {"classification_rule": {
      "id":14,
      "juridical_person_id":8,
      "name":"Por modalidade de conta",
      "created_at":"2013-11-22T14:14:58-02:00",
      "updated_at":"2013-11-22T14:14:58-02:00",
      "links":[]
      }
    }
  ]
}

Params

Param name Description
limit
optional

Utilizado para limitar o número de registros retornados, Valor Padrão: 15

Validations:

  • Must be Integer


GET /api/jp/:juridical_person_id/customer_providers
Lista os clientes/fornecedores de uma empresa (se a conta com atual estiver com a opção "Compartilhar Clientes/Fornecedores" marcada, a listagem apresentará todos os clientes/fornecedores da conta)

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "customer_providers":[
    {
      "customer_provider":{
        "id":1,
        "name":"Hewlett-Packard",
        "service_type":[2],
        "person_type":2,
        "cnpj_cpf":"39.724.139/0001-13",
        "juridical_person_id":6,
        "account_id":1
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/1"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/1"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/1"
          }
        ]
      }
    },
    {
      "customer_provider":{
        "id":1,
        "name":"Hewlett-Packard",
        "service_type":[1],
        "person_type":1,
        "cnpj_cpf":"92.128.668/0001-37"
        "juridical_person_id":6,
        "account_id":1
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/2"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/2"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/2"
          }
        ],
      }
    },
    "links":[
    	{
        "rel":"self",
        "method":"get",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers"
    	},
    	{
        "rel":"create",
        "method":"post",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers"
    	}
    ]
  }
}

GET /api/jp/:juridical_person_id/customer_providers
Detalhes de um cliente/fornecedor de uma empresa

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "customer_provider":{
    "id":1,
    "name":"Hewlett-Packard",
    "service_type":[2],
    "person_type":2,
    "cnpj_cpf":"39.724.139/0001-13",
    "juridical_person_id":6,
    "account_id":1
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/1"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/1"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/1"
      }
    ]
  }
}

POST /api/jp/:juridical_person_id/customer_providers
Cria um cliente/consumidor para uma pessoa juridica

Exemplo de corpo da requisição

{
        "customer_provider":{
    "name":"Dell",
    "service_type":[1, 2],
    "person_type": 2,
    "cnpj_cpf":"39.724.139/0001-13",
        }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/jp/:juridical_person_id/customer_provider/:id
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "customer_provider":{
    "id":3,
    "name":"Dell",
    "service_type":[1, 2]
    "person_type":2
    "cnpj_cpf":"39.724.139/0001-13"
    "account_id":1
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/3"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/3"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/3"
      }
    ]
  }
}

Params

Param name Description
customer_provider
required

Validations:

  • Must be a Hash

customer_provider[name]
required

Nome do cliente/fornecedor

Validations:

  • Must be String

customer_provider[person_type]
required

Tipo de pessoa (1 para pessoa física e 2 para jurídica)

Validations:

  • Must be Integer

customer_provider[service_type]
required

Tipo de serviço prestado (1 para pessoa cliente e 2 para fornecedor)

Validations:

  • Must be an array of any type

customer_provider[cnpj_cpf]
optional

CPF ou CNPJ do cliente/consumidor, dependendo do tipo de pessoa

Validations:

  • Must be String


PUT /api/jp/:juridical_person_id/customer_providers/:id
altera um cliente/consumidor específico

Exemplo de corpo da requisição

{
        "customer_provider":{
                "Name":"Dell Brasil"
        }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Location: https://app.contabilone.com.br/jp/:juridical_person_id/customer_provider/3
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "customer_provider":{
    "id":3,
    "name":"Dell Brasil",
    "service_type":[1, 2]
    "person_type":2
    "cnpj_cpf":"39.724.139/0001-13"
    "account_id":1
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/3"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/3"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://app.contabilone.com.br/api/jp/6/customer_providers/3"
      }
    ]
  }
}

Params

Param name Description
customer_provider
required

Validations:

  • Must be a Hash

customer_provider[name]
required

Nome do cliente/fornecedor

Validations:

  • Must be String

customer_provider[person_type]
required

Tipo de pessoa (1 para pessoa física e 2 para jurídica)

Validations:

  • Must be Integer

customer_provider[service_type]
required

Tipo de serviço prestado (1 para pessoa cliente e 2 para fornecedor)

Validations:

  • Must be an array of any type

customer_provider[cnpj_cpf]
optional

CPF ou CNPJ do cliente/consumidor, dependendo do tipo de pessoa

Validations:

  • Must be String


DELETE /api/jp/:juridical_person_id/:customer_providers/:id
remove um cliente/fornecedor

Exclui um cliente/consumidor

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 24 Jan 2015 11:40:01 GMT

GET /api/jp/:juridical_person_id/entries
Lista os lançamentos de uma pessoal jurídica, é possivel filtrar os lançamentos utilizando os parametros abaixo: (os parametros de filtros dever ser URL encoded)

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "links":[
    {
      "rel":"next_page",
      "method":"get",
      "href":null
    },
    {
      "rel":"previous_page",
      "method":"get",
      "href":null
    },
    {
      "rel":"self",
      "method":"get",
      "href":"http://sandbox.contabilone.com.br/api/jp/1/entries"
    },
    {
      "rel":"create",
      "method":"post",
      "href":"http://sandbox.contabilone.com.br/api/jp/1/entries"
    }
  ],
  "entries":[
    {
      "entry":{
        "id":14,
        "description":"Compras de Café",
        "amount_total":"1000.0",
        "payment_date":"2014-12-08",
        "juridical_person_id":1,
        "created_at":"2014-12-02T14:20:29.000-02:00",
        "attachments_count":0,
        "historical_import_id":null,
        "assessment":null,
        "amount_interest":null,
        "amount_discount":null,
        "document":"",
        "modality_account_id":null,
        "customer_provider_id":null,
        "batch_id":null,
        "status":3,
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14"
          }
        ],
        "attachments":[

        ],
        "accounting_classifications":[
          {
            "accounting_classification":{
              "id":15,
              "booking_account_id":175,
              "amount":"500.0",
              "description_historical_default":"recebido de ",
              "origin":2,
              "links":[
                {
                  "rel":"destroy",
                  "method":"delete",
                  "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/48/accounting_classifications/15"

                }
              ]
            }
          }
        ]
      }
    },
    {
      "entry":{
        "id":12,
        "description":"Compras de Material de Limpeza",
        "amount_total":"200.0",
        "payment_date":"2014-12-02",
        "juridical_person_id":1,
        "created_at":"2014-12-02T14:19:44.000-02:00",
        "attachments_count":null,
        "historical_import_id":null,
        "assessment":null,
        "amount_interest":null,
        "amount_discount":null,
        "document":"",
        "modality_account_id":null,
        "customer_provider_id":null,
        "batch_id":null,
        "status":3,
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/12"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/12"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/12"
          }
        ],
        "attachments":[

        ],

        "accounting_classifications" :[

        ]
      }
    }
  ]
}

Params

Param name Description
entry_filter
optional

Validations:

  • Must be a Hash

entry_filter[payment_date_gte]
optional

Data de pagamento maior que:

Validations:

  • Must be Date

entry_filter[payment_date_lte]
optional

Data de pagamento menor que:

Validations:

  • Must be Date

entry_filter[category_ids_in]
optional

Identificador das categorias que deseja filtrar

Validations:

  • Must be an Array of nested elements

entry_filter[category_ids_in][]
optional

Validations:

  • Must be Integer

entry_filter[status_eq]
optional

Filtrar por status

Validations:

  • Must be Integer

entry_filter[batch_id_in]
optional

Identificador do batche que deseja filtrar

Validations:

  • Must be Integer

entry_filter[customer_provider_id_in]
optional

Identificador do cliente/fonercedore que deseja filtrar

Validations:

  • Must be Integer

entry_filter[booking_account_ids_in]
optional

Identificador dos planos de contas que deseja filtrar

Validations:

  • Must be an Array of nested elements

entry_filter[booking_account_ids_in][]
optional

Validations:

  • Must be Integer


GET /api/jp/:juridical_person_id/entries/:id
Exibe um Lançamento

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "entry":{
    "id":14,
    "description":"Compras de Café",
    "amount_total":"1000.0",
    "payment_date":"2014-12-08",
    "juridical_person_id":1,
    "created_at":"2014-12-02T14:20:29.000-02:00",
    "attachments_count":1,
    "historical_import_id":null,
    "assessment":null,
    "amount_interest":null,
    "amount_discount":null,
    "document":"",
    "modality_account_id":null,
    "customer_provider_id":null,
    "batch_id":null,
    "status":3,
    "attachments":[

    ],
    "accounting_classifications" :[

    ]
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14"
      }
    ],
  }
}

POST /api/jp/:juridical_person_id/entries
Cria um Lançamento e seus anexos relacionado a pessoa juridica selecionada

Para criação do lançamentos, é necessário enviar o valor total do mesmo e a data de pagamento se desejar fazer a classificação fiscal, é obrigatório o envio do identificador da conta contabil, do valor de credito OU de débito e do historico padrão.

Exemplo de corpo da requisição

{
  "entry" :
  {
    "payment_date":"05/01/2015",
    "description":"Taxí até o aeroporto",
    "amount_total":"500.00",
    "origin_entry":"Financial",
    "amount_interest":"10.00",
    "amount_discount":"25.00",
    "assessment":"25.00",
    "document":"",
    "modality_account_id":"1",
    "customer_provider_id":"5",
    "batch_id":"",
    "accounting_classifications":[
      {
        "booking_account_id":"2912",
        "amount_debit":"500,00",
        "description_historical_default":"Pgto de "
      },
      {
        "booking_account_id":"2872",
        "amount_credit":"500,00",
        "description_historical_default":"Pgto de "
      }
    ],
    "attachments":[
      {
        "source" : "data:image/jpg;base64, /9j/4AAQSkZJRgA...",
        "description" : "Fixed Gear"
      }
    ]
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/jp/:juridical_person_id/entries
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "entry":{
    "id":24,
    "description":"Taxí até o aeroporto",
    "amount_total":"500.0",
    "payment_date":"2015-01-05",
    "juridical_person_id":1,
    "created_at":"2015-01-05T18:03:41.265-02:00",
    "attachments_count":null,
    "historical_import_id":null,
    "assessment":"25.0",
    "amount_interest":"10.0",
    "amount_discount":"25.0",
    "document":"",
    "modality_account_id":1,
    "customer_provider_id":5,
    "batch_id":null,
    "status":1,
    "attachments":[
      {
        "attachment":{
          "id":996
          "description":"Fixed Gear",
          "source_content_type":"image/jpeg",
          "source_file_name":"fixa_red.jpg",
          "links":[
            {
              "rel":"destroy",
              "method":"delete",
              "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14/attachments/4"
            },
            {
              "rel":"download",
              "method":"get",
              "href":"http://sandbox.contabilone.com.br/api/jp/6/entries/53/attachments/28/download"
            },
            {
              rel: "self"
              method: "get"
              href: "http://sandbox.contabilone.com.br/api/jp/6/entries/53/attachments/28"
            }
          ]
        }
      }
    ],
    accounting_classifications":[
      {
        "accounting_classification":{
          "id":15,
          "booking_account_id":2912,
          "amount":"500.0",
          "description_historical_default":"Pgto de ",
          "origin":1,
          "links":[
            {
              "rel":"destroy",
              "method":"delete",
              "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/24/accounting_classifications/15"
            }
          ]
        }
      },
      {
        "accounting_classification":{
          "id":16
          "booking_account_id":2872,
          "amount":"500.0",
          "description_historical_default":"Pgto de ",
          "origin":2,
          "links":[
            {
              "rel":"destroy",
              "method":"delete",
              "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/24/accounting_classifications/16"
            }
          ]
        }
      }
    ],
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/24"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/24"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/24"
      }
    ],
  }
}

Params

Param name Description
entry
required

Validations:

  • Must be a Hash

entry[payment_date]
required

Data de pagamento do lançamento

Validations:

  • Must be Date

entry[description]
optional

Descrição do lançamento

Validations:

  • Must be String

entry[amount_total]
required

Valor total do lançamento

Validations:

  • Must be Float

entry[amount_interest]
optional

Valor de juros do lançamento

Validations:

  • Must be Float

entry[amount_discount]
optional

Valor de desconto do lançamento

Validations:

  • Must be Float

entry[assessment]
optional

Valor da multa do lançamento

Validations:

  • Must be Float

entry[document]
optional

Número do documento

Validations:

  • Must be Integer

entry[allocation_model]
optional

Tipo de Alocação: result_center (centro de custo) ou result_center_share (rateio)

Validations:

  • Must be String

entry[allocation_id]
optional

Id do objeto para o qual será feita a alocação

Validations:

  • Must be Integer

entry[category_ids]
optional

Identificadores de categoria

Validations:

  • Must be an Array of nested elements

entry[category_ids][]
optional

Validations:

  • Must be Integer

entry[attachments_attributes]
optional

Array de anexos

Validations:

  • Must be an Array of nested elements

entry[attachments_attributes][attachment]
optional

Validations:

  • Must be a Hash

entry[attachments_attributes][attachment][source]
optional

Arquivo codificado em Base64, seguido a seguinte especificação: “data: [FORMATO DO ARQUIVO]; base64, [STRING BASE64 DO ARQUIVO] ”

Validations:

  • Must be String

entry[attachments_attributes][attachment][description]
optional

Descrição do Anexo

Validations:

  • Must be String

entry[modality_account_id]
optional

Pago recebido via (identificador)

Validations:

  • Must be Integer

entry[customer_provider_id]
optional

Identificador do cliente/fornecedor

Validations:

  • Must be Integer

entry[batch_id]
optional

Identificador do batche

Validations:

  • Must be Integer

entry[accounting_classifications_attributes]
optional

Informações das classificações fiscais do lançamento

Validations:

  • Must be a Hash

entry[accounting_classifications_attributes][booking_account_id]
required

Identificador da conta contábil

Validations:

  • Must be Integer

entry[accounting_classifications_attributes][amount_debit]
required

Valor do débito

Validations:

  • Must be Float

entry[accounting_classifications_attributes][acount_credit]
required

Valor do crédito

Validations:

  • Must be Float

entry[accounting_classifications_attributes][description_historical_default]
required

Histórico padrão

Validations:

  • Must be String


DELETE /api/jp/:juridical_person_id/entries/:id
Exclui um lançamento

Exclui um lançamento especificado (via id) com uma resposta 204 Ok.

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GMT

PUT /api/jp/:juridical_person_id/entries/:id
Altera um lançamento

Altera um lançamento específico. Retornando a o lançamento alterado e status 200 Ok em caso de sucesso ou uma resposta 422 Unprocessable entity com a descrição dos erros em caso de falha.

Exemplo de corpo da requisição

{
  "entry" :
  {
    "payment_date":"05/01/2015",
    "description":"Taxi até o aeroporto",
    "amount_discount":"10.00",
    "assessment":"00.00",
    "document":"",
    "attachments":[
      {
        "source":"data:image/jpg;base64, /9j/4AAQSkZJRgA...",
        "description" : "Logo da Peugeot"

      }
    ]
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
  {
  "entry":{
    "id":25,
    "description":"Taxi até o aeroporto",
    "amount_total":"500.0",
    "payment_date":"2015-01-05",
    "juridical_person_id":1,
    "created_at":"2015-01-06T08:54:40.000-02:00",
    "attachments_count":null,
    "historical_import_id":null,
    "assessment":"0.0",
    "amount_interest":"10.0",
    "amount_discount":"10.0",
    "document":"",
    "modality_account_id":1,
    "customer_provider_id":5,
    "batch_id":null,
    "status":1,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/25"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/25"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/25"
      }
    ],
    "attachments":[
      {
        "attachment":{
          "description":"Logo da Peugeot",
          "attachment_link":"http://sandbox.contabilone.com.br/api/jp/1/entries/14/attachments/4/mirror",
          "links":[
            {
              "rel":"destroy",
              "method":"delete",
              "href":"http://sandbox.contabilone.com.br/api/jp/1/entries/14/attachments/4"
            }
          ]
        }
      }
    ],
    "accounting_classifications"[

    ]
  }
}

Params

Param name Description
entry
required

Validations:

  • Must be a Hash

entry[payment_date]
required

Data de pagamento do lançamento

Validations:

  • Must be Date

entry[description]
optional

Descrição do lançamento

Validations:

  • Must be String

entry[amount_total]
required

Valor total do lançamento

Validations:

  • Must be Float

entry[amount_interest]
optional

Valor de juros do lançamento

Validations:

  • Must be Float

entry[amount_discount]
optional

Valor de desconto do lançamento

Validations:

  • Must be Float

entry[assessment]
optional

Valor da multa do lançamento

Validations:

  • Must be Float

entry[document]
optional

Número do documento

Validations:

  • Must be Integer

entry[allocation_model]
optional

Tipo de Alocação: result_center (centro de custo) ou result_center_share (rateio)

Validations:

  • Must be String

entry[allocation_id]
optional

Id do objeto para o qual será feita a alocação

Validations:

  • Must be Integer

entry[category_ids]
optional

Identificadores de categoria

Validations:

  • Must be an Array of nested elements

entry[category_ids][]
optional

Validations:

  • Must be Integer

entry[attachments_attributes]
optional

Array de anexos

Validations:

  • Must be an Array of nested elements

entry[attachments_attributes][attachment]
optional

Validations:

  • Must be a Hash

entry[attachments_attributes][attachment][source]
optional

Arquivo codificado em Base64, seguido a seguinte especificação: “data: [FORMATO DO ARQUIVO]; base64, [STRING BASE64 DO ARQUIVO] ”

Validations:

  • Must be String

entry[attachments_attributes][attachment][description]
optional

Descrição do Anexo

Validations:

  • Must be String

entry[modality_account_id]
optional

Pago recebido via (identificador)

Validations:

  • Must be Integer

entry[customer_provider_id]
optional

Identificador do cliente/fornecedor

Validations:

  • Must be Integer

entry[batch_id]
optional

Identificador do batche

Validations:

  • Must be Integer

entry[accounting_classifications_attributes]
optional

Informações das classificações fiscais do lançamento

Validations:

  • Must be a Hash

entry[accounting_classifications_attributes][booking_account_id]
required

Identificador da conta contábil

Validations:

  • Must be Integer

entry[accounting_classifications_attributes][amount_debit]
required

Valor do débito

Validations:

  • Must be Float

entry[accounting_classifications_attributes][acount_credit]
required

Valor do crédito

Validations:

  • Must be Float

entry[accounting_classifications_attributes][description_historical_default]
required

Histórico padrão

Validations:

  • Must be String


GET /api/jp/:juridical_person_id/historical_imports
Lista os históricos de importação dos recursos de uma pessoa jurídica

Exemplo de requisição
curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api/jp/5/historical_imports?object=entry

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "links": [],
  "historical_imports": [{
      "historical_import": {
          "id": 18,
          "juridical_person_id": 5,
          "message": "Nenhum lançamento importado ou atualizado",
          "message_extend": {
              "created": "Criados",
              "updated": "Atualizados",
              "deleted": "Deletados"
              "failed" : "Falharam"
          },
          "object": "entry",
          "status": "success",
          "created_at": "2013-05-02T18:10:15Z",
          "updated_at": "2013-05-02T18:10:22Z",
          "filter": {
              "entity": "Teste",
              "date_gte": "02/04/2013",
              "date_lte": "02/05/2013"
          },
          "links": []
      }
  }
}

Params

Param name Description
object
optional

Utilizado para filtrar as importações de um recurso específico

Validations:

  • Must be String

limit
optional

Utilizado para limitar o número de registros retornados, Valor Padrão: 15

Validations:

  • Must be Integer


GET /api/jp
Lista pessoas jurídicas de uma conta(account)

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo

{

"links": [
  {
    "rel": "self",
    "method": "get",
    "href": "https://app.contabilone.com.br/api/jp"
  },
  {
    "rel": "create",
    "method": "post",
    "href": "https://app.contabilone.com.br/api/jp"
  }
],
"juridical_people": [
  {
    "juridical_person": {
      "id": 1,
      "social_reason": "Pessoa Juridica",
      "cnpj": "78722733000127",
      "account_id": 1,
      "accountant_id": 1,
      "date_gte": null,
      "date_lte": null,
      "sponsor_ids": [
        1
      ],
      "state": "MG",
      "state_inscription": "0",
      "date_open": "2017-12-08",
      "address": "Rua Arlindo Souza Monteiro",
      "number": 171,
      "complement": "",
      "district": "Santa Mônica",
      "city": "Uberlândia",
      "city_inscription": "",
      "join_register": "",
      "date_join_register": "2017-12-08",
      "business_activity_ids": [],
      "zip_code": "38408-074",
      "legal_nature_id": null,
      "parent_id": null,
      "tax_regime": 2,
      "simple_access_code": "",
      "created_at": "2017-12-08T10:43:32.735-02:00",
      "updated_at": "2017-12-08T10:43:32.735-02:00",
      "links": [
        {
          "rel": "self",
          "method": "get",
          "href": "https://app.contabilone.com.br/api/jp/1"
        },
        {
          "rel": "update",
          "method": "put",
          "href": "https://app.contabilone.com.br/api/jp/1"
        },
        {
          "rel": "destroy",
          "method": "delete",
          "href": "https://app.contabilone.com.br/api/jp/1"
        },
        {
          "rel": "accountant",
          "method": "get",
          "href": "https://app.contabilone.com.br/api/accountants/1"
        }
      ]
    }
  },
  {
    "juridical_person": {
      "id": 2,
      "social_reason": "Pessoa Juridica 2",
      "cnpj": "87373393000167",
      "account_id": 1,
      "accountant_id": 1,
      "date_gte": null,
      "date_lte": null,
      "sponsor_ids": [
        1
      ],
      "state": "MG",
      "state_inscription": "0",
      "date_open": "2017-12-08",
      "address": "Rua Arlindo Souza Monteiro",
      "number": 171,
      "complement": "",
      "district": "Santa Mônica",
      "city": "Uberlândia",
      "city_inscription": "",
      "join_register": "",
      "date_join_register": "2017-12-08",
      "business_activity_ids": [],
      "zip_code": "38408-074",
      "legal_nature_id": null,
      "parent_id": 1,
      "tax_regime": 2,
      "simple_access_code": "",
      "created_at": "2017-12-08T10:44:22.885-02:00",
      "updated_at": "2017-12-08T10:44:22.885-02:00",
      "links": [
        {
          "rel": "self",
          "method": "get",
          "href": "https://app.contabilone.com.br/api/jp/2"
        },
        {
          "rel": "update",
          "method": "put",
          "href": "https://app.contabilone.com.br/api/jp/2"
        },
        {
          "rel": "destroy",
          "method": "delete",
          "href": "https://app.contabilone.com.br/api/jp/2"
        },
        {
          "rel": "accountant",
          "method": "get",
          "href": "https://app.contabilone.com.br/api/accountants/1"
        }
      ]
    }
  },
  {
    "juridical_person": {
      "id": 3,
      "social_reason": "Some Social Reason",
      "cnpj": "20745146000173",
      "account_id": 1,
      "accountant_id": 1,
      "date_gte": null,
      "date_lte": null,
      "sponsor_ids": [],
      "state": "AL",
      "state_inscription": "0",
      "date_open": "2017-03-01",
      "address": "",
      "number": null,
      "complement": "",
      "district": "",
      "city": "",
      "city_inscription": "",
      "join_register": "",
      "date_join_register": "2017-03-01",
      "business_activity_ids": [],
      "zip_code": null,
      "legal_nature_id": null,
      "parent_id": 1,
      "tax_regime": 1,
      "simple_access_code": null,
      "created_at": "2017-12-08T11:01:14.515-02:00",
      "updated_at": "2017-12-08T11:01:14.515-02:00",
      "links": [
        {
          "rel": "self",
          "method": "get",
          "href": "https://app.contabilone.com.br/api/jp/3"
        },
        {
          "rel": "update",
          "method": "put",
          "href": "https://app.contabilone.com.br/api/jp/3"
        },
        {
          "rel": "destroy",
          "method": "delete",
          "href": "https://app.contabilone.com.br/api/jp/3"
        },
        {
          "rel": "accountant",
          "method": "get",
          "href": "https://app.contabilone.com.br/api/accountants/1"
        }
      ]
    }
  }
]

}


GET /api/jp/:id
Exibe uma pessoa jurídica.

Retorna os atributos de pessoa jurídica especificado (via id) com uma resposta 200 Ok.

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "juridical_person": {
    "id": 2,
    "social_reason": "Pessoa Juridica 2",
    "cnpj": "87373393000167",
    "account_id": 1,
    "accountant_id": 1,
    "date_gte": null,
    "date_lte": null,
    "sponsor_ids": [
        1
    ],
    "state": "MG",
    "state_inscription": "0",
    "date_open": "2017-12-08",
    "address": "Rua Arlindo Souza Monteiro",
    "number": 171,
    "complement": "",
    "district": "Santa Mônica",
    "city": "Uberlândia",
    "city_inscription": "",
    "join_register": "",
    "date_join_register": "2017-12-08",
    "business_activity_ids": [],
    "zip_code": "38408-074",
    "legal_nature_id": null,
    "parent_id": 1,
    "tax_regime": 2,
    "simple_access_code": "",
    "created_at": "2017-12-08T10:44:22.885-02:00",
    "updated_at": "2017-12-08T10:44:22.885-02:00",
    "links": [
      {
        "rel": "self",
        "method": "get",
        "href": "https://app.contabilone.com.br/api/jp/2"
      },
      {
        "rel": "update",
        "method": "put",
        "href": "https://app.contabilone.com.br/api/jp/2"
      },
      {
        "rel": "destroy",
        "method": "delete",
        "href": "https://app.contabilone.com.br/api/jp/2"
      },
      {
        "rel": "accountant",
        "method": "get",
        "href": "https://app.contabilone.com.br/api/accountants/1"
      }
    ]
  }
}

POST /api/jp
Cria uma pessoa jurídica relacionada a conta(account) autenticada

Para criação de nova pessoa jurídica, deve ser passado um CNPJ válido e uma razão social. A account usada nas requisições sempre será a account que está autenticada na requisição.

Exemplo de corpo da requisição

{

"juridical_person":{
  "social_reason":"Some Social Reason",
  "cnpj":"20745146000173",
  "date_gte": null ,
  "date_lte": null,
  "sponsor_ids": [],
  "state": "AL",
  "state_inscription": "0",
  "date_open": "01-03-2017",
  "address": "",
  "number": null,
  "complement": "",
  "district": "",
  "city": "",
  "city_inscription": "",
  "join_register": "",
  "date_join_register": "01-03-2017",
  "business_activity_ids": [],
  "accountant_id": 1,
  "parent_id": 1,
  "tax_regime": 1
}

}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/jp/11
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo

{

"juridical_person": {
  "id": 3,
  "social_reason": "Some Social Reason",
  "cnpj": "20745146000173",
  "account_id": 1,
  "accountant_id": 1,
  "date_gte": null,
  "date_lte": null,
  "sponsor_ids": [],
  "state": "AL",
  "state_inscription": "0",
  "date_open": "2017-03-01",
  "address": "",
  "number": null,
  "complement": "",
  "district": "",
  "city": "",
  "city_inscription": "",
  "join_register": "",
  "date_join_register": "2017-03-01",
  "business_activity_ids": [],
  "zip_code": null,
  "legal_nature_id": null,
  "parent_id": 1,
  "tax_regime": 1,
  "simple_access_code": null,
  "created_at": "2017-12-08T11:01:14.515-02:00",
  "updated_at": "2017-12-08T11:01:14.515-02:00"
  "links": [
    {
      "rel": "self",
      "method": "get",
      "href": "https://app.contabilone.com.br/api/jp/3"
    },
    {
      "rel": "update",
      "method": "put",
      "href": "https://app.contabilone.com.br/api/jp/3"
    },
    {
      "rel": "destroy",
      "method": "delete",
      "href": "https://app.contabilone.com.br/api/jp/3"
    },
    {
      "rel": "accountant",
      "method": "get",
      "href": "https://app.contabilone.com.br/api/accountants/1"
    }
  ]
}

}

Params

Param name Description
juridical_person
required

Validations:

  • Must be a Hash

juridical_person[social_reason]
required

Razão social da empresa

Validations:

  • Must be String

juridical_person[cnpj]
required

CNPJ válido da empresa.

Validations:

  • Must be String

juridical_person[accountant_id]
required

Identificador do contador responável

Validations:

  • Must be Integer

juridical_person[state]
required

Unidade Federativa onde a empresa está situada

Validations:

  • Must be one of: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO.

juridical_person[state_inscription]
optional

Inscrição estadual válido da empresa

Validations:

  • Must be String

juridical_person[date_open]
optional

Data de abertura da empresa

Validations:

  • Must be Date

juridical_person[address]
optional

Endereço da empresa

Validations:

  • Must be String

juridical_person[number]
optional

Número do prédio onde a empresa está situada

Validations:

  • Must be String

juridical_person[complement]
optional

Complemento da empresa

Validations:

  • Must be String

juridical_person[district]
optional

Bairro onde a empresa está situada

Validations:

  • Must be String

juridical_person[city]
optional

Cidade onde a empresa está situada

Validations:

  • Must be String

juridical_person[city_inscription]
optional

Inscrição Municipal

Validations:

  • Must be String

juridical_person[join_register]
optional

Registro na Junta

Validations:

  • Must be String

juridical_person[date_join_register]
optional

Data de Registro na Junta

Validations:

  • Must be Date

juridical_person[sponsor_ids]
optional

Identificador do responável legal da empresa

Validations:

  • Must be an array of any type

juridical_person[business_activity_ids]
optional

Ramos de Atividades

Validations:

  • Must be an array of any type

juridical_person[zip_code]
optional

CEP

Validations:

  • Must be String

juridical_person[legal_nature_id]
optional

Natureza Legal da Empresa

Validations:

  • Must be Integer

juridical_person[parent_id]
optional

Identificador da Empresa Matriz

Validations:

  • Must be Integer

juridical_person[tax_regime]
optional

Regime Tributário da Empresa

Validations:

  • Must be one of: 1, 2, 3.

juridical_person[simple_access_code]
optional

Código de Acesso ao Sistema do Simples Nacional

Validations:

  • Must be String


PUT /api/jp/:id
Altera uma pessoa jurídica

Altera uma pessoa jurídica específica. Retornando a pessoa jurídica alterada e status 200 Ok em caso de sucesso ou uma resposta 422 Unprocessable entity com a descrição dos erros em caso de falha.

Exemplo de corpo da requisição

{
  "juridical_person":{
    "social_reason":"Some Social Reason Updated"
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo

{

"juridical_person": {
  "id": 3,
  "social_reason": "Some Social Reason Updated",
  "cnpj": "20745146000173",
  "account_id": 1,
  "accountant_id": 1,
  "date_gte": null,
  "date_lte": null,
  "sponsor_ids": [],
  "state": "AL",
  "state_inscription": "0",
  "date_open": "2017-03-01",
  "address": "",
  "number": null,
  "complement": "",
  "district": "",
  "city": "",
  "city_inscription": "",
  "join_register": "",
  "date_join_register": "2017-03-01",
  "business_activity_ids": [],
  "zip_code": null,
  "legal_nature_id": null,
  "parent_id": 1,
  "tax_regime": 1,
  "simple_access_code": null,
  "created_at": "2017-12-08T11:01:14.515-02:00",
  "updated_at": "2017-12-08T11:01:14.515-02:00"
  "links": [
    {
      "rel": "self",
      "method": "get",
      "href": "https://app.contabilone.com.br/api/jp/3"
    },
    {
      "rel": "update",
      "method": "put",
      "href": "https://app.contabilone.com.br/api/jp/3"
    },
    {
      "rel": "destroy",
      "method": "delete",
      "href": "https://app.contabilone.com.br/api/jp/3"
    },
    {
      "rel": "accountant",
      "method": "get",
      "href": "https://app.contabilone.com.br/api/accountants/1"
    }
  ]
}

}

Params

Param name Description
juridical_person
required

Validations:

  • Must be a Hash

juridical_person[social_reason]
required

Razão social da empresa

Validations:

  • Must be String

juridical_person[cnpj]
required

CNPJ válido da empresa.

Validations:

  • Must be String

juridical_person[accountant_id]
required

Identificador do contador responável

Validations:

  • Must be Integer

juridical_person[state]
required

Unidade Federativa onde a empresa está situada

Validations:

  • Must be one of: AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO.

juridical_person[state_inscription]
optional

Inscrição estadual válido da empresa

Validations:

  • Must be String

juridical_person[date_open]
optional

Data de abertura da empresa

Validations:

  • Must be Date

juridical_person[address]
optional

Endereço da empresa

Validations:

  • Must be String

juridical_person[number]
optional

Número do prédio onde a empresa está situada

Validations:

  • Must be String

juridical_person[complement]
optional

Complemento da empresa

Validations:

  • Must be String

juridical_person[district]
optional

Bairro onde a empresa está situada

Validations:

  • Must be String

juridical_person[city]
optional

Cidade onde a empresa está situada

Validations:

  • Must be String

juridical_person[city_inscription]
optional

Inscrição Municipal

Validations:

  • Must be String

juridical_person[join_register]
optional

Registro na Junta

Validations:

  • Must be String

juridical_person[date_join_register]
optional

Data de Registro na Junta

Validations:

  • Must be Date

juridical_person[sponsor_ids]
optional

Identificador do responável legal da empresa

Validations:

  • Must be an array of any type

juridical_person[business_activity_ids]
optional

Ramos de Atividades

Validations:

  • Must be an array of any type

juridical_person[zip_code]
optional

CEP

Validations:

  • Must be String

juridical_person[legal_nature_id]
optional

Natureza Legal da Empresa

Validations:

  • Must be Integer

juridical_person[parent_id]
optional

Identificador da Empresa Matriz

Validations:

  • Must be Integer

juridical_person[tax_regime]
optional

Regime Tributário da Empresa

Validations:

  • Must be one of: 1, 2, 3.

juridical_person[simple_access_code]
optional

Código de Acesso ao Sistema do Simples Nacional

Validations:

  • Must be String


DELETE /api/jp/:id
Excluir uma pessoa jurídica

Exclui uma pessoa jurídica especificado (via id) com uma resposta 204 Ok.

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GM  T

GET /api/jp/:juridical_person_id/modality_accounts
Lista os pagar/receber via de uma empresa

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "modality_accounts":[
    {
      "modality_account":{
        "id":1,
        "modality":"Boleto Bancário",
        "juridical_person_id":6,
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
          }
        ]
      }
    },
    {
      "modality_account":{
        "id":2,
        "modality":"Cartão de Crédito",
        "juridical_person_id":6,
        "links":[
          {
            "rel":"self",
            "method":"get",
            "href":"http://localhost:3000/api/jp/6/modality_accounts/2"
          },
          {
            "rel":"update",
            "method":"put",
            "href":"http://localhost:3000/api/jp/6/modality_accounts/2"
          },
          {
            "rel":"destroy",
            "method":"delete",
            "href":"http://localhost:3000/api/jp/6/modality_accounts/2"
          }
        ],
      }
    }
  ]
  "links":[
    {
      "rel":"self",
      "method":"get",
      "href":"http://localhost:3000/api/jp/6/modality_accounts"
    },
    {
      "rel":"create",
      "method":"post",
      "href":"http://localhost:3000/api/jp/6/modality_accounts"
    }
  ]
}

GET /api/jp/:juridical_person_id/modality_accounts
Detalhes de um pagar/receber via de uma empresa

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 5 Jan 2015 14:47:00 GMT
Corpo
{
  "modality_account":{
    "id":1,
    "modality":"Boleto Bancário",
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      }
    ]
  }
}

POST /api/jp/:juridical_person_id/modality_accounts
Cria uma conta contábel para um plano de contas

Exemplo de corpo da requisição

{
	"modality_account" : {
		"modality" : "Caixa"
	}
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 201 Created
Location: https://app.contabilone.com.br/jp/:juridical_person_id/modality_account/:id
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "modality_account":{
    "id":3,
    "modality":"Caixa",
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      }
    ]
  }
}

Params

Param name Description
modality_account
required

Validations:

  • Must be a Hash

modality_account[modality]
required

Forma de pagamento/recebimento

Validations:

  • Must be String


PUT /api/jp/:juridical_person_id/modality_accounts/:id
altera um pagar/receber via específico

Exemplo de corpo da requisição

{
  "modality_account" : {
    "modality" : "Dinheiro Vivo"
  }
}

Exemplo de resposta

Cabeçalho
HTTP/1.1 200 OK
Location: https://app.contabilone.com.br/jp/:juridical_person_id/modality_account/1
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 13:27:00 GMT
Corpo
{
  "modality_account":{
    "id":1,
    "modality":"Dinheiro Vivo",
    "juridical_person_id":6,
    "links":[
      {
        "rel":"self",
        "method":"get",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      },
      {
        "rel":"update",
        "method":"put",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      },
      {
        "rel":"destroy",
        "method":"delete",
        "href":"http://localhost:3000/api/jp/6/modality_accounts/1"
      }
    ]
  }
}

Params

Param name Description
modality_account
required

Validations:

  • Must be a Hash

modality_account[modality]
required

Forma de pagamento/recebimento

Validations:

  • Must be String


DELETE /api/jp/:juridical_person_id/booking_plans/:modality_accounts/:id

Exclui um pago recebido via

Exemplo de resposta

HTTP/1.1 204 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 24 Jan 2015 11:40:01 GMT