⚪Contas a Receber
https://host/webservice/v1/fn_areceber
🟢Listar
{
"qtype" : "fn_areceber.id",
"query" : "1",
"oper" : ">=",
"page" : "1",
"rp" : "2000",
"sortname" : "fn_areceber.id",
"sortorder" : "asc",
}curl --location --request GET 'https://host/webservice/v1/fn_areceber' \
--header 'ixcsoft: listar' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--header 'Cookie: IXC_Session=ovbcep20qrjqu43qhmthic8ms9' \
--data '{
"qtype" : "fn_areceber.id",
"query" : "1",
"oper" : ">=",
"page" : "1",
"rp" : "2000",
"sortname" : "fn_areceber.id",
"sortorder" : "asc",
}'🟠Inserir
{
"id_cliente":"",
"id_conta":"",
"filial_id":"",
"data_emissao":"",
"data_vencimento":"",
"valor":"",
"previsao":"",
"tipo_recebimento":""
//o campo abaixo é obrigatório para o tipo recebimento "Boleto"
"id_carteira_cobranca":""
}{
"id_remessa": "",
"gateway_link": "",
"nn_boleto": "",
"boleto": "",
"data_inicial": "DD/MM/AAAA",
"data_final": "DD/MM/AAAA",
"liberado": "",
"filial_id": "",
"status": "",
"data_emissao": "DD/MM/AAAA",
"data_vencimento": "DD/MM/AAAA",
"valor": "",
"obs": "",
"valor_recebido": "",
"valor_aberto": "",
"id_cliente": "",
"pagamento_valor": "",
"pagamento_data": "DD/MM/AAAA",//nao deve ser alterado, quando o boleto estiver com status"R"
"id_carteira_cobranca": "",
"credito_data": "DD/MM/AAAA",
"baixa_data": "DD/MM/AAAA hh:mm:ss",
"numero_parcela_recorrente": "",
"documento": "",
"id_saida": "",
"tipo_recebimento": "",
"tipo_renegociacao": "",
"valor_cancelado": "",
"data_cancelamento": "",
"id_mot_cancelamento": "",
"id_renegociacao": "",
"id_cobranca": "",
"previsao": "",
"id_renegociacao_novo": "",
"libera_periodo": "",
"impresso": "",
"forma_recebimento": "",
"arquivo_remessa_baixado": "",
"nparcela": "",
"id_nota_gerada_opc4": "",
"status_cobranca": "",
"tipo_cobranca": "",
"id_contrato_principal": "",
"id_contrato_avulso": "",
"id_contrato": "",
"id_nota_gerada": "",
"id_im_imovel": "",
"parcela_proporcional": "",
"linha_digitavel": "",//cod de barras do boleto
"duplicata": "",
"tipo_pagamento_cartao": "",
"id_sip": "",
"titulo_protestado": "",
"desconto_condicional_valor": "",
"gerencianet_token": "",
"validade_desconto_condicional": "",
"id_conta": "",
"motivo_alteracao": "",
"id_remessa_alteracao": "",
"cancelamento_id_operador": "",
"baixa_id_operador": "",
"titulo_importado": "",
"origem_importacao": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"aguardando_confirmacao_pagamento": "",
"parcelado_cartao": "",
"pix_txid": "",
"id_nota_gerada_opc2": "",
"id_nota_gerada_opc3": "",
"recebido_via_pix": "",
"id_lote_geracao_financeiro_fatura": ""
}curl --location 'https://host/webservice/v1/fn_areceber' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--data '{
"id_remessa": "",
"gateway_link": "",
"nn_boleto": "",
"boleto": "",
"data_inicial": "DD/MM/AAAA",
"data_final": "DD/MM/AAAA",
"liberado": "",
"filial_id": "",
"status": "",
"data_emissao": "DD/MM/AAAA",
"data_vencimento": "DD/MM/AAAA",
"valor": "",
"obs": "",
"valor_recebido": "",
"valor_aberto": "",
"id_cliente": "",
"pagamento_valor": "",
"pagamento_data": "DD/MM/AAAA",//nao deve ser alterado, quando o boleto estiver com status"R"
"id_carteira_cobranca": "",
"credito_data": "DD/MM/AAAA",
"baixa_data": "DD/MM/AAAA hh:mm:ss",
"numero_parcela_recorrente": "",
"documento": "",
"id_saida": "",
"tipo_recebimento": "",
"tipo_renegociacao": "",
"valor_cancelado": "",
"data_cancelamento": "",
"id_mot_cancelamento": "",
"id_renegociacao": "",
"id_cobranca": "",
"previsao": "",
"id_renegociacao_novo": "",
"libera_periodo": "",
"impresso": "",
"forma_recebimento": "",
"arquivo_remessa_baixado": "",
"nparcela": "",
"id_nota_gerada_opc4": "",
"status_cobranca": "",
"tipo_cobranca": "",
"id_contrato_principal": "",
"id_contrato_avulso": "",
"id_contrato": "",
"id_nota_gerada": "",
"id_im_imovel": "",
"parcela_proporcional": "",
"linha_digitavel": "",//cod de barras do boleto
"duplicata": "",
"tipo_pagamento_cartao": "",
"id_sip": "",
"titulo_protestado": "",
"desconto_condicional_valor": "",
"gerencianet_token": "",
"validade_desconto_condicional": "",
"id_conta": "",
"motivo_alteracao": "",
"id_remessa_alteracao": "",
"cancelamento_id_operador": "",
"baixa_id_operador": "",
"titulo_importado": "",
"origem_importacao": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"aguardando_confirmacao_pagamento": "",
"parcelado_cartao": "",
"pix_txid": "",
"id_nota_gerada_opc2": "",
"id_nota_gerada_opc3": "",
"recebido_via_pix": "",
"id_lote_geracao_financeiro_fatura": ""
}'{
//Regime contabil
"previsao":"N",//Competência(Previsão NÃO)
"previsao":"S",//Caixa(Previsão SIM)
"previsao":"M",//Manual
//Tipo de recebimento
"tipo_recebimento":"Boleto",//Boleto
"tipo_recebimento":"Cheque",//Cheque
"tipo_recebimento":"Cartão",//Cartão de crédito
"tipo_recebimento":"Dinheiro",//Dinheiro
"tipo_recebimento":"Depósito",//Depósito
"tipo_recebimento":"Gateway",//Gateway
"tipo_recebimento":"Débito",//Débito em conta
"tipo_recebimento":"Fatura",//Fatura
"tipo_recebimento":"ArrecadacaoRecebimento",//Arrecadação/Recebimento
"tipo_recebimento":"Transferencia",//Transferência
"tipo_recebimento":"Pix",//Pix
//Status
"status":"A",//A receber
"status":"R",//Recebido
"status":"P",//Parcial
"status":"C",//Cancelado
//Impresso
"impresso":"S",//Sim
"impresso":"N",//Nao
//Remessa baixada (download)
"arquivo_remessa_baixado":"S",//Sim
"arquivo_remessa_baixado":"N",//Nao
//Forma de recebimento
"forma_recebimento":"M",//Recebido de forma manual
"forma_recebimento":"R",//Recebido automaticamente
//Tipo envio cobranca
"tipo_cobranca":"P",//Padrão
"tipo_cobranca":"I",//Impresso
"tipo_cobranca":"E",//E-mail
//Titulo protestado
"titulo_protestado":"S",//Sim
"titulo_protestado":"N",//Nao
//Titulo importado
"titulo_importado":"S",//Sim
"titulo_importado":"N",//Nao
//Aguardando confirmacao de pagamento
"aguardando_confirmacao_pagamento":"S",//Sim
"aguardando_confirmacao_pagamento":"N",//Nao
//Parcelado cartao
"parcelado_cartao":"S",//Sim
"parcelado_cartao":"N",//Nao
//Recebido via pix
"recebido_via_pix":"S",//Sim
"recebido_via_pix":"N",//Nao
//Motivo de alteracao
"motivo_alteracao":"08", // Cancelamento de Desconto
"motivo_alteracao":"15", // Dispensar Cobrança de Multa
"motivo_alteracao":"16", // Alteração do Valor de Desconto
"motivo_alteracao":"17", // Não conceder Desconto
"motivo_alteracao":"03", // Protesto para Fins Falimentares
"motivo_alteracao":"04", // Concessão de Abatimento
"motivo_alteracao":"05", // Cancelamento de Abatimento
"motivo_alteracao":"06", // Alteração de Vencimento
"motivo_alteracao":"07", // Concessão de Desconto
"motivo_alteracao":"09", // Protestar
"motivo_alteracao":"10", // Sustar Protesto e Baixar Título
"motivo_alteracao":"11", // Sustar Protesto e Manter em Carteira
"motivo_alteracao":"12", // Alteração de Juros de Mora
"motivo_alteracao":"13", // Dispensar Cobrança de Juros de Mora
"motivo_alteracao":"14", // Alteração de Valor/Percentual de Multa
"motivo_alteracao":"18", // Alteração do Valor de Abatimento
"motivo_alteracao":"19", // Prazo Limite de Recebimento ? Alterar
"motivo_alteracao":"20", // Prazo Limite de Recebimento ? Dispensar
"motivo_alteracao":"21", // Alterar número do título dado pelo beneficiario
"motivo_alteracao":"22", // Alterar número do título dado pelo beneficiario
"motivo_alteracao":"23", // Alterar dados do Pagador
"motivo_alteracao":"24", // Alterar dados do Sacador/Avalista
"motivo_alteracao":"30", // Recusa da Alegação do Pagador
"motivo_alteracao":"31", // Alteração de Outros Dados
"motivo_alteracao":"33", // Alteração dos Dados do Rateio de Crédito
"motivo_alteracao":"34", // Pedido de Cancelamento dos Dados do Rateio de Crédito
"motivo_alteracao":"35", // Pedido de Desagendamento do Débito Automático
"motivo_alteracao":"40", // Alteração de Carteira
"motivo_alteracao":"41", // Cancelar protesto
"motivo_alteracao":"42", // Alteração de Espécie de Título
"motivo_alteracao":"43", // Transferência de carteira/modalidade de cobrança
"motivo_alteracao":"44", // Alteração de contrato de cobrança
"motivo_alteracao":"45", // Negativação Sem Protesto
"motivo_alteracao":"46", // Solicitação de Baixa de Título Negativado Sem Protesto
"motivo_alteracao":"49" // Alteração de dados extras multa
//Isentar periodo (libera periodo)
"libera_periodo":"S",//Sim
"libera_periodo":"N",//Nao
}🔵Editar
Deve ser informado o id, a ser editado, na URL: https://host/webservice/v1/fn_areceber/5
Todos os campos devem ser inseridos para realizar uma alteração cadastral.
{
"id_remessa": "",
"gateway_link": "",
"nn_boleto": "",
"boleto": "",
"data_inicial": "DD/MM/AAAA",
"data_final": "DD/MM/AAAA",
"liberado": "",
"filial_id": "",
"status": "",
"data_emissao": "DD/MM/AAAA",
"data_vencimento": "DD/MM/AAAA",
"valor": "",
"obs": "",
"valor_recebido": "",
"valor_aberto": "",
"id_cliente": "",
"pagamento_valor": "",
"pagamento_data": "DD/MM/AAAA",//nao deve ser alterado, quando o boleto estiver com status"R"
"id_carteira_cobranca": "",
"credito_data": "DD/MM/AAAA",
"baixa_data": "DD/MM/AAAA hh:mm:ss",
"numero_parcela_recorrente": "",
"documento": "",
"id_saida": "",
"tipo_recebimento": "",
"tipo_renegociacao": "",
"valor_cancelado": "",
"data_cancelamento": "",
"id_mot_cancelamento": "",
"id_renegociacao": "",
"id_cobranca": "",
"previsao": "",
"id_renegociacao_novo": "",
"libera_periodo": "",
"impresso": "",
"forma_recebimento": "",
"arquivo_remessa_baixado": "",
"nparcela": "",
"id_nota_gerada_opc4": "",
"status_cobranca": "",
"tipo_cobranca": "",
"id_contrato_principal": "",
"id_contrato_avulso": "",
"id_contrato": "",
"id_nota_gerada": "",
"id_im_imovel": "",
"parcela_proporcional": "",
"linha_digitavel": "",//cod de barras do boleto
"duplicata": "",
"tipo_pagamento_cartao": "",
"id_sip": "",
"titulo_protestado": "",
"desconto_condicional_valor": "",
"gerencianet_token": "",
"validade_desconto_condicional": "",
"id_conta": "",
"motivo_alteracao": "",
"id_remessa_alteracao": "",
"cancelamento_id_operador": "",
"baixa_id_operador": "",
"titulo_importado": "",
"origem_importacao": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"aguardando_confirmacao_pagamento": "",
"parcelado_cartao": "",
"pix_txid": "",
"id_nota_gerada_opc2": "",
"id_nota_gerada_opc3": "",
"recebido_via_pix": "",
"id_lote_geracao_financeiro_fatura": ""
}curl --location --request PUT 'https://host/webservice/v1/fn_areceber/5' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--header 'Cookie: IXC_Session=ovbcep20qrjqu43qhmthic8ms9' \
--data '{
"id_remessa": "",
"gateway_link": "",
"nn_boleto": "",
"boleto": "",
"data_inicial": "DD/MM/AAAA",
"data_final": "DD/MM/AAAA",
"liberado": "",
"filial_id": "",
"status": "",
"data_emissao": "DD/MM/AAAA",
"data_vencimento": "DD/MM/AAAA",
"valor": "",
"obs": "",
"valor_recebido": "",
"valor_aberto": "",
"id_cliente": "",
"pagamento_valor": "",
"pagamento_data": "DD/MM/AAAA",//nao deve ser alterado, quando o boleto estiver com status"R"
"id_carteira_cobranca": "",
"credito_data": "DD/MM/AAAA",
"baixa_data": "DD/MM/AAAA hh:mm:ss",
"numero_parcela_recorrente": "",
"documento": "",
"id_saida": "",
"tipo_recebimento": "",
"tipo_renegociacao": "",
"valor_cancelado": "",
"data_cancelamento": "",
"id_mot_cancelamento": "",
"id_renegociacao": "",
"id_cobranca": "",
"previsao": "",
"id_renegociacao_novo": "",
"libera_periodo": "",
"impresso": "",
"forma_recebimento": "",
"arquivo_remessa_baixado": "",
"nparcela": "",
"id_nota_gerada_opc4": "",
"status_cobranca": "",
"tipo_cobranca": "",
"id_contrato_principal": "",
"id_contrato_avulso": "",
"id_contrato": "",
"id_nota_gerada": "",
"id_im_imovel": "",
"parcela_proporcional": "",
"linha_digitavel": "",//cod de barras do boleto
"duplicata": "",
"tipo_pagamento_cartao": "",
"id_sip": "",
"titulo_protestado": "",
"desconto_condicional_valor": "",
"gerencianet_token": "",
"validade_desconto_condicional": "",
"id_conta": "",
"motivo_alteracao": "",
"id_remessa_alteracao": "",
"cancelamento_id_operador": "",
"baixa_id_operador": "",
"titulo_importado": "",
"origem_importacao": "",
"ultima_atualizacao": "DD/MM/AAAA hh:mm:ss",
"aguardando_confirmacao_pagamento": "",
"parcelado_cartao": "",
"pix_txid": "",
"id_nota_gerada_opc2": "",
"id_nota_gerada_opc3": "",
"recebido_via_pix": "",
"id_lote_geracao_financeiro_fatura": ""
}'{
//Regime contabil
"previsao":"N",//Competência(Previsão NÃO)
"previsao":"S",//Caixa(Previsão SIM)
"previsao":"M",//Manual
//Tipo de recebimento
"tipo_recebimento":"Boleto",//Boleto
"tipo_recebimento":"Cheque",//Cheque
"tipo_recebimento":"Cartão",//Cartão de crédito
"tipo_recebimento":"Dinheiro",//Dinheiro
"tipo_recebimento":"Depósito",//Depósito
"tipo_recebimento":"Gateway",//Gateway
"tipo_recebimento":"Débito",//Débito em conta
"tipo_recebimento":"Fatura",//Fatura
"tipo_recebimento":"ArrecadacaoRecebimento",//Arrecadação/Recebimento
"tipo_recebimento":"Transferencia",//Transferência
"tipo_recebimento":"Pix",//Pix
//Status
"status":"A",//A receber
"status":"R",//Recebido
"status":"P",//Parcial
"status":"C",//Cancelado
//Impresso
"impresso":"S",//Sim
"impresso":"N",//Nao
//Remessa baixada (download)
"arquivo_remessa_baixado":"S",//Sim
"arquivo_remessa_baixado":"N",//Nao
//Forma de recebimento
"forma_recebimento":"M",//Recebido de forma manual
"forma_recebimento":"R",//Recebido automaticamente
//Tipo envio cobranca
"tipo_cobranca":"P",//Padrão
"tipo_cobranca":"I",//Impresso
"tipo_cobranca":"E",//E-mail
//Titulo protestado
"titulo_protestado":"S",//Sim
"titulo_protestado":"N",//Nao
//Titulo importado
"titulo_importado":"S",//Sim
"titulo_importado":"N",//Nao
//Aguardando confirmacao de pagamento
"aguardando_confirmacao_pagamento":"S",//Sim
"aguardando_confirmacao_pagamento":"N",//Nao
//Parcelado cartao
"parcelado_cartao":"S",//Sim
"parcelado_cartao":"N",//Nao
//Recebido via pix
"recebido_via_pix":"S",//Sim
"recebido_via_pix":"N",//Nao
//Motivo de alteracao
"motivo_alteracao":"08", // Cancelamento de Desconto
"motivo_alteracao":"15", // Dispensar Cobrança de Multa
"motivo_alteracao":"16", // Alteração do Valor de Desconto
"motivo_alteracao":"17", // Não conceder Desconto
"motivo_alteracao":"03", // Protesto para Fins Falimentares
"motivo_alteracao":"04", // Concessão de Abatimento
"motivo_alteracao":"05", // Cancelamento de Abatimento
"motivo_alteracao":"06", // Alteração de Vencimento
"motivo_alteracao":"07", // Concessão de Desconto
"motivo_alteracao":"09", // Protestar
"motivo_alteracao":"10", // Sustar Protesto e Baixar Título
"motivo_alteracao":"11", // Sustar Protesto e Manter em Carteira
"motivo_alteracao":"12", // Alteração de Juros de Mora
"motivo_alteracao":"13", // Dispensar Cobrança de Juros de Mora
"motivo_alteracao":"14", // Alteração de Valor/Percentual de Multa
"motivo_alteracao":"18", // Alteração do Valor de Abatimento
"motivo_alteracao":"19", // Prazo Limite de Recebimento ? Alterar
"motivo_alteracao":"20", // Prazo Limite de Recebimento ? Dispensar
"motivo_alteracao":"21", // Alterar número do título dado pelo beneficiario
"motivo_alteracao":"22", // Alterar número do título dado pelo beneficiario
"motivo_alteracao":"23", // Alterar dados do Pagador
"motivo_alteracao":"24", // Alterar dados do Sacador/Avalista
"motivo_alteracao":"30", // Recusa da Alegação do Pagador
"motivo_alteracao":"31", // Alteração de Outros Dados
"motivo_alteracao":"33", // Alteração dos Dados do Rateio de Crédito
"motivo_alteracao":"34", // Pedido de Cancelamento dos Dados do Rateio de Crédito
"motivo_alteracao":"35", // Pedido de Desagendamento do Débito Automático
"motivo_alteracao":"40", // Alteração de Carteira
"motivo_alteracao":"41", // Cancelar protesto
"motivo_alteracao":"42", // Alteração de Espécie de Título
"motivo_alteracao":"43", // Transferência de carteira/modalidade de cobrança
"motivo_alteracao":"44", // Alteração de contrato de cobrança
"motivo_alteracao":"45", // Negativação Sem Protesto
"motivo_alteracao":"46", // Solicitação de Baixa de Título Negativado Sem Protesto
"motivo_alteracao":"49" // Alteração de dados extras multa
//Isentar periodo (libera periodo)
"libera_periodo":"S",//Sim
"libera_periodo":"N",//Nao
}🔴Deletar
Deve ser informado o id, a ser excluído, na URL: https://host/webservice/v1/fn_areceber/5
curl --location --request DELETE 'https://host/webservice/v1/fn_areceber/5' \
--header 'Authorization: Basic MzY3OmExNmMwZDVkZGM3ZjFiODViMzJmYzIyOThlMDM5MjgyNzg3NTkwMGQwNGNmMTNiMzY1Y2M2ZWMxMmViMTU3MzQ=' \
--header 'Cookie: IXC_Session=ovbcep20qrjqu43qhmthic8ms9' \
--data ''🔘Botões
Last updated