Accountants

Accounting periods

Api

Attachments

Batches

Booking accounts

Booking plans

Business activities

Categories

Classification rules

Customer providers

Entries

Historical imports

Juridical people

Modality accounts

Result centers

SPED-account configurations

SPED-booking accounts

SPED-booking plans

SPED-bookkeeping files

SPED-bookkeepings

SPED-ECD-bookkeepings

Another API description


GET /api/accountants
Lista os Responsáveis Contábeis cadastrados na Conta do token passado

Exemplos

curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api/accountants
{
  "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.

Exemplos

{
  "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 Contábil 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 Conta usada nas requisições sempre será a account que está autenticada na requisição.

Exemplos

Request:

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

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
accountants
requerido

Validação

  • Deve ser um Hash
accountants[full_name]
requerido
Nome completo do responsável

Validação

  • Deve ser um String
accountants[person_type]
requerido
Tipo do responsável: 1 - Pessoa Física; 2 - Pessoa Jurídica

Validação

  • Deve ser um Integer
accountants[cpf_cnpj]
requerido
CPF ou CNPJ válido

Validação

  • Deve ser um String
accountants[crc_state]
requerido
Sigla do estado de registro do CRC do responsável. Deve ser a sigla de um estado brasileiro válido

Validação

  • Deve ser um String
accountants[crc_number]
requerido
Registro CRC do responsável

Validação

  • Deve ser um String

PUT /api/accountants/:id
Altera um Responsável Contábil

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.

Exemplos

Request:

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

Response:

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
accountants
requerido

Validação

  • Deve ser um Hash
accountants[full_name]
requerido
Nome completo do responsável

Validação

  • Deve ser um String
accountants[person_type]
requerido
Tipo do responsável: 1 - Pessoa Física; 2 - Pessoa Jurídica

Validação

  • Deve ser um Integer
accountants[cpf_cnpj]
requerido
CPF ou CNPJ válido

Validação

  • Deve ser um String
accountants[crc_state]
requerido
Sigla do estado de registro do CRC do responsável. Deve ser a sigla de um estado brasileiro válido

Validação

  • Deve ser um String
accountants[crc_number]
requerido
Registro CRC do responsável

Validação

  • Deve ser um String

DELETE /api/accountants/:id
Exclui um Responsável Contábil

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

Exemplos

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

POST /api/accountants
Cria um Responsável Contábil a Conta (Account) autenticada


PUT /api/jp/:juridical_person_id/entries/:entries_id/attachments/:id
Exclui um Anexo

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

Exemplos

'curl -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json" https://app.contabilone.com.br/api --basic'
Success response:
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Wed, 26 Jan 2011 12:56:01 GMT

{ "status":"Authenticated" }

Erros

Code Description Metadata
401 Unauthorized
error: unauthorized

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

Exemplos

{
  "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.

Exemplos

Response:
  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.

Exemplos

Response:
  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

Exemplos

{
  "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
Exibe um Lote

Exemplos

{
  "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

Exemplos

Request:

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

Response:

  {
    "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

Exemplos

Request:

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

Response:

  {
    "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

Exemplos

Response:
  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

Exemplos

{
  "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"
          }
        ]
      }
    }
  ]
}

Parâmetros

Nome parâmetro Descrição
page
opcional
Número da Página que deseja acessar

Validação

  • Deve ser um Integer

GET /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/booking_account/:id
Exibe uma Conta Contábil

Exemplos

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
page
opcional
Número da Página que deseja acessar

Validação

  • Deve ser um Integer

POST /api/jp/:juridical_person_id/booking_plan/:booking_plan_id/booking_accounts
Cria uma Conta Contábil

Exemplos

Request:

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

Response:

  {
    "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"
        }
      ]
    }
  }

Parâmetros

Nome parâmetro Descrição
booking_account
requerido

Validação

  • Deve ser um Hash
booking_account[number]
requerido
Numero da conta, ex: 1.001.001.01, (deve estar de acordo com a máscara definida no plano de contas)

Validação

  • Deve ser um String
booking_account[name]
requerido
Nome da conta

Validação

  • Deve ser um String
booking_account[small_id]
opcional
Identificador personalizado da conta

Validação

  • Deve ser um String
booking_account[origin]
requerido
Origem do Lançamento (1 para devedora e 2 para credora)

Validação

  • Deve ser um Integer
booking_account[nature]
opcional
Identificador da natureza da conta

Validação

  • Deve ser um Integer
booking_account[account_type]
opcional
Tipo de conta (synthetic ou analytic)

Validação

  • Deve ser um String
booking_account[initial_balance_attributes]
opcional
Atributos do saldo inicial

Validação

  • Deve ser um array de elementos aninhados
booking_account[initial_balance_attributes][initial_balance]
requerido
Balanço Inicial

Validação

  • Deve ser um Float
booking_account[initial_balance_attributes][normal_balance]
opcional
Tipo de balanço ("credit" e "debit")

Validação

  • Deve ser um Integer

PUT /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/booking_accounts/:id
Altera uma Conta Contábil

Exemplos

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

Response:
    {
  	"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"
      }]
      }
    }

Parâmetros

Nome parâmetro Descrição
booking_account
requerido

Validação

  • Deve ser um Hash
booking_account[number]
requerido
Numero da conta, ex: 1.001.001.01, (deve estar de acordo com a máscara definida no plano de contas)

Validação

  • Deve ser um String
booking_account[name]
requerido
Nome da conta

Validação

  • Deve ser um String
booking_account[small_id]
opcional
Identificador personalizado da conta

Validação

  • Deve ser um String
booking_account[origin]
requerido
Origem do Lançamento (1 para devedora e 2 para credora)

Validação

  • Deve ser um Integer
booking_account[nature]
opcional
Identificador da natureza da conta

