Pular para o conteúdo principal

Criar Conta a Receber

Registra uma nova conta a receber no sistema.

Endpoint​

POST /contas-receber

Body​

{
   "data": {
      "codigo_lancamento_integracao": string,
      "codigo_cliente_fornecedor": string,
      "codigo_cliente_fornecedor_integracao": string,
      "data_vencimento": string,
      "valor_documento": number,
      "codigo_categoria": string,
      "data_previsao": string,
      "categorias": [
         {
            "codigo_categoria": string,
            "percentual": number,
            "valor": number
         }
      ],
      "id_conta_corrente": number,
      "numero_documento": string,
      "numero_parcela": string,
      "codigo_tipo_documento": string,
      "numero_documento_fiscal": string,
      "numero_pedido": string,
      "chave_nfe": string,
      "observacao": string,
      "codigo_barras_ficha_compensacao": string,
      "codigo_cmc7_cheque": string,
      "data_emissao": string,
      "id_origem": string,
      "operacao": string,
      "valor_pis": number,
      "retem_pis": string,
      "valor_cofins": number,
      "retem_cofins": string,
      "valor_csll": number,
      "retem_csll": string,
      "valor_ir": number,
      "retem_ir": string,
      "valor_iss": number,
      "retem_iss": string,
      "valor_inss": number,
      "retem_inss": string,
      "bloqueado": string,
      "bloquear_baixa": string,
      "importado_api": string,
      "baixar_documento": string,
      "conciliar_documento": string,
      "acao": string,
      "lancamento_detalhe": any[],
      "distribuicao": [
         {
            "cCodDep": string,
            "cDesDep": string,
            "nPerDep": number,
            "nValDep": number
         }
      ],
      "status_titulo": string,
      "codigo_vendedor": number,
      "codigo_projeto": number,
      "nsu": string,
      "data_registro": string,
      "tipo_agrupamento": string,
      "info": {
         "cImpAPI": string,
         "dAlt": string,
         "dInc": string,
         "hAlt": string,
         "hInc": string,
         "uAlt": string,
         "uInc": string
      },
      "boleto": {
         "cGerado": string,
         "cNumBancario": string,
         "cNumBoleto": string,
         "dDtEmBol": string,
         "nPerJuros": number,
         "nPerMulta": number
      },
      "nCodPedido": number,
      "bloquear_exclusao": string,
      "nCodOS": number,
      "cPedidoCliente": string,
      "cNumeroContrato": string,
      "recebimento": {
         "codigo_recebimento_integracao": string,
         "codigo_conta_corrente": number,
         "valor": number,
         "desconto": number,
         "juros": number,
         "multa": number,
         "data": string,
         "observacao": string
      },
      "repeticao": {
         "antecipar": string,
         "postergar": string,
         "mensal": {
            "repetir_todo_dia": number,
            "repetir_por": number
         },
         "semanal": {
            "repetir_dia_semana": string,
            "repetir_por": number
         },
         "especifico": {
            "repetir_a_cada": number,
            "repetir_por": number
         }
      },
      "aprendizado_rateio": string
   }
}

Exemplo de Request​

{
   "data": {
      "codigo_lancamento_integracao": "INT001",
      "codigo_cliente_fornecedor": "12345",
      "codigo_cliente_fornecedor_integracao": "CLI001",
      "data_vencimento": "2024-03-15",
      "valor_documento": 2500.00,
      "codigo_categoria": "VENDAS",
      "data_previsao": "2024-03-15",
      "categorias": [
         {
            "codigo_categoria": "VENDAS",
            "percentual": 100,
            "valor": 2500.00
         }
      ],
      "id_conta_corrente": 1,
      "numero_documento": "DOC001",
      "numero_parcela": "1/1",
      "codigo_tipo_documento": "BOLETO",
      "observacao": "Venda de produtos diversos",
      "status_titulo": "EM ABERTO"
   }
}

Resposta​

Pelo momento a resposta é apenas a resposta padrão do pacote MySQL2

{
   "fieldCount": number,
   "affectedRows": number,
   "insertId": number,
   "info": "Rows matched: number  Changed: number  Warnings: number",
   "serverStatus": number,
   "warningStatus": number,
   "changedRows": number
}

Exemplo de Resposta​

{
   "fieldCount": 3,
   "affectedRows": 1,
   "insertId": 143,
   "info": "Rows matched: 1 Changed: 1 Warnings: 0",
   "serverStatus": 0,
   "warningStatus": 0,
   "changedRows": 1
}

Códigos de Status​

  • 201: Criado com sucesso
  • 400: Requisição inválida
  • 401: Não autorizado
  • 403: Acesso proibido
  • 500: Erro interno do servidor