POST provisoes - Varejonline/api GitHub Wiki

Endpoint para geração de provisões e parcelas a pagar ou receber.

A definição do tipo de provisão (pagar ou receber) é estabelecida pela configuração do lançamento padrão utilizado. Caso seja informado um terceiro para a provisão, o terceiro do lançamento padrão será desconsiderado. Da mesma forma, caso sejam informadas parcelas ou tipo de documento para a provisão, será desconsiderada a configuração presente no lançamento padrão.

URL

POST https://integrador.varejonline.com.br/apps/api/provisoes-contas

Parâmetros

Envie um JSON no corpo da requisição, contendo:

• idLancamentoPadrao: id do lançamento padrão em que esta provisão será baseada (long) (obrigatório)
• tipoDocumento: objeto com opções de identificadores para o tipoDocumento
  • id: id do tipoDocumento (long)
  • nome: nome do tipoDocumento (string)
• numeroDocumento: número do documento da provisão. Obrigatório de acordo com o tipoDocumento informado (string)
• entidade: objeto da entidade para a qual esta provisão será feita (obrigatório)
  • id: id da entidade (long)
• terceiro: Objeto com opções de identificadores para o terceiro a quem se destina a provisão. Obrigatório caso não informado no lançamento padrão
  • id: id do terceiro (long)
  • documento: documento do terceiro com/sem formatação (string)
• data: data da provisão 'dd-mm-aaaa' (string) (obrigatório)
• valor: valor da provisão (decimal) (obrigatório)
• historico: Histórico de controle para os lançamentos contábeis (string)
• parcelas: definição das parcelas da provisão (Quando definido, não é usada a configuração do lançamento padrão)
  • numero: Número da parcela (long) (obrigatório)
  • valor: Valor da parcela (decimal) (obrigatório)
  • dataVencimento: Data de vencimento da parcela 'dd-mm-aaaa' (string) (obrigatório)

Retorno

Sucesso:

• HTTP STATUS 201 – CREATED
• Body: id da provisão gerada

Requisição inválida:

• HTTP STATUS 400 – BAD REQUEST
• Body: mensagem de erro

Exemplo

POST https://integrador.varejonline.com.br/apps/api/provisoes-contas

'Content-Type'='application/json'

{
    "data": "03-04-2017",
    "idLancamentoPadrao": 1009,
    "numeroDocumento": "111-1",
    "valor" : 20.0,
    "tipoDocumento" :{
        "id": "20",
        "nome": "BOLETO"
    },
    "entidade" :{
        "id": "1"
    },
     "terceiro" :{
        "id": "1",
        "documento": "99999999999"
    },
    "historico" : "Criacao de Provisao a Pagar com parcelas definidas",
    "parcelas" : [
        {
            "numero" : 1,
            "valor" : 10.00,
            "dataVencimento" : "03/05/2017"
        },
        {
            "numero" : 2,
            "valor" : 10.00,
            "dataVencimento" : "03/06/2017"
        }
    ]
}