Validação

  • Deve ser um Integer
booking_account[account_type]
opcional
Tipo de conta (synthetic ou analytic)

Validação

  • Deve ser um String
booking_account[initial_balance_attributes]
opcional
Atributos do saldo inicial

Validação

  • Deve ser um array de elementos aninhados
booking_account[initial_balance_attributes][initial_balance]
requerido
Balanço Inicial

Validação

  • Deve ser um Float
booking_account[initial_balance_attributes][normal_balance]
opcional
Tipo de balanço ("credit" e "debit")

Validação

  • Deve ser um Integer

DELETE /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/booking_accounts/:id
Exclui uma Conta Contábil

Exclui uma Conta Contábil e todas as Contas Contábeis abaixo dela, os Lançamento dependentes, perdem sua classificação

Exemplos

Response:
  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 Plano de Contas

Exemplos

Response:

{
  "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 um Plano de Contas

Exemplos

Request:

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

  {
    "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"
        }
      ]
    }
  }

Parâmetros

Nome parâmetro Descrição
booking_plan
requerido

Validação

  • Deve ser um Hash
booking_plan[name]
opcional
Nome da Plano de Contas

Validação

  • Deve ser um String
booking_plan[mask]
opcional
Máscara das contas contábeis, padrão: X.XXX.XXX.XXX.XXX.XXXX

Validação

  • Deve ser um String

GET /api/jp/:juridical_person_id/booking_plans/:booking_plan_id
Exibe um Plano de Contas

Exemplos

Response:

{
  "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 um Plano de Conta

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

Exemplos

Response:
  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 disponíveis para cadastrar Pessoas Jurídicas

Exemplos

Response:

{
  "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"
          }
        ]
      }
    }
  ]
}

Parâmetros

Nome parâmetro Descrição
limit
opcional
Utilizado para limitar o número de registros retornados, Valor Padrão: 100

Validação

  • Deve ser um 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.

Exemplos

Response:

{
  "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

Exemplos

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

{
  "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.

Exemplos

Response:

  {
    "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 uma Categoria

Exemplos

Request:

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

  {
    "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"
        }
      ]
    }
  }

Parâmetros

Nome parâmetro Descrição
category
requerido

Validação

  • Deve ser um Hash
category[name]
requerido
Nome da Categoria

Validação

  • Deve ser um String

PUT /api/jp/:juridical_person_id/categories/:id
Altera uma Categoria

Altera uma Categoria específica. 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.

Exemplos

Request:

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

  {
    "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"
        }
      ]
    }
  }

Parâmetros

Nome parâmetro Descrição
category
requerido

Validação

  • Deve ser um Hash
category[name]
requerido
Nome da Categoria

Validação

  • Deve ser um String

DELETE /api/jp/:juridical_person_id/categories/:id
Exclui uma Categoria

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

Exemplos

Response:
  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 Automáticas

Exemplos

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
Response:

{
  "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":[]
      }
    }
  ]
}

Parâmetros

Nome parâmetro Descrição
limit
opcional
Utilizado para limitar o número de registros retornados, Valor Padrão: 15

Validação

  • Deve ser um 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)

Exemplos

Response:

{
  "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
Exibe um Cliente/Fornecedor

Exemplos

Response:

{
  "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/Fornecedor

Exemplos

Request:

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

Response:

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
customer_provider
requerido

Validação

  • Deve ser um Hash
customer_provider[name]
requerido
Nome do Cliente/Fornecedor

Validação

  • Deve ser um String
customer_provider[person_type]
requerido
Tipo de pessoa (1 para pessoa física e 2 para pessoa jurídica)

Validação

  • Deve ser um Integer
customer_provider[service_type]
requerido
Tipo de serviço prestado (1 para pessoa cliente e 2 para fornecedor)

Validação

  • Must be an array of any type
customer_provider[cnpj_cpf]
opcional
CPF ou CNPJ do cliente/consumidor, dependendo do tipo de pessoa

Validação

  • Deve ser um String

PUT /api/jp/:juridical_person_id/customer_providers/:id
Altera uma Categoria

Exemplos

Request:

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

Response:

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
customer_provider
requerido

Validação

  • Deve ser um Hash
customer_provider[name]
requerido
Nome do Cliente/Fornecedor

Validação

  • Deve ser um String
customer_provider[person_type]
requerido
Tipo de pessoa (1 para pessoa física e 2 para pessoa jurídica)

Validação

  • Deve ser um Integer
customer_provider[service_type]
requerido
Tipo de serviço prestado (1 para pessoa cliente e 2 para fornecedor)

Validação

  • Must be an array of any type
customer_provider[cnpj_cpf]
opcional
CPF ou CNPJ do cliente/consumidor, dependendo do tipo de pessoa

Validação

  • Deve ser um String

DELETE /api/jp/:juridical_person_id/:customer_providers/:id
Exclui uma Categoria

Exemplos

Exclui um cliente/consumidor
Response:
  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 Pessoa Jurídica, é possivel filtrar os Lançamentos utilizando os parâmetros abaixo: (os parâmetros de filtros dever ser URL encoded)

Exemplos

{
  "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"

                }
              ]
            }
          }
        ],
        "allocations" :[

        ]
      }
    },
    {
      "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" :[

        ],
        "allocations" :[

        ]
      }
    }
  ]
}

Parâmetros

Nome parâmetro Descrição
entry_filter
opcional

Validação

  • Deve ser um Hash
entry_filter[payment_date_gte]
opcional
Data de pagamento maior que:

Validação

  • Deve ser um Date
entry_filter[payment_date_lte]
opcional
Data de pagamento menor que:

Validação

  • Deve ser um Date
entry_filter[category_ids_in]
opcional
Identificador das Categorias que deseja filtrar

