Campos disponíveis para Despesa API V2


Para obter todos os campos disponíveis para inclusão de despesa pela API, realize uma requisição usando o método POST para o endereço:

http://implantacaoapi.erpflex.com.br/api_v2/despesa/options

 

Para obter todos os campos disponíveis para alteração de despesa pela API, realize uma requisição usando o método PUT para o endereço:

http://implantacaoapi.erpflex.com.br/api_v2/despesa/options

 

Para obter todos os campos disponíveis para consulta de despesa pela API, realize uma requisição usando o método GET para o endereço:

http://implantacaoapi.erpflex.com.br/api_v2/despesa/options

 

Exemplo de apresentação do Campo:

 “SF12_NrNFe”: {
“alias”: “nr_nfe”,
“description”: “Número da Nota Fiscal.”,
“type”: “string”,
“format”: “free”,
“size”: “20”,
“required”: “no”
}

{
“status”: true,
“options”: {
“post”: {
“SF1_Doc”: {
“alias”: “documento”,
“description”: “Identificação da despesa. EX: /Descrição/Código/ID da despesa”,
“type”: “string”,
“format”: “free”,
“size”: “20”,
“required”: “no”
},
“SF1_Emissao”: {
“alias”: “data_emissao”,
“description”: “Data de emissao formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SF1_IDSA1”: {
“alias”: “fornecedor_id”,
“description”: “id do fornecedor”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SF1_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico da despesa”,
“type”: “string”,
“format”: “free”,
“size”: “255”,
“required”: “no”
},
“itens”: {
“alias”: “itens”,
“description”: “itens da despesa”,
“type”: “json”,
“format”: “json”,
“required”: “yes”,
“options”: {
“SD1_IDSB1”: {
“alias”: “produto_id”,
“description”: “id do produto”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SB2_ChaveItensVar”: {
“alias”: “variante_chave”,
“description”: “Chave da variante do produto. Informar \”0\”(zero) quando o produto não tiver variante.”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SD1_DtValidade”: {
“alias”: “data_validade”,
“description”: “Data de validade formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “no”
},
“SD1_Quant”: {
“alias”: “quantidade”,
“description”: “Quantidade vendida do item. ex: 1 ou 1.000 são equivalentes”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,3”,
“required”: “yes”
},
“SD1_PrcUni”: {
“alias”: “preco_unitario”,
“description”: “preco unitario do item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SD1_ValFrete”: {
“alias”: “frete_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValDespesa”: {
“alias”: “acrescimos_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValJuros”: {
“alias”: “juros_valor”,
“description”: “valor dos juros para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValDesconto”: {
“alias”: “desconto_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValItem”: {
“alias”: “preco_total_item”,
“description”: “preço da soma do item (quantidade do item * preco unitario).”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SD1_SemTitulo”: {
“alias”: “sem_titulo”,
“description”: “S-nao tem titulo (ValItem=0), N-tem titulo”,
“type”: “string”,
“format”: “flag:S,N”,
“size”: “1”,
“required”: “no”
},
“SD1_AtuEst”: {
“alias”: “atualiza_estoque”,
“description”: “Atualiza o estoque do item:  0:nao  1:sim”,
“type”: “integer”,
“format”: “flag:0,1”,
“size”: “1”,
“required”: “yes”
}
}
},
“parcelas”: {
“alias”: “parcelas”,
“description”: “parcelas da despesa”,
“type”: “json”,
“format”: “json”,
“required”: “no”,
“options”: {
“SE1_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do recebimento da parcela”,
“type”: “string”,
“format”: “string”,
“size”: “255”,
“required”: “yes”
},
“SE1_IDSA6”: {
“alias”: “banco_id”,
“description”: “ID do banco(somente para pagamento_tipo=$)”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=$”
},
“SE1_Vencto”: {
“alias”: “vencimento”,
“description”: “Data de Vencimento da parcela formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SE1_Valor”: {
“alias”: “valor”,
“description”: “Valor da parcela”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SE1_Baixa”: {
“alias”: “data_baixa”,
“description”: “Data de Baixa da parcela formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=$”,
“default”: “00/00/0000”
},
“SE1_Tipo”: {
“alias”: “pagamento_tipo”,
“description”: “Codigo da forma de pagamento. Codigos aceitos: ‘PRZ'(prazo), ‘PRE'(cheque), ‘CC'(cartao de credito), ‘$'(a vista)”,
“type”: “string”,
“format”: “flag:$,PRZ,PRE,CC”,
“size”: “3”,
“required”: “yes”
},
“SE1_IDSA8”: {
“alias”: “cartao_id”,
“description”: “ID do cartao de credito (somente para pagamento_tipo=CC)”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=CC”
},
“SE1_Cheque”: {
“alias”: “cheque_numero”,
“description”: “numero do cheque (somente para pagamento_tipo=PRE)”,
“type”: “string”,
“format”: “string”,
“size”: “100”,
“required”: “d_alias:pagamento_tipo=PRE”
}
}
}
}
}
}

{
“status”: true,
“options”: {
“put”: {
“SF1_ID”: {
“alias”: “id_despesa”,
“description”: “id da despesa”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SF1_Doc”: {
“alias”: “documento”,
“description”: “Identificação da despesa. EX: /Descrição/Código/ID da despesa”,
“type”: “string”,
“format”: “free”,
“size”: “20”,
“required”: “no”
},
“SF1_Emissao”: {
“alias”: “data_emissao”,
“description”: “Data de emissao formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SF1_IDSA1”: {
“alias”: “fornecedor_id”,
“description”: “id do fornecedor”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SF1_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico da despesa”,
“type”: “string”,
“format”: “free”,
“size”: “255”,
“required”: “no”
},
“itens”: {
“alias”: “itens”,
“description”: “itens da despesa”,
“type”: “json”,
“format”: “json”,
“required”: “yes”,
“options”: {
“Operacao”: {
“alias”: “operacao”,
“description”: “Tipo de Operacao para o item. ‘I’:inclusao, ‘A’:alteracao, ‘E’:exclusao”,
“type”: “string”,
“format”: “flag:I,A,E”,
“size”: “1”,
“required”: “yes”
},
“SD1_ID”: {
“alias”: “item_id”,
“description”: “id do item”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:operacao=A,E”
},
“SD1_IDSB1”: {
“alias”: “produto_id”,
“description”: “id do produto”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SB2_ChaveItensVar”: {
“alias”: “variante_chave”,
“description”: “Chave da variante do produto. Informar \”0\”(zero) quando o produto não tiver variante.”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SD1_DtValidade”: {
“alias”: “data_validade”,
“description”: “Data de validade formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “no”
},
“SD1_Quant”: {
“alias”: “quantidade”,
“description”: “Quantidade vendida do item. ex: 1 ou 1.000 são equivalentes”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,3”,
“required”: “yes”
},
“SD1_PrcUni”: {
“alias”: “preco_unitario”,
“description”: “preco unitario do item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SD1_ValFrete”: {
“alias”: “frete_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValDespesa”: {
“alias”: “acrescimos_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValJuros”: {
“alias”: “juros_valor”,
“description”: “valor dos juros para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValDesconto”: {
“alias”: “desconto_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD1_ValItem”: {
“alias”: “preco_total_item”,
“description”: “preço da soma do item (quantidade do item * preco unitario).”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SD1_SemTitulo”: {
“alias”: “sem_titulo”,
“description”: “S-nao tem titulo (ValItem=0), N-tem titulo”,
“type”: “string”,
“format”: “flag:S,N”,
“size”: “1”,
“required”: “no”
},
“SD1_AtuEst”: {
“alias”: “atualiza_estoque”,
“description”: “Atualiza o estoque do item:  0:nao  1:sim”,
“type”: “integer”,
“format”: “flag:0,1”,
“size”: “1”,
“required”: “yes”
}
}
},
“parcelas”: {
“alias”: “parcelas”,
“description”: “parcelas da despesa”,
“type”: “json”,
“format”: “json”,
“required”: “no”,
“options”: {
“Operacao”: {
“alias”: “operacao”,
“description”: “Tipo de Operacao para o item. ‘I’:inclusao, ‘A’:alteracao, ‘E’:exclusao”,
“type”: “string”,
“format”: “flag:I,A,E”,
“size”: “1”,
“required”: “yes”
},
“SE1_ID”: {
“alias”: “parcela_id”,
“description”: “ID da Parcela”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:operacao=A,E”
},
“SE1_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do recebimento da parcela”,
“type”: “string”,
“format”: “string”,
“size”: “255”,
“required”: “yes”
},
“SE1_IDSA6”: {
“alias”: “banco_id”,
“description”: “ID do banco(somente para pagamento_tipo=$)”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=$”
},
“SE1_Vencto”: {
“alias”: “vencimento”,
“description”: “Data de Vencimento da parcela formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SE1_Valor”: {
“alias”: “valor”,
“description”: “Valor da parcela”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SE1_Baixa”: {
“alias”: “data_baixa”,
“description”: “Data de Baixa da parcela formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=$”,
“default”: “00/00/0000”
},
“SE1_Tipo”: {
“alias”: “pagamento_tipo”,
“description”: “Codigo da forma de pagamento. Codigos aceitos: ‘PRZ'(prazo), ‘PRE'(cheque), ‘CC'(cartao de credito), ‘$'(a vista)”,
“type”: “string”,
“format”: “flag:$,PRZ,PRE,CC”,
“size”: “3”,
“required”: “yes”
},
“SE1_IDSA8”: {
“alias”: “cartao_id”,
“description”: “ID do cartao de credito (somente para pagamento_tipo=CC)”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=CC”
},
“SE1_Cheque”: {
“alias”: “cheque_numero”,
“description”: “numero do cheque (somente para pagamento_tipo=PRE)”,
“type”: “string”,
“format”: “string”,
“size”: “100”,
“required”: “d_alias:pagamento_tipo=PRE”
}
}
}
}
}
}

{
“status”: true,
“options”: {
“get”: {
“SF12_ID”: {
“alias”: “faturamento_id”,
“description”: “id do registro”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SF3_ID”: {
“alias”: “dados_fiscais_id”,
“description”: “id dos registros fiscais”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SF12_Emissao”: {
“alias”: “data_emissao”,
“description”: “Data de emissao formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “no”
},
“SF12_Doc”: {
“alias”: “documento”,
“description”: “Identificação do Faturamento.”,
“type”: “string”,
“format”: “free”,
“size”: “20”,
“required”: “no”
},
“SF12_NrNFe”: {
“alias”: “nr_nfe”,
“description”: “Número da Nota Fiscal.”,
“type”: “string”,
“format”: “free”,
“size”: “20”,
“required”: “no”
},
“SF12_IDSA1”: {
“alias”: “cliente_id”,
“description”: “id do cliente”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SA1_Desc”: {
“alias”: “nome_cliente”,
“description”: “nome do cliente”,
“type”: “string”,
“format”: “string”,
“size”: “60”,
“required”: “no”
},
“SF12_IDSA1Relacionado”: {
“alias”: “cliente_relacionado_id”,
“description”: “id do cliente relacionado”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SF12_IDSC5”: {
“alias”: “orcamento_id”,
“description”: “id do orcamento”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SF3_ModeloNF”: {
“alias”: “modelo_nf”,
“description”: “Modelo da NF. ’55’:NFE-e”,
“type”: “string”,
“format”: “flag:55”,
“size”: “2”,
“required”: “yes”
},
“SF3_Serie”: {
“alias”: “serie_nf”,
“description”: “número de série da NF”,
“type”: “integer”,
“format”: “integer”,
“size”: “3”,
“required”: “yes”
},
“SF3_ValNF”: {
“alias”: “valor_nf”,
“description”: “valor total da nota.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “11,2”,
“required”: “no”
},
“SF3_ModFrete”: {
“alias”: “mod_frete”,
“description”: “Modalidade do Frete. ‘0’:Emitente, ‘1’:Destinatario”,
“type”: “string”,
“format”: “flag:0,1”,
“size”: “1”,
“required”: “no”
},
“SF3_Placa”: {
“alias”: “placa”,
“description”: “Placa do Veículo”,
“type”: “string”,
“format”: “free”,
“size”: “7”,
“required”: “no”
},
“SF3_UFPlaca”: {
“alias”: “uf_placa”,
“description”: “UF da Placa do Veículo”,
“type”: “string”,
“format”: “free”,
“size”: “2”,
“required”: “no”
},
“SF3_QuantVol”: {
“alias”: “qtd_volume”,
“description”: “Quantidade de Volumes.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SF3_EspecieVol”: {
“alias”: “especie_volume”,
“description”: “Especie Volume”,
“type”: “string”,
“format”: “free”,
“size”: “30”,
“required”: “no”
},
“SF3_MarcaVol”: {
“alias”: “marca_volume”,
“description”: “Marca Volume”,
“type”: “string”,
“format”: “free”,
“size”: “30”,
“required”: “no”
},
“SF3_NumeroVol”: {
“alias”: “numero_volume”,
“description”: “Numero Volume”,
“type”: “string”,
“format”: “free”,
“size”: “30”,
“required”: “no”
},
“SF3_PesoLiquido”: {
“alias”: “peso_liquido”,
“description”: “Peso Liquido.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “11,3”,
“required”: “no”
},
“SF3_PesoBruto”: {
“alias”: “peso_bruto”,
“description”: “Peso Bruto.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “11,3”,
“required”: “no”
},
“SF3_InfAdic”: {
“alias”: “inf_adicional”,
“description”: “Informações Adicionais”,
“type”: “string”,
“format”: “free”,
“size”: “255”,
“required”: “no”
},
“SF3_InfAdicFisco”: {
“alias”: “inf_adicional_fisico”,
“description”: “Informações Adicionais”,
“type”: “string”,
“format”: “free”,
“size”: “255”,
“required”: “no”
},
“itens”: {
“alias”: “itens”,
“description”: “itens do pedido”,
“type”: “json”,
“format”: “json”,
“required”: “yes”,
“options”: {
“SD12_ID”: {
“alias”: “item_id”,
“description”: “id do item”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SD12_IDSB1”: {
“alias”: “produto_id”,
“description”: “id do produto”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SD2_SemTitulo”: {
“alias”: “sem_titulo”,
“description”: “S-nao tem titulo (ValItem=0), N-tem titulo”,
“type”: “string”,
“format”: “flag:S,N”,
“size”: “1”,
“required”: “no”
},
“SB1_Desc”: {
“alias”: “desc_produto”,
“description”: “descricao do produto”,
“type”: “string”,
“format”: “string”,
“size”: “255”,
“required”: “no”
},
“SB2_ChaveItensVar”: {
“alias”: “variante_chave”,
“description”: “Chave da variante do produto. Informar \”0\”(zero) quando o produto não tiver variante.”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SB1_EAN”: {
“alias”: “EAN”,
“description”: “EAN”,
“type”: “string”,
“format”: “string”,
“size”: “14”,
“required”: “no”
},
“SD2_IDSA3”: {
“alias”: “vendedor_id”,
“description”: “ID do vendedor.”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SD2_Quant”: {
“alias”: “quantidade”,
“description”: “Quantidade vendida do item. ex: 1 ou 1.000 são equivalentes”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,3”,
“required”: “no”
},
“SD2_PrcUni”: {
“alias”: “preco_unitario”,
“description”: “preco unitario do item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD2_ValItem”: {
“alias”: “preco_total_item”,
“description”: “preço da soma do item (quantidade do item * preco unitario).”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD2_ValFrete”: {
“alias”: “frete_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD2_AtuEst”: {
“alias”: “baixa_estoque”,
“description”: “Baixar o estoque do item:  0:nao  1:sim”,
“type”: “integer”,
“format”: “flag:0,1”,
“size”: “1”,
“required”: “no”
},
“SD2_AR”: {
“alias”: “aviso_recebimento”,
“description”: “Aviso de recebimento de mercadoria despachada”,
“type”: “string”,
“format”: “free”,
“size”: “50”,
“required”: “no”
},
“SD2_DataDespacho”: {
“alias”: “despacho_data”,
“description”: “Data de despacho de mercadoria”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “no”
},
“SD2_QuantDespacho”: {
“alias”: “despacho_qtd”,
“description”: “Quantidade de itens despachados”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
}
}
}
}
}
}