Consultar

Requisição

GET [Url Ambiente]/contas/

Header

Identificador	Valor
Accept	application/json
X-Api-Key	Token de acesso à API
x-idtokenoper	Token do contrato

Query

Parâmetro	Descrição	Tipo	Exemplos
idempresa	(Obrigatório) Código da empresa	Integer	123

Exemplo

curl -X GET --header 'Accept: application/json' --header 'X-Api-Key: e26f1ae9-d729-4fa9-bdd9-d2cbdcb5fa94' --header 'x-idtokenoper: 0c3a7999-06c9-4680-8a8a-aeb57965c468' 'https://sistemacontas.com.br/contas/api/v1/contas?idempresa=123'

Resposta

Status Code 200

Retorno de sucesso.

Em caso de sucesso é retornada uma lista de objetos de contas. Seguem campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
idconta	Código da conta	Integer	3285
sigla	Sigla da conta	String	"1.001.997"
descricao	Descrição da conta	String	"CX Tributos retido terceiros"
idnatfinanceira	Natureza financeira da conta (ver tabela abaixo)	Integer	1
ordempreferencia	Utilizado na ordenação	Integer	1
compoesaldo	Indica se a conta compõe saldo por padrão	Boolean	true
dataencerradadigitacao	Data de encerramento para digitação (aaaa-mm-dd)	String	"2018-12-31"
aceitaclonarmovto	Indica se permite clonagem de transações	Boolean	true
defaultcontabil	Indica se as transações desta conta são contábeis, por padrão	Boolean	true
ativo	Indica se a conta está ativa	Boolean	true
grau	Grau da conta. "A" = Analítica, "S" = Sintética	String	"A"
codigo_banco	Código da instituição bancária	String
agencia	Agência da conta	String
tipo_conta	Tipo da conta	String
numero_conta	Número da conta	String
operacao	Operação da conta	String
limite_credito	Limite de crédito	Numeric	"0.00"

[
    {
        "idconta": 3285,
        "sigla": "1.001.997",
        "descricao": "CX Tributos retido terceiros",
        "idnatfinanceira": 1,
        "ordempreferencia": 1,
        "compoesaldo": true,
        "dataencerradadigitacao": "2018-12-31",
        "aceitaclonarmovto": true,
        "defaultcontabil": true,
        "ativo": true,
        "grau": "A",
        "codigo_banco": null,
        "agencia": null,
        "tipo_conta": null,
        "numero_conta": null,
        "operacao": null,
        "limite_credito": "0.00"
    },
    ...
]

Códigos de naturezas financeiras

Código	Descrição
1	Caixa
2	Banco
3	Contas a pagar
4	Contas a receber
5	Cartão de crédito a receber
6	Cartão compra corporativo
8	Gestão orçamentária
10	Investimentos
12	Empréstimo a pagar
13	Empréstimo a receber