1. Contas a Pagar
  • Introdução
    • Integração ONE
    • Visão Geral da API Rest
    • Ciclo de Vida da API
  • Ambiente
    • Ambiente
  • Autenticação
    • Gerando Chaves de Acesso
    • Autenticando-se
    • Token de Acesso
      POST
  • Projetos
    • Entendendo Projetos
    • Criação de Projeto
      POST
  • Medição
    • Entendendo a Medição
    • Criação de Medição
      POST
    • Consulta de Impostos da Empresa
      GET
    • Adição de Retenções Fiscais em uma Medição
      POST
    • Criação de Parcela em Medição
      POST
    • Validação das Parcelas
      POST
    • Validação da Medição
      PATCH
    • Mudança de Status da Medição
      PATCH
  • Contas a Pagar
    • Entendendo o Contas a Pagar
    • Adicinar Comprovante de Pagamento em Parcela
      POST
  • Fluxo Financeiro
    • Entendendo o Fluxo Financeiro
  • Webhooks
    • Entendendo o Payload
    • Eventos
      • Utilizando Webhooks
      • Criação de Medição
      • Atualização de Medição
      • Criação e Atualização de Parcela
      • Criação e Atualização de Fluxo Financeiro
  1. Contas a Pagar

Adicinar Comprovante de Pagamento em Parcela

POST
api/v1/oneos/measurement/{measurementId}/installments/{installmentId}/payment-receipts
Endpoint para inserir comprovante de pagamento em uma parcela e registrar sua baixa.

Requisição

Parâmetros Path
measurementId
string 
requerido
installmentId
string 
requerido
Parâmetros Bodyapplication/json
financialReceiptRequestDTO 
object 
requerido
receiptFile 
string 
requerido
Exemplo
{
    "financialReceiptRequestDTO ": {},
    "receiptFile ": "string"
}

Exemplos de Requisição

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'api/v1/oneos/measurement//installments//payment-receipts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "financialReceiptRequestDTO ": {},
    "receiptFile ": "string"
}'

Respostas

🟢200Success
application/json
Body
paymentDate
string 
requerido
Data do pagamento
Exemplo:
2022-08-22
Padrão de combinação:
yyyy-MM-dd
amount
string 
requerido
Valor pago referente ao comprovante enviado
Exemplo:
900.38
description
string 
requerido
Comentário sobre o pagamento
Exemplo:
Alguma descrição relevante do pagamento
id
string 
requerido
ID do recibo
receiptFileBase64
string 
requerido
Recibo em Base64
Exemplo
{
    "paymentDate": "2022-08-22",
    "amount": 900.38,
    "description": "Alguma descrição relevante do pagamento",
    "id": 0,
    "receiptFileBase64": "string"
}
Modificado em 2024-04-10 19:03:37
Página anterior
Entendendo o Contas a Pagar
Próxima página
Entendendo o Fluxo Financeiro
Built with