Validação

  • Deve ser um array de elementos aninhados
entry_filter[category_ids_in][]
opcional

Validação

  • Deve ser um Integer
entry_filter[status_eq]
opcional
Filtrar por status

Validação

  • Deve ser um Integer
entry_filter[batch_id_in]
opcional
Identificador do batche que deseja filtrar

Validação

  • Deve ser um Integer
entry_filter[customer_provider_id_in]
opcional
Identificador do cliente/fornecedor que deseja filtrar

Validação

  • Deve ser um Integer
entry_filter[booking_account_ids_in]
opcional
Identificador dos Planos de Contas que deseja filtrar

Validação

  • Deve ser um array de elementos aninhados
entry_filter[booking_account_ids_in][]
opcional

Validação

  • Deve ser um Integer

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

Exemplos

{
  "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" :[

    ],
    "allocations":[

    ],
    "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 Jurídica 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 Contábil, do valor de Crédito OU de Débito e do Histórico Padrão.

Exemplos

Request:

{
  "entry" :
  {
    "payment_date":"05/01/2015",
    "description":"Taxí até o aeroporto",
    "amount_total":"500.50",
    "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.50",
        "description_historical_default":"Pgto de "
      },
      {
        "booking_account_id":"2872",
        "amount_credit":"500.50",
        "description_historical_default":"Pgto de "
      }
    ],
    "attachments":[
      {
        "source" : "data:image/jpg;base64, /9j/4AAQSkZJRgA...",
        "description" : "Fixed Gear"
      }
    ],
    "allocations_attributes":[
      {
        "result_center_id":"2912",
        "result_center_share_id":"313",
        "rate":"500.50"
      }
    ],
  }
}
Response:

  {
    "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"
              }
            ]
          }
        }
      ],
      allocations":[
        {
          "allocation":{
            "id":439,
            "result_center_id":2912,
            "result_center_share_id":313,
            "rate":"634.05"
          }
        }
      ],
      "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"
        }
      ],
    }
  }

Parâmetros

Nome parâmetro Descrição
entry
requerido

Validação

  • Deve ser um Hash
entry[payment_date]
requerido
Data de pagamento do Lançamento

Validação

  • Deve ser um Date
entry[description]
opcional
Descrição do Lançamento

Validação

  • Deve ser um String
entry[amount_total]
requerido
Valor total do Lançamento

Validação

  • Deve ser um Float
entry[amount_interest]
opcional
Valor de juros do Lançamento

Validação

  • Deve ser um Float
entry[amount_discount]
opcional
Valor de desconto do Lançamento

Validação

  • Deve ser um Float
entry[assessment]
opcional
Valor da multa do Lançamento

Validação

  • Deve ser um Float
entry[document]
opcional
Número do documento

Validação

  • Deve ser um Integer
entry[allocation_model]
opcional
Tipo de Alocação: result_center (Centro de Custo) ou result_center_share (Rateio)

Validação

  • Deve ser um String
entry[allocation_id]
opcional
Id do objeto para o qual será feita a alocação

Validação

  • Deve ser um Integer
entry[origin_entry]
opcional
Origem

Validação

  • Deve ser um dos valores: Financial, Fiscal, HumanResources.
entry[category_ids]
opcional
Identificadores de Categoria

Validação

  • Deve ser um array de elementos aninhados
entry[category_ids][]
opcional

Validação

  • Deve ser um Integer
entry[attachments_attributes]
opcional
Array de Anexos

Validação

  • Deve ser um array de elementos aninhados
entry[attachments_attributes][attachment]
opcional

Validação

  • Deve ser um Hash
entry[attachments_attributes][attachment][source]
opcional
Arquivo codificado em Base64, seguindo a seguinte especificação: "data: [FORMATO DO ARQUIVO]; base64, [STRING BASE64 DO ARQUIVO] "

Validação

  • Deve ser um String
entry[attachments_attributes][attachment][description]
opcional
Descrição do Anexo

Validação

  • Deve ser um String
entry[modality_account_id]
opcional
Pago recebido via (identificador)

Validação

  • Deve ser um Integer
entry[customer_provider_id]
opcional
Identificador do Cliente/fornecedor

Validação

  • Deve ser um Integer
entry[batch_id]
opcional
Identificador do batch

Validação

  • Deve ser um Integer
entry[accounting_classifications_attributes]
opcional
Informações das classificações fiscais do Lançamento

Validação

  • Deve ser um Hash
entry[accounting_classifications_attributes][booking_account_id]
requerido
Identificador da Conta Contábil

Validação

  • Deve ser um Integer
entry[accounting_classifications_attributes][amount_debit]
requerido
Valor do débito

Validação

  • Deve ser um Float
entry[accounting_classifications_attributes][acount_credit]
requerido
Valor do crédito

Validação

  • Deve ser um Float
entry[accounting_classifications_attributes][description_historical_default]
requerido
Histórico padrão

Validação

  • Deve ser um String
entry[allocations_attributes]
opcional
Informações das locações para o Lançamento

Validação

  • Deve ser um Hash
entry[allocations_attributes][result_center_id]
requerido
Identificador do Centro de Resultado

Validação

  • Deve ser um Integer
entry[allocations_attributes][result_center_share_id]
requerido
Identificador do rateio

Validação

  • Deve ser um Integer
entry[allocations_attributes][rate]
requerido
Valor do rateio

Validação

  • Deve ser um Float

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.

Exemplos

Request:

{
  "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"

      }
    ]
  }
}
Response:

  {
  "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"[

    ]
  }
}

Parâmetros

Nome parâmetro Descrição
entry
requerido

Validação

  • Deve ser um Hash
entry[payment_date]
requerido
Data de pagamento do Lançamento

Validação

  • Deve ser um Date
