apiDocumentaçãoOperaçõesapiDocumentaçãoOperaçõesIncluirContaReceberaltera dadosInclui uma conta a Receber
| Operação | financas/contareceber:IncluirContaReceber |
|---|---|
| Serviço | LancamentoContaReceber |
| Módulo | Finanças |
| Endpoint | /api/v1/financas/contareceber/ |
incluir conta a receber
| Campo | Tipo | Descrição |
|---|---|---|
acao | string | A-Adiciona Valor / S-Subtrai valor / L-Lança valor. |
aprendizado_rateio | string | Aprendizado de rateio de departamento. Preencher com "S" ou "N". Default "N" Quando essa tag for preenchida com "S" será assumido o rateio de departamento para a categoria informada na tag "codigo_categoria". Essa tag é utilizada apenas nos métodos de inclusão e alteração. |
baixar_documento | string | Efetua a baixa automática do documento. |
bloqueado | string | Bloquear lançamento (S/N) |
bloquear_baixa | string | bloquear a baixa do lançamento |
bloquear_exclusao | string | Bloqueia a exclusão do registro. (S/N) |
boleto | object | Informações do boleto. |
cNumeroContrato | string | Número do contrato do cliente. Preenchimento Opcional. |
cPedidoCliente | string | Número do pedido do cliente. Preenchimento Opcional. |
categorias | lista de object | |
chave_nfe | string | Chave de Acesso da NFE |
codigo_barras_ficha_compensacao | string | Código de Barras da Ficha de Compensação |
codigo_categoria | string | Código da Categoria |
codigo_cliente_fornecedor | integer | Código de Cliente / Fornecedor |
codigo_cliente_fornecedor_integracao | string | Código do cliente informado pelo integrador. |
codigo_cmc7_cheque | string | Código CMC7 do Cheque |
codigo_lancamento_integracao | string | Código do lançamento gerado pelo integrador. |
codigo_lancamento_omie | integer | Chave do Lançamento |
codigo_projeto | integer | Código do Projeto |
codigo_tipo_documento | string | Código para o Tipo de Documento |
codigo_vendedor | integer | Código do Vendedor |
conciliar_documento | string | Efetua a conciliação do documento automaticamente. |
data_emissao | string | Data de Emissão |
data_previsao | string | Data de Previsão de Pagamento/Recebimento |
data_registro | string | Data de Registro |
data_vencimento | string | Data de Vencimento |
distribuicao | lista de object | Distribuição por Departamentos |
id_conta_corrente | integer | Id da Conta Corrente |
id_origem | string | Código da Origem. Preenchimento automático - Não informar. Informação localizada na Aba "Diversos" do Contas a Receber. Os valores disponíveis são: "APIR" - Integração de Conta a Receber "BARR" - Conta a Receber Importada por Código de Barras "CTER" - Parcela a Receber de um CT-e "DEVR" - Conta a Receber da Devolução ao Fornecedor "MANR" - Lançamento Manual de Conta a Receber "NFER" - Conta a Receber Importada de uma NF-e "RPTR" - Repetição de Contas a Receber "VENR" - Parcela a Receber de Vendas "XMLR" - Conta a Receber Importada de um arquivo XML |
importado_api | string | Lançamento gerado pela API |
info | object | Informações complemetares. |
lancamento_detalhe | lista de object | |
nCodOS | lista de integer | ID da Ordem de Serviço. Quando informado na inclusão do título, preenche o campo numero_pedido para a conta a receber. Obs. O campo nCodOS não é alterado internamente. |
nCodPedido | integer | ID do Pedido de Venda. Preenchimento opcional. Quando informado na inclusão do título associa o documento a um Pedido de Venda já existente no Omie. |
nsu | string | Número Sequencial Único - Comprovante de pagamento. |
numero_documento | string | Número do Documento |
numero_documento_fiscal | string | Número do Documento Fiscal |
numero_parcela | string | Número da parcela "Formatada" como 999/999 |
numero_pedido | string | Número do Pedido |
observacao | string | Observação |
operacao | string | Operação |
recebimento obrigatório | object | Detalhes do recebimento (baixa). Informe aqui os detalhes do recebimento do lançamento. Ao preencher esse campo é possível detalhar informações da baixa do documento, como: Valor Recebido, Desconto, Juros, Multa, etc. Quando essa tag estiver preenchida é obrigatório o preenchimento da tag "baixar_documento" com "S" Caso essa tag não seja preenchida o lançamento será baixado de forma integral de acordo com os valores do lançamento. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Informação localizada na Aba "Recebimentos" no cadastro do lançamento. Preenchimento opcional. |
repeticao | object | Repetição do lançamento. Utilize essa estrutura para cadastrar várias parcela na mesma requisição. Escolha entre as tags "mensal", "semanal" ou "especifico" para definir as datas de vencimento e quantidade de parcelas. Informação localizada na Aba "Repetição" do cadastro do título. Essa tag é utilizada apenas nos métodos de Inclusão e Alteração. Preenchimento opcional. |
retem_cofins | string | Indica que o Valor do COFINS informado deve ser retido |
retem_csll | string | Indica que o Valor do CSLL informado deve ser retido |
retem_inss | string | Indica que o Valor do INSS informado deve ser retido |
retem_ir | string | Indica que o Valor do Imposto de Renda informado deve ser retido |
retem_iss | string | Indica que o Valor do ISS informado deve ser retido |
retem_pis | string | Indica que o Valor do PIS informado deve ser retido |
status_titulo | string | Status do Título |
tipo_agrupamento | string | Tipo de agrupamento dos lançamentos. Pode ser: C-Consolidado (sintético). I-Individual (analítico). Não deve ser preenchido na Inclusão/alteração pois é de preenchimento automático para lançamentos recebidos do PDV. |
valor_cofins | number | Valor do COFINS |
valor_csll | number | Valor do CSLL |
valor_documento | number | Valor do Lançamento |
valor_inss | number | Valor do INSS |
valor_ir | number | Valor do Imposto de Renda |
valor_iss | number | Valor do ISS |
valor_pis | number | Valor do PIS |
{
"codigo_lancamento_integracao": "#TS#",
"codigo_cliente_fornecedor": 4214850,
"data_vencimento": "#TODAY#",
"valor_documento": 100,
"codigo_categoria": "1.01.02",
"data_previsao": "#TODAY#",
"id_conta_corrente": 4243124
}