Pular para o conteúdo principal

Lança um pagamento na conta a receber

POST 
/accounts/receivable/:idaccountreceivable/payment

Registra um pagamento na conta a receber, atualizando o status conforme o saldo pendente. Regras:

  • Quando a conta tinha previsão (Forecast=1), a flag é zerada após o lançamento.
  • Quando a conta não tinha banco previsto (IDBankAccountForecast), assume o banco do pagamento como previsão.
  • Quando IDAccountsPayableReceivableConciliation ou IDAccountsPayableReceivableConciliationMarketplace é informado e o valor pago difere do total do título — valor Value mais juros ValueInterest e multa ValuePenalty, menos desconto ValueDiscount — o sistema procura outro título em aberto do mesmo pedido com o mesmo TID ou NSU e redistribui a diferença entre os dois. Se não encontrar, a requisição falha e nada é gravado.
  • Com IDAccountsPayableReceivableConciliation, cria adicionalmente o lançamento de taxa adquirente abatendo o valor da comissão, usando o plano de contas e o tipo de documento configurados na integração.
  • Quando IDAccountsPayableReceivableConciliationMarketplace é informado, gera automaticamente as contas filhas das taxas do marketplace, vinculadas ao título da baixa: comissão (MarketplaceFeeValue), antecipação (MarketplaceFinancingFeeValue), frete (MarketplaceShippingFeeValue), cupom (MarketplaceCouponValue), impostos (MarketplaceTaxesValue) e outras taxas (MarketplaceOtherFeeValue). Cada categoria só vira título próprio quando a integração tem um plano de contas configurado para ela e o valor é diferente de zero; antecipação, frete, cupom e outras taxas sem plano de contas configurado são somadas ao valor da comissão. O plano de contas de impostos não é oferecido nas integrações de marketplace hoje, então na prática impostos não geram título — e, por não entrarem na regra de absorção, também não são somados à comissão. Cada conta filha recebe também o lançamento correspondente no extrato bancário e, quando a integração tem centro de custo configurado, o rateio nesse centro. Os valores entram com o sinal invertido em relação à taxa: taxa cobrada vira débito e taxa devolvida (cancelamento) vira crédito. Concluído o vínculo, a conciliação é fechada como conciliada manualmente (IDTypeStatusConciliation=3).
  • Pagamentos em conta de caixinha (BankNumber=000) só são aceitos com a caixinha fechada.
  • Quando FinishIfPossible=1 e há pedido vinculado, e nenhum título do pedido continua em aberto após este lançamento, o pedido é levado adiante no fluxo (fechamento do pedido, sujeito às validações de saldo, crédito e margem configuradas).

Request​

Responses​

Pagamento lançado. Retorna a conta a receber atualizada (ou a string "sucesso" quando query=1).

Última atualização em