entry[description]
opcional
Descrição do Lançamento

Validação

  • Deve ser um String
entry[amount_total]
requerido
Valor total do Lançamento

Validação

  • Deve ser um Float
entry[amount_interest]
opcional
Valor de juros do Lançamento

Validação

  • Deve ser um Float
entry[amount_discount]
opcional
Valor de desconto do Lançamento

Validação

  • Deve ser um Float
entry[assessment]
opcional
Valor da multa do Lançamento

Validação

  • Deve ser um Float
entry[document]
opcional
Número do documento

Validação

  • Deve ser um Integer
entry[allocation_model]
opcional
Tipo de Alocação: result_center (Centro de Custo) ou result_center_share (Rateio)

Validação

  • Deve ser um String
entry[allocation_id]
opcional
Id do objeto para o qual será feita a alocação

Validação

  • Deve ser um Integer
entry[origin_entry]
opcional
Origem

Validação

  • Deve ser um dos valores: Financial, Fiscal, HumanResources.
entry[category_ids]
opcional
Identificadores de Categoria

Validação

  • Deve ser um array de elementos aninhados
entry[category_ids][]
opcional

Validação

  • Deve ser um Integer
entry[attachments_attributes]
opcional
Array de Anexos

Validação

  • Deve ser um array de elementos aninhados
entry[attachments_attributes][attachment]
opcional

Validação

  • Deve ser um Hash
entry[attachments_attributes][attachment][source]
opcional
Arquivo codificado em Base64, seguindo a seguinte especificação: "data: [FORMATO DO ARQUIVO]; base64, [STRING BASE64 DO ARQUIVO] "

Validação

  • Deve ser um String
entry[attachments_attributes][attachment][description]
opcional
Descrição do Anexo

Validação

  • Deve ser um String
entry[modality_account_id]
opcional
Pago recebido via (identificador)

Validação

  • Deve ser um Integer
entry[customer_provider_id]
opcional
Identificador do Cliente/fornecedor

Validação

  • Deve ser um Integer
entry[batch_id]
opcional
Identificador do batch

Validação

  • Deve ser um Integer
entry[accounting_classifications_attributes]
opcional
Informações das classificações fiscais do Lançamento

Validação

  • Deve ser um Hash
entry[accounting_classifications_attributes][booking_account_id]
requerido
Identificador da Conta Contábil

Validação

  • Deve ser um Integer
entry[accounting_classifications_attributes][amount_debit]
requerido
Valor do débito

Validação

  • Deve ser um Float
entry[accounting_classifications_attributes][acount_credit]
requerido
Valor do crédito

Validação

  • Deve ser um Float
entry[accounting_classifications_attributes][description_historical_default]
requerido
Histórico padrão

Validação

  • Deve ser um String
entry[allocations_attributes]
opcional
Informações das locações para o Lançamento

Validação

  • Deve ser um Hash
entry[allocations_attributes][result_center_id]
requerido
Identificador do Centro de Resultado

Validação

  • Deve ser um Integer
entry[allocations_attributes][result_center_share_id]
requerido
Identificador do rateio

Validação

  • Deve ser um Integer
entry[allocations_attributes][rate]
requerido
Valor do rateio

Validação

  • Deve ser um Float

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

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

Exemplos

Response:
  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/historical_imports
Lista os Históricos de Importação dos recursos de uma Pessoa Jurídica

Exemplos

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
{
  "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": []
      }
  }
}

Parâmetros

Nome parâmetro Descrição
object
opcional
Utilizado para filtrar as importações de um recurso específico

Validação

  • Deve ser um String
limit
opcional
Utilizado para limitar o número de registros retornados. Valor padrão: 15

Validação

  • Deve ser um Integer

GET /api/jp
Lista as Pessoas Jurídicas cadastradas na Conta

Exemplos

Response:

{
  "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.

Exemplos

Response:

  {
    "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

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

Exemplos

Request:

{
  "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
  }
}
Response:

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
juridical_person
requerido

Validação

  • Deve ser um Hash
juridical_person[social_reason]
requerido
Razão social da empresa

Validação

  • Deve ser um String
juridical_person[cnpj]
requerido
CNPJ válido da empresa

Validação

  • Deve ser um String
juridical_person[accountant_id]
requerido
Identificador do Responável Contábil

Validação

  • Deve ser um Integer
juridical_person[state]
requerido
Unidade Federativa onde a empresa está situada

Validação

  • Deve ser um dos valores: 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]
opcional
Inscrição estadual válido da empresa

Validação

  • Deve ser um String
juridical_person[date_open]
opcional
Data de abertura da empresa

Validação

  • Deve ser um Date
juridical_person[address]
opcional
Endereço da empresa

Validação

  • Deve ser um String
juridical_person[number]
opcional
Número do prédio onde a empresa está situada

Validação

  • Deve ser um String
juridical_person[complement]
opcional
Complemento da empresa

Validação

  • Deve ser um String
juridical_person[district]
opcional
Bairro onde a empresa está situada

Validação

  • Deve ser um String
juridical_person[city]
opcional
Cidade onde a empresa está situada

Validação

  • Deve ser um String
juridical_person[city_inscription]
opcional
Inscrição Municipal

Validação

  • Deve ser um String
juridical_person[join_register]
opcional
Registro na Junta

Validação

  • Deve ser um String
juridical_person[date_join_register]
opcional
Data de Registro na Junta

Validação

  • Deve ser um Date
juridical_person[sponsor_ids]
opcional
Identificador do responável legal da empresa

Validação

  • Must be an array of any type
juridical_person[business_activity_ids]
opcional
Ramos de Atividades

Validação

  • Must be an array of any type
juridical_person[zip_code]
opcional
CEP

Validação

  • Deve ser um String
