Lança um pagamento da NFS-e

POST 
/invoice-service/:idserviceorder/payment

Lança o pagamento da NFS-e como conta(s) a receber. Quando SplitInstallment=1, o valor enviado é dividido pelo número de parcelas e cada parcela vira uma conta a receber — a diferença de arredondamento é aplicada na primeira parcela quando falta valor e na última quando sobra; quando SplitInstallment=0, o valor é lançado integralmente em uma única conta. Tipo de pagamento, tipo de documento, plano de contas, conta bancária, integração e empresa faturadora são validados contra os cadastros da empresa e, quando omitidos, assumem os padrões configurados. Quando DateDue não é enviada, o vencimento é calculado a partir do prazo aplicável e a taxa configurada para o tipo de pagamento pode ainda acrescentar dias úteis, antes ou depois desse prazo, conforme o cadastro da taxa. Registra o lançamento no histórico da nota e devolve o detalhe atualizado da NFS-e.

Request

Responses

200

Pagamento lançado. Retorna o detalhe atualizado da NFS-e.

400

Validação falhou. Todas as mensagens chegam com o prefixo [BadRequest] - e trazem, entre parênteses, os identificadores envolvidos (por exemplo Tipo pagamento não cadastrado (IDTypePayment: 12, IDCompany: 3)). Mensagens: Tipo pagamento padrão não cadastrado para a empresa; Tipo pagamento não cadastrado; Tipo documento padrão não cadastrado para a empresa; Tipo documento não cadastrado; Tipo registro padrão não cadastrado para a empresa; Tipo registro não cadastrado; Banco de recebimento não cadastrado; Banco <id> não cadastrado (refere-se a IDBankAccount, não a IDBankAccountForecast); Integração não cadastrada; Empresa faturadora não encontrada; Pedido não encontrado; Erro ao criar pagamento; Não foi possível registrar o pagamento. Tente novamente. (falha de comunicação, o pagamento NÃO foi gravado); Pagamento registrado, mas não foi possível recarregar a ordem de serviço. Atualize a tela. (o pagamento FOI gravado — recarregue a tela em vez de repetir a chamada).

404

NFS-e não encontrada para a empresa autenticada: [NotFound] - Pedido não encontrado. Não confundir com a mensagem homônima [BadRequest] - Pedido não encontrado, que sai com status 400 e vem da validação do lançamento do pagamento.