Campos disponíveis para Receita API V2


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

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

 

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

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

 

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

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

 

Exemplo de apresentação do Campo:

“SF12_Doc”: {
“alias”: “documento”,
“description”: “numero documento”,
“type”: “integer”,
“format”: “integer”,
“size”: “9”,
“required”: “no”
},

{
“status”: true,
“options”: {
“post”: {
“SF2_Doc”: {
“alias”: “documento”,
“description”: “Identificação da receita. EX: /Descrição/Código/ID da receita”,
“type”: “string”,
“format”: “free”,
“size”: “20”,
“required”: “no”
},
“SF2_Emissao”: {
“alias”: “data_emissao”,
“description”: “Data de emissao formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SF2_IDSA1”: {
“alias”: “cliente_id”,
“description”: “id do cliente”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SF2_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do pedido”,
“type”: “string”,
“format”: “free”,
“size”: “255”,
“required”: “no”
},
“itens”: {
“alias”: “itens”,
“description”: “itens do pedido”,
“type”: “json”,
“format”: “json”,
“required”: “yes”,
“options”: {
“SD2_IDSB1”: {
“alias”: “produto_id”,
“description”: “id do produto”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“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”
},
“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”
},
“SD2_IDSA3”: {
“alias”: “vendedor_id”,
“description”: “ID do vendedor.”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“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”: “yes”
},
“SD2_PrcUni”: {
“alias”: “preco_unitario”,
“description”: “preco unitario do item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“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”: “yes”
},
“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”: “yes”
},
“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”
}
}
},
“parcelas”: {
“alias”: “parcelas”,
“description”: “parcelas do pedido”,
“type”: “json”,
“format”: “json”,
“required”: “yes”,
“options”: {
“SE2_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do recebimento da parcela”,
“type”: “string”,
“format”: “string”,
“size”: “255”,
“required”: “yes”
},
“SE2_IDSA6”: {
“alias”: “banco_id”,
“description”: “ID do banco(somente para pagamento_tipo=$)”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=$”
},
“SE2_Vencto”: {
“alias”: “vencimento”,
“description”: “Data de Vencimento da parcela formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SE2_Valor”: {
“alias”: “valor”,
“description”: “Valor da parcela”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SE2_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”
},
“SE2_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”
},
“SE2_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”
},
“SE2_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”: {
“SF2_ID”: {
“alias”: “receita_id”,
“description”: “ID da receita a ser alterada”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SF2_Doc”: {
“alias”: “documento”,
“description”: “Identificação da receita. EX: /Descrição/Código/ID da receita”,
“type”: “string”,
“format”: “free”,
“size”: “20”,
“required”: “yes”
},
“SF2_Emissao”: {
“alias”: “data_emissao”,
“description”: “Data de emissao formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SF2_IDSA1”: {
“alias”: “cliente_id”,
“description”: “id do cliente”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SF2_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do pedido”,
“type”: “string”,
“format”: “free”,
“size”: “255”,
“required”: “no”
},
“itens”: {
“alias”: “itens”,
“description”: “itens do pedido”,
“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”
},
“SD2_ID”: {
“alias”: “item_id”,
“description”: “ID do item a ser alterado na receita”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:operacao=A,E”
},
“SD2_IDSB1”: {
“alias”: “produto_id”,
“description”: “id do produto”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“SD2_SemTitulo”: {
“alias”: “sem_titulo”,
“description”: “‘S’, ‘N’ (S-nao tem titulo (ValItem=0), N-tem titulo)”,
“type”: “string”,
“format”: “flag:S,N”,
“size”: “1”,
“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”: “yes”
},
“SD2_IDSA3”: {
“alias”: “vendedor_id”,
“description”: “ID do vendedor.”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “yes”
},
“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”: “yes”
},
“SD2_PrcUni”: {
“alias”: “preco_unitario”,
“description”: “preco unitario do item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“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”: “yes”
},
“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”: “yes”
},
“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”
}
}
},
“parcelas”: {
“alias”: “parcelas”,
“description”: “itens do pedido”,
“type”: “json”,
“format”: “json”,
“required”: “no”,
“options”: {
“Operacao”: {
“alias”: “operacao”,
“description”: “Tipo de operacao para a parcela. ‘I’:inclusao, ‘A’:alteracao, ‘E’:exclusao”,
“type”: “string”,
“format”: “flag:I,A,E”,
“size”: “1”,
“required”: “yes”
},
“SE2_ID”: {
“alias”: “parcela_id”,
“description”: “ID da parcela a ser alterada na receita”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:operacao=A,E”
},
“SE2_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do recebimento da parcela”,
“type”: “string”,
“format”: “string”,
“size”: “255”,
“required”: “d_alias:operacao=I”
},
“SE2_Vencto”: {
“alias”: “vencimento”,
“description”: “Data de Vencimento da parcela formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “d_alias:operacao=I”
},
“SE2_Valor”: {
“alias”: “valor”,
“description”: “Valor da parcela”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “d_alias:operacao=I”
},
“SE2_IDSA6”: {
“alias”: “banco_id”,
“description”: “ID do banco(somente para pagamento_tipo=$)”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=$”
},
“SE2_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=$”
},
“SE2_Tipo”: {
“alias”: “pagamento_tipo”,
“description”: “Codigo da forma de pagamento. Codigos aceitos: ‘PRZ'(prazo), ‘PRE'(cheque), ‘CC'(cartao de credito)”,
“type”: “string”,
“format”: “flag:$,PRZ,PRE,CC”,
“size”: “3”,
“required”: “d_alias:operacao=I”
},
“SE2_IDSA8”: {
“alias”: “cartao_id”,
“description”: “ID do cartao – credito/debito – (somente para pagamento_tipo=CC)”,
“type”: “string”,
“format”: “string”,
“size”: “100”,
“required”: “d_alias:pagamento_tipo=CC”
},
“SE2_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”: “receita_id”,
“description”: “ID da receita, para obter receita especifica.”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “no”
},
“SF12_NrNFe”: {
“alias”: “nfe”,
“description”: “numero nfe”,
“type”: “integer”,
“format”: “integer”,
“size”: “9”,
“required”: “no”
},
“SF12_Doc”: {
“alias”: “documento”,
“description”: “numero documento”,
“type”: “integer”,
“format”: “integer”,
“size”: “9”,
“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_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_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do pedido”,
“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”
},
“SD12_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”
},
“SD12_PrcUni”: {
“alias”: “preco_unitario”,
“description”: “preco unitario do item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD12_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”
},
“SD12_ValFrete”: {
“alias”: “frete_valor”,
“description”: “valor do frete para o item.”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “no”
},
“SD12_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”
}
}
},
“parcelas”: {
“alias”: “parcelas”,
“description”: “parcelas do pedido”,
“type”: “json”,
“format”: “json”,
“required”: “yes”,
“options”: {
“SE2_Hist”: {
“alias”: “historico”,
“description”: “informação sobre o histórico do recebimento da parcela”,
“type”: “string”,
“format”: “string”,
“size”: “255”,
“required”: “yes”
},
“SE2_IDSA6”: {
“alias”: “banco_id”,
“description”: “ID do banco(somente para pagamento_tipo=$)”,
“type”: “integer”,
“format”: “integer”,
“size”: “10”,
“required”: “d_alias:pagamento_tipo=$”
},
“SE2_Vencto”: {
“alias”: “vencimento”,
“description”: “Data de Vencimento da parcela formato: dd/mm/aaaa”,
“type”: “string”,
“format”: “date_br”,
“size”: “10”,
“required”: “yes”
},
“SE2_Valor”: {
“alias”: “valor”,
“description”: “Valor da parcela”,
“type”: “decimal”,
“format”: “decimal”,
“size”: “10,2”,
“required”: “yes”
},
“SE2_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”
},
“SE2_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”
},
“SE2_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”
},
“SE2_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”
}
}
}
}
}
}