Consulta individual

Requisição

GET [Url Ambiente]/transacoes/{id}

Header

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

Path

Parâmetro	Descrição	Tipo	Exemplos
id	(Obrigatório) Código da transação	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/transacoes/123'

Resposta

Status Code 200

Retorno de sucesso.

Em caso de sucesso é retornada um objeto de transação financeira. Seguem campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
idtransfinanceira	Código da transação financeira	Integer	2132704
frequencia	Frequência da transação financeira	String	"ÚNICO"
empresa	Empresa da transação	String	"Modelo"
conta_sigla	Sigla da conta	String	"ADM Financeiro"
conta_descricao	Descrição da conta	String
clifor_nome	Nome do cliente/fornecedor	String
clifor_nome_completo	Nome completo do cliente/fornecedor	String
negocio_sigla	Sigla do negócio	String
negocio_descricao	Descrição do negócio	String
negocio_grupo	Grupo do negócio	String
categoria_sigla	Sigla da categoria	String
categoria_descricao	Descrição da categoria	String
data_referencia	Data de referência (aaaa-mm-dd)	String
documento_referencia	Documento de referência	String
data_vencimento	Data de vencimento (aaaa-mm-dd)	String
documento_vencimento	Documento de vencimento	String
data_compensacao	Data de compensação (aaaa-mm-dd)	String
documento_bancario	Documento bancário	String
valor	Valor da transação (caso positivo: CRÉDITO/ENTRADA, caso negativo: DÉBITO/SAÍDA)	Numeric
historico	Histórico	String
juros	Juros diário (caso positivo: CRÉDITO/ENTRADA, caso negativo: DÉBITO/SAÍDA)	Numeric
multa	Multa por atraso (caso positivo: CRÉDITO/ENTRADA, caso negativo: DÉBITO/SAÍDA)	Numeric
usuario_criacao	Usuário criador da transação	String
data_criacao	Data de criação	String
usuario_ultima_alteracao	Usuário da última atualização	String
data_ultima_alteracao	Data da última alteração	String
provisao	Indica se a transação é uma provisão	Boolean
valor_original	Valor original (caso positivo: CRÉDITO/ENTRADA, caso negativo: DÉBITO/SAÍDA)	Numeric
data_vencimento_original	Data de vencimento original (aaaa-mm-dd)	String
status_labels	Lista de status da transação	Array
status_labels[i].cor	Cor do status	String
status_labels[i].label	Descrição do status	String
anexos	Lista de anexos da transação	Array
anexos[i].id	Código do anexo	String
anexos[i].nome	Nome do arquivo	String
anexos[i].mime_type	Tipo mime do arquivo	String	"image/png"
anexos[i].thumbnail	Miniatura do arquivo	String
anexos[i].url	URL do arquivo	String

{
    "idtransfinanceira": 2132704,
    "frequencia": "MENSAL",
    "empresa": "Modelo",
    "conta_sigla": "4.001.02",
    "conta_descricao": "CR Vendas XPTO",
    "clifor_nome": "AÇO ALUMINIO",
    "clifor_nome_completo": "AÇO ALUMINIO  COMERCIO LTDA",
    "negocio_sigla": "1.01.01",
    "negocio_descricao": "ADM Financeiro",
    "negocio_grupo": "ADM",
    "categoria_sigla": "1.01.001",
    "categoria_descricao": "Venda produto - dinheiro",
    "data_referencia": "2021-10-11",
    "documento_referencia": "TST 1110/1",
    "data_vencimento": "2021-10-12",
    "documento_vencimento": "TST 1110",
    "data_compensacao": null,
    "documento_bancario": "",
    "valor": "50.00",
    "historico": "Recebimento de venda realizada nesta data",
    "juros": "0.00",
    "multa": "0.00",
    "usuario_criacao": "Fulano",
    "data_criacao": "2021-10-11 09:12:58",
    "usuario_ultima_alteracao": "Fulano",
    "data_ultima_alteracao": "2021-10-11 09:12:58",
    "provisao": true,
    "valor_original": "50.00",
    "data_vencimento_original": "2021-10-12",
    "status_labels": [
        {
            "cor": "#1AB394",
            "label": "Ocorrência mensal"
        }
    ],
    "anexos": [
        {
            "id": "1f683b87-87ee-3c45-7aa4-cb5c2aa9b0ab",
            "nome": "syspublicidade-editar-lanc-na-conciliação.png",
            "mime_type": "image/png",
            "thumbnail": "https://sistemacontas.com.br/contas/api/v1/transacoes/anexo-thumbnail?id=1f683b87-87ee-3c45-7aa4-cb5c2aa9b0ab&size=large&idtokenoper=1df00a45-ed97-4769-8f71-579a559f7e2e",
            "url": "https://sistemacontas.com.br/contas/api/v1/transacoes/anexo?id=1f683b87-87ee-3c45-7aa4-cb5c2aa9b0ab&idtokenoper=1df00a45-ed97-4769-8f71-579a559f7e2e"
        }
    ]
}