Payment Time Elapsed Report

View average payment time in PDF format.

This reports on number of payments over a period of time, their total, average payment amount, and average days elapsed from creating the payment link to collecting the payment.

A table of individual payments is also given grouped by payment ID, which show when the payment link was issued, when it was paid, and the number of days it took to collect payment.

This endpoint allows using a custom date range using start and end, or interval.

---

Parameters

  

    

      POST /report/paymenttimeelapsed
    
    

      CURL 
      PHP
      Python
      Ruby
        
    
  

  curl \
  -X POST \
  -d api_key=TURBO_API_KEY \
  https://api.tur.bo/report/paymenttimeelapsed  
  <?php
  $api_url ='https://api.tur.bo';
  $api_path='/report/paymenttimeelapsed';
  $api_key ='TURBO_API_KEY';
  $fields  =array( 'api_key'=>$api_key );
  $opts    =array( 'form_params'=>$fields );

  try {
    $client  =new GuzzleHttp\Client( array( 'base_uri'=>$api_url ) );
    $response=$client->post( $api_path,$opts );
    $json    =$response->getBody();

    echo $json;
  }
  catch( Exception $e ) {
    echo 'error = ',$e->getMessage(),"\n";
  }
  ?>  
  #!/usr/bin/python
import requests
import json

api_url="https://api.tur.bo/report/paymenttimeelapsed"
result=requests.post( api_url,data="api_key=TURBO_API_KEY" )
print( json.dumps( result.json() ) )  
  #!/usr/bin/env ruby
require 'uri'
require 'net/http'

api_url="https://api.tur.bo/report/paymenttimeelapsed"
uri    =URI( api_url )
result =Net::HTTP.post_form( uri,'api_key'=>'TURBO_API_KEY' )
puts result.body   

  

    

    Response    
    
  

{
  "error":false,
  "msg":"OK",
  "period": [],
  "api_path":"/paymenttimeelapsed",
  "total_results":null,
  "limit":25,
  "report_url": "https://api.tur.bo/pdf/example.pdf",
}