juridical_person[legal_nature_id]
opcional
Natureza Legal da Empresa

Validação

  • Deve ser um Integer
juridical_person[parent_id]
opcional
Identificador da Empresa Matriz

Validação

  • Deve ser um Integer
juridical_person[tax_regime]
opcional
Regime Tributário da Empresa

Validação

  • Deve ser um dos valores: 1, 2, 3.
juridical_person[simple_access_code]
opcional
Código de Acesso ao Sistema do Simples Nacional

Validação

  • Deve ser um 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.

Exemplos

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

Response:

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
juridical_person
requerido

Validação

  • Deve ser um Hash
juridical_person[social_reason]
requerido
Razão social da empresa

Validação

  • Deve ser um String
juridical_person[cnpj]
requerido
CNPJ válido da empresa

Validação

  • Deve ser um String
juridical_person[accountant_id]
requerido
Identificador do Responável Contábil

Validação

  • Deve ser um Integer
juridical_person[state]
requerido
Unidade Federativa onde a empresa está situada

Validação

  • Deve ser um dos valores: 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]
opcional
Inscrição estadual válido da empresa

Validação

  • Deve ser um String
juridical_person[date_open]
opcional
Data de abertura da empresa

Validação

  • Deve ser um Date
juridical_person[address]
opcional
Endereço da empresa

Validação

  • Deve ser um String
juridical_person[number]
opcional
Número do prédio onde a empresa está situada

Validação

  • Deve ser um String
juridical_person[complement]
opcional
Complemento da empresa

Validação

  • Deve ser um String
juridical_person[district]
opcional
Bairro onde a empresa está situada

Validação

  • Deve ser um String
juridical_person[city]
opcional
Cidade onde a empresa está situada

Validação

  • Deve ser um String
juridical_person[city_inscription]
opcional
Inscrição Municipal

Validação

  • Deve ser um String
juridical_person[join_register]
opcional
Registro na Junta

Validação

  • Deve ser um String
juridical_person[date_join_register]
opcional
Data de Registro na Junta

Validação

  • Deve ser um Date
juridical_person[sponsor_ids]
opcional
Identificador do responável legal da empresa

Validação

  • Must be an array of any type
juridical_person[business_activity_ids]
opcional
Ramos de Atividades

Validação

  • Must be an array of any type
juridical_person[zip_code]
opcional
CEP

Validação

  • Deve ser um String
juridical_person[legal_nature_id]
opcional
Natureza Legal da Empresa

Validação

  • Deve ser um Integer
juridical_person[parent_id]
opcional
Identificador da Empresa Matriz

Validação

  • Deve ser um Integer
juridical_person[tax_regime]
opcional
Regime Tributário da Empresa

Validação

  • Deve ser um dos valores: 1, 2, 3.
juridical_person[simple_access_code]
opcional
Código de Acesso ao Sistema do Simples Nacional

Validação

  • Deve ser um String

DELETE /api/jp/:id
Exclui uma Pessoa Jurídica

Exclui uma Pessoa Jurídica especificada (via id) com uma resposta 204 Ok.

Exemplos

Response:
  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 as Formas de pagamento/recebimento

Exemplos

Response:

{
  "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
Exibe uma Forma de pagamento/recebimento

Exemplos

Response:

{
  "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 Forma de pagamento/recebimento

Exemplos

Request:

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

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
modality_account
requerido

Validação

  • Deve ser um Hash
modality_account[modality]
requerido
Nome da forma de pagamento/recebimento

Validação

  • Deve ser um String

PUT /api/jp/:juridical_person_id/modality_accounts/:id
Altera uma Forma de pagamento/recebimento

Exemplos

Request:

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

{
  "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"
      }
    ]
  }
}

Parâmetros

Nome parâmetro Descrição
modality_account
requerido

Validação

  • Deve ser um Hash
modality_account[modality]
requerido
Nome da forma de pagamento/recebimento

Validação

  • Deve ser um String

DELETE /api/jp/:juridical_person_id/modality_accounts/:id
Exclui uma Forma de pagamento/recebimento

Exclui uma forma de pagamento/recebimento

Exemplos

Response:
  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/result_centers
Lista os Centros de Resultado de um determinada pessoa jurídica. Há a opção de filtrar por uma lista de nomes

Exemplos

Request

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

{
  "result_centers":[
    {
      "result_center":{
        "id": 1,
        "juridical_person_id": 1,
        "name": "CR0002",
        "full_name": "CR0002",
        "cost": true,
        "revenue": true,
        "manager_id": null,
        "parent_id": null,
        "depth": 0,
        "children_count": 0,
        "created_at": "2016-10-27T09:34:37.971-02:00",
        "updated_at": "2017-04-11T17:45:48.447-03:00",
        "links":[{"rel": "self", "method": "get", "href": "https://app.contabilone.com.br/api/jp/1/result_centers/1"…]
      }
    },
    {
      "result_center":{
        "id": 2,
        "juridical_person_id": 1,
        "name": "CR004",
        "full_name": "CR004",
        "cost": true,
        "revenue": true,
        "manager_id": null,
        "parent_id": null,
        "depth": 0,
        "children_count": 1,
        "created_at": "2017-03-03T17:43:21.696-03:00",
        "updated_at": "2018-03-28T17:59:51.497-03:00",
        "links":[{"rel": "self", "method": "get", "href": "https://app.contabilone.com.br/api/jp/1/result_centers/1"…]
      }
    }
  ]
}
Filtering by a list of names. Request:

curl --basic -u "[token]" -X GET -H "Accept:application/json" -H "Content-Type:application/json" 'https://app.contabilone.com.br/api/jp/1/result_centers?names%5B%5D=Centro+XPTO&names%5B%5D=Centro+YYYY'
Filtering by a list of names. Response body:

{
  "result_centers":[
    {
      "result_center":{
        "id": 8,
        "juridical_person_id": 1,
        "name": "Centro XPTO",
        "full_name": "Centro XPTO",
        "cost": true,
        "revenue": false,
        "manager_id": null,
        "parent_id": null,
        "depth": 0,
        "children_count": 0,
        "created_at": "2018-07-25T15:57:08.888-03:00",
        "updated_at": "2018-07-25T15:57:08.888-03:00",
        "links":[{"rel": "self", "method": "get", "href": "https://app.contabilone.com.br/api/jp/1/result_centers/8"…]
      }
    },
    {
      "result_center":{
        "id": 7,
        "juridical_person_id": 1,
        "name": "Centro YYYY",
        "full_name": "Centro YYYY",
        "cost": true,
        "revenue": false,
        "manager_id": null,
        "parent_id": null,
        "depth": 0,
        "children_count": 0,
        "created_at": "2018-07-25T12:18:43.854-03:00",
        "updated_at": "2018-07-25T12:18:43.854-03:00",
        "links":[{"rel": "self", "method": "get", "href": "https://app.contabilone.com.br/api/jp/1/result_centers/7"…]
      }
    }
  ]
}

Parâmetros

Nome parâmetro Descrição
names
opcional
Nome (descrição) do Centro de Resultado. O nome é único no escopo de uma empresa

Validação

  • Deve ser um array de elementos aninhados
names[]
opcional

Validação

  • Deve ser um String

GET /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/sped/account_configurations
Lista as configurações de Conta de uma PJ

Exemplos

Response:

{
  "account_configurations": [
      {
          "account_configuration": {
              "id": 1,
              "booking_account_id": 6177,
              "ecd_account_id": null,
              "ecf_account_id": null,
              "links": [
                  {
                      "rel": "destroy",
                      "method": "delete",
                      "href": "https://app.contabilone.com.br/api/jp/1/booking_plans/1/sped/account_configurations/1"
                  }
              ]
          }
      },
      {
          "account_configuration": {
              "id": 2,
              "booking_account_id": 6178,
              "ecd_account_id": null,
              "ecf_account_id": null,
              "links": [
                  {
                      "rel": "destroy",
                      "method": "delete",
                      "href": "https://app.contabilone.com.br/api/jp/1/booking_plans/1/sped/account_configurations/2"
                  }
              ]
          }
      },
      {
          "account_configuration": {
              "id": 3,
              "booking_account_id": 6179,
              "ecd_account_id": null,
              "ecf_account_id": null,
              "links": [
                  {
                      "rel": "destroy",
                      "method": "delete",
                      "href": "https://app.contabilone.com.br/api/jp/1/booking_plans/1/sped/account_configurations/3"
                  }
              ]
          }
      },
      {
          "account_configuration": {
              "id": 4,
              "booking_account_id": 6180,
              "ecd_account_id": null,
              "ecf_account_id": null,
              "links": [
                  {
                      "rel": "destroy",
                      "method": "delete",
                      "href": "https://app.contabilone.com.br/api/jp/1/booking_plans/1/sped/account_configurations/4"
                  }
              ]
          }
      }
    ],
    "links": [
        {
            "rel": "save",
            "method": "post",
            "href": "https://app.contabilone.com.br/api/jp/1/booking_plans/1/sped/account_configurations/save"
        }
    ]
}

POST /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/sped/account_configurations/save
Cria ou atualiza uma Configuração de Conta

Exemplos

Request:

{
  "account_configuration":
  {
    "booking_account_id": 6341,
    "ecd_account_id": 3145,
    "ecf_account_id": null
  }
}

Response:

{
  "account_configuration": {
      "id": 166,
      "booking_account_id": 6341,
      "ecd_account_id": 3145,
      "ecf_account_id": null,
      "links": [
          {
              "rel": "destroy",
              "method": "delete",
              "href": "https://app.contabilone.com.br/api/jp/1/booking_plans/1/sped/account_configurations/166"
          }
      ]
  }
}

Parâmetros

Nome parâmetro Descrição
account_configuration
requerido

Validação

  • Deve ser um Hash
account_configuration[booking_account_id]
requerido
Conta Contábil do Plano Contábil

Validação

  • Deve ser um Integer
account_configuration[ecd_account_id]
opcional
Conta Contábil do Plano Contábil ECD

Validação

  • Deve ser um Integer
account_configuration[ecf_account_id]
opcional
Conta Contábil do Plano Contábil ECF

Validação

  • Deve ser um Integer

DELETE /api/jp/:juridical_person_id/booking_plans/:booking_plan_id/sped/account_configurations/:id
Exclui uma Configuração de Conta

Exemplos

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

GET /api/sped/booking_plans/:booking_plan_id/booking_accounts
Lista as Contas Contábeis do Plano de Contas SPED

Exemplos

Response:

{
    "links": [
        {
            "rel": "next_page",
            "method": "get",
            "href": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts?page=2"
        },
        {
            "rel": "previous_page",
            "method": "get",
            "href": null
        },
        {
            "rel": "self",
            "method": "get",
            "link": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts"
        }
    ],
    "booking_accounts": [
        {
            "booking_account": {
                "id": 3137,
                "name": "ATIVO",
                "number": "1",
                "full_number": "1",
                "small_id": null,
                "nature": 1,
                "origin": 2,
                "links": [
                    {
                        "rel": "self",
                        "method": "get",
                        "link": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts/3137"
                    }
                ]
            }
        },
        {
            "booking_account": {
                "id": 3138,
                "name": "CIRCULANTE",
                "number": "01",
                "full_number": "1.01",
                "small_id": null,
                "nature": 1,
                "origin": 2,
                "links": [
                    {
                        "rel": "self",
                        "method": "get",
                        "link": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts/3138"
                    }
                ]
            }
        },
        {
            "booking_account": {
                "id": 3139,
                "name": "DISPONIBILIDADES",
                "number": "01",
                "full_number": "1.01.01",
                "small_id": null,
                "nature": 1,
                "origin": 2,
                "links": [
                    {
                        "rel": "self",
                        "method": "get",
                        "link": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts/3139"
                    }
                ]
            }
        },
        {
            "booking_account": {
                "id": 3140,
                "name": "DISPONIBILIDADES",
                "number": "01",
                "full_number": "1.01.01.01",
                "small_id": null,
                "nature": 1,
                "origin": 2,
                "links": [
                    {
                        "rel": "self",
                        "method": "get",
                        "link": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts/3140"
                    }
                ]
            }
        },
        {
            "booking_account": {
                "id": 3141,
                "name": "Caixa",
                "number": "00",
                "full_number": "1.01.01.01.00",
                "small_id": null,
                "nature": 1,
                "origin": 2,
                "links": [
                    {
                        "rel": "self",
                        "method": "get",
                        "link": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts/3141"
                    }
                ]
            }
        }
    ]
}

Parâmetros

Nome parâmetro Descrição
page
opcional
translation missing: pt-BR.api.doc.Página

Validação

  • Deve ser um Integer

GET /api/sped/booking_plans/:booking_plan_id/booking_account/:id
Lista as Contas Contábeis do Plano de Contas

Exemplos

Response:

{
    "booking_account": {
        "id": 3141,
        "name": "Caixa",
        "number": "00",
        "full_number": "1.01.01.01.00",
        "small_id": null,
        "nature": 1,
        "origin": 2,
        "links": [
            {
                "rel": "self",
                "method": "get",
                "link": "https://app.contabilone.com.br/api/sped/booking_plans/2/booking_accounts/3141"
            }
        ]
    }
}

GET /api/sped/booking_plans
Lista os Planos de Contas SPED

Exemplos

Response:

{
    "links": [
        {
            "rel": "self",
            "method": "get",
            "href": "https://app.contabilone.com.br/api/sped/booking_plans"
        }
    ],
    "sped_booking_plans": [
        {
            "sped_booking_plan": {
                "id": 2,
                "name": "Plano de Contas ECD",
                "uniq_name": "ecd_booking_plan",
                "version": "1",
                "mask": "X.XX.XX.XX.XX.XX.XX",
                "sped_type": 1,
                "starting_date": "2017-12-13",
                "ending_date": null,
                "created_at": "2017-12-13T17:48:47.783-02:00",
                "updated_at": "2017-12-13T17:48:47.783-02:00",
                "links": [
                    {
                        "rel": "self",
                        "method": "get",
                        "link": "https://app.contabilone.com.br/api/sped/booking_plans/2"
                    }
                ]
            }
        }
    ]
}

GET /api/sped/booking_plans/:id
Busca um determinado Plano de Contas SPED

Exemplos

Response:

{
    "booking_plan": {
        "id": 2,
        "name": "Plano de Contas ECD",
        "uniq_name": "ecd_booking_plan",
        "version": "1",
        "mask": "X.XX.XX.XX.XX.XX.XX",
        "sped_type": 1,
        "starting_date": "2017-12-13",
        "ending_date": null,
        "created_at": "2017-12-13T17:48:47.783-02:00",
        "updated_at": "2017-12-13T17:48:47.783-02:00",
        "links": [
            {
                "rel": "self",
                "method": "get",
                "link": "https://app.contabilone.com.br/api/sped/booking_plans/2"
            }
        ]
    }
}

GET /api/jp/:juridical_person_id/sped/bookkeepings/:bookkeeping_id/bookkeeping_files/:id
Exibe um do arquivo do SPED

Exemplos

=====Exemplo de requisição
curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json"   -d '{"sped_bookkeeping_file": {"hash_value": "B12C14567"}}'   https://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1.json
Response:
"bookkeeping_file": {
  "hash_value": "C6716",
  "downloads_count": 1,
  "links": [
    {
      "rel": "download",
      "method": "get",
      "href": "http://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1/download"
    },
    {
      "rel": "update",
      "method": "patch",
      "href": "http://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1"
    },
    {
      "rel": "destroy",
      "method": "delete",
      "href": "http://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1"
    }
  ]
}

Parâmetros

Nome parâmetro Descrição
sped_bookkeeping_file
requerido

Validação

  • Deve ser um Hash
sped_bookkeeping_file[hash_value]
opcional
Valor da HASH do arquivo do Livro Contábil

Validação

  • Deve ser um String

PUT /api/jp/:juridical_person_id/sped/bookkeepings/:bookkeeping_id/bookkeeping_files/:id
Atualiza a HASH do arquivo do SPED

Exemplos

=====Exemplo de requisição
curl --basic -u "[token]" -X GET -H "Accept: application/json" -H "Content-type: application/json"   -d '{"sped_bookkeeping_file": { hash_value: "NEW_HASH" }}'
https://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1.json
Response:
"bookkeeping_file": {
  "hash_value": "NEW_HASH",
  "downloads_count": 1,
  "links": [
    {
      "rel": "download",
      "method": "get",
      "href": "http://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1/download"
    },
    {
      "rel": "update",
      "method": "patch",
      "href": "http://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1"
    },
    {
      "rel": "destroy",
      "method": "delete",
      "href": "http://app.contabilone.com.br/api/jp/1/sped/bookkeepings/1/bookkeeping_files/1"
    }
  ]
}

Parâmetros

Nome parâmetro Descrição
sped_bookkeeping_file
requerido

Validação

  • Deve ser um Hash
sped_bookkeeping_file[hash_value]
opcional
Valor da HASH do arquivo do Livro Contábil

Validação

  • Deve ser um String

DELETE /api/jp/:juridical_person_id/sped/bookkeepings/:bookkeeping_id/bookkeeping_files/:id
Excluir um arquivo do SPED

Exemplos

Exclui um arquivo do SPED especificado (via id) com resposta 204 Ok.
Response:
  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/sped/bookkeepings/:bookkeeping_id/bookkeeping_files/:id/download
Baixa um arquivo do SPED

Exemplos

Baixa um arquivo do SPED especificado (via id) com resposta Redirect.
Response:
  HTTP/1.1 302 OK
  Content-Type: application/json; charset=utf-8
  Location: https://cdn-contabilone-development.s3.amazonaws.com/sped/bookkeeping_files/files/000/000/001/original/ecd_example.txt?...
  Date: Wed, 26 Jan 2011 12:56:01 GMT

GET /api/jp/:juridical_person_id/sped/bookkeepings
Lista os arquivos do Livro Contábil do SPED de uma Pessoa Jurídica

Exemplos

Response:

[
 {
  "bookkeeping" => {
                "created_at" => "2018-01-05T19:09:26.375-02:00",
           "delivery_status" => 0,
               "finished_at" => nil,
                        "id" => 67,

    "sped_bookkeeping_files" => [
      {
        "sped_bookkeeping_file" => {
          "downloads_count" => 1,
               "hash_value" => "C6716",
                    "links" => [
            {
                "href" => "http://app.contabilone/api/jp/116/sped/bookkeepings/67/bookkeeping_files/51/download",
              "method" => "get",
                 "rel" => "download"
            },
            {
                "href" => "http://app.contabilone/api/jp/116/sped/bookkeepings/67/bookkeeping_files/51",
              "method" => "patch",
                 "rel" => "update"
            },
            {
                "href" => "http://app.contabilone/api/jp/116/sped/bookkeepings/67/bookkeeping_files/51",
              "method" => "delete",
                 "rel" => "destroy"
            }
          ]
        }
      }
    ],
    "sped_type" => 1
    }
  }
]

GET /api/jp/:juridical_person_id/sped/bookkeepings/:id
Lista de SPED's


POST /api/jp/:juridical_person_id/sped/ecd/bookkeepings.json
Cria SPED Contábil (ECD)

Parâmetros

Nome parâmetro Descrição
sped_ecd_options
requerido

Validação

  • Deve ser um Hash
sped_ecd_options[start_date]
requerido
Data inicial do intervalo

Validação

  • Deve ser um Date
sped_ecd_options[end_date]
requerido
Data final do intervalo

Validação

  • Deve ser um Date
sped_ecd_options[reference_number]
requerido
Número de Ordem

Validação

  • Deve ser um Integer
sped_ecd_options[accounting_period_init_situation]
requerido
Situação inicial do período

Validação

  • Deve ser um dos valores: 0, 1, 2, 3.
sped_ecd_options[exceptional_situation]
opcional
Situação Especial

Validação

  • Deve ser um dos valores: 1, 2, 3, 4, 5.
sped_ecd_options[purpose]
opcional
Finalidade

Validação

  • Deve ser um dos valores: 0, 1.
sped_ecd_options[substituted_hash_value]
opcional
HASH Substituta

Validação

  • Deve ser um String
sped_ecd_options[nire]
opcional
Número de Identificação do Registro de Empresas (NIRE)

Validação

  • Deve ser um String
sped_ecd_options[substituted_doc]
opcional
Documento da Substituta

Validação

  • Deve ser um File
sped_ecd_options[independent_audit]
opcional
Entidade Sujeita à Auditoria Independente

Validação

  • Deve ser um dos valores: true, false.
sped_ecd_options[auditor_name]
opcional
Nome do Auditor

Validação

  • Deve ser um String
sped_ecd_options[register_cvm_number]
opcional
Número de Registro na CVM

Validação

  • Deve ser um String
sped_ecd_options[decentralized_accounting]
opcional
Contabilidade Descentralizada

Validação

  • Deve ser um dos valores: true, false.
sped_ecd_options[accountable_institutions_attributes]
opcional
Instituições responsáveis

Validação

  • Deve ser um Hash
sped_ecd_options[accountable_institutions_attributes][register_institution_code]
opcional
Instituição Responsável (Código)

Validação

  • Deve ser um String
sped_ecd_options[accountable_institutions_attributes][register_code]
opcional
Código de Inscricão na Instituição Responsável

Validação

  • Deve ser um String
sped_ecd_options[register_j800_docs_attributes]
opcional
Documentos de Registro J800

Validação

  • Deve ser um Hash
sped_ecd_options[register_j800_docs_attributes][doc]
opcional
Documento

Validação

  • Deve ser um File
sped_ecd_options[register_j800_docs_attributes][doc_type]
opcional
Tipo do Documento

Validação

  • Deve ser um dos valores: 001, 002, 003, 010, 011, 012, 099.
sped_ecd_options[signers_attributes]
opcional
Assinantes

Validação

  • Deve ser um Hash
sped_ecd_options[signers_attributes][sponsor_id]
opcional
ID do Responsável Legal

Validação

  • Deve ser um Integer
sped_ecd_options[signers_attributes][qualification_code]
opcional
Código da Qualificação

Validação

  • Deve ser um String
sped_ecd_options[signers_attributes][responsible_for_signing]
opcional
Responsável pela Assinatura

Validação

  • Deve ser um dos valores: true, false.
sped_ecd_options[certificate_reference_number]
opcional
Número sequencial do Certificado

Validação

  • Deve ser um String
sped_ecd_options[certificate_vigor]
opcional
Data de validade do Certificado

Validação

  • Deve ser um Date