Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Introduction

The /paydates endpoint allows you to perform Read, queries for a Loan Pay Date Record by providing relevant information. This endpoint is accessible through GET requests and requires the use of a valid <api_key> for authentication purposes. TaskSuite will provide the appropriate key for Giggle Finance. Pay Dates is a sub-resource of loans, and loans are the top-level resource.

...

Code Block
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?date=today&timezone=America/NewYork

...

Code Block
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?date=today&timezone=America/NewYork&state=partial

...

Code Block
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?date=today&timezone=America/NewYork&state=open

...

Code Block
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?date=today&timezone=America/NewYork&state=open&state=partial

...

Code Block
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?date=today&timezone=America/NewYork&state=paid

...

Code Block
https://www.giggle.tasksuite.com/webhook/json/v1/json/loans/<loan_id:int>/paydates?date=today&timezone=America/NewYork
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?date=2024-05-16
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?start_date=2024-05-16&end_date=2024-06-16
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?start_date=2024-05-16&end_date=2024-06-16&sort=amount&order=asc
https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?start_date=2024-05-16&end_date=2024-06-16&sort=date&order=desc
...

...

Code Block
import requests
import json

url = "https://www.giggle.tasksuite.com/webhook/json/v1/json/paydates?date=today&timezone=America/NewYork"

headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <api_key>'
}

response = requests.request("GET", url, headers=headers)

...

Code Block
languagejson
{
  "data": {
 [
    {
        "id": 1,
        "state": "open",
        "date": "2024-07-11",
        "amount": 100.00,
        "amountOwed": 100.00,
        "amountPaid": 0.00,
        "startingCapital": 100000.00,
        "endingCapital": 99900.00,
        "loanBalance": 100000.00,
        "loanId": 123
      },
      {
        "id": 2,
        "state": "paid",
        "date": "2024-07-11",
        "amount": 100.00,
        "amountOwed": 0.00,
        "amountPaid": 100.00,
        "startingCapital": 500000.00,
        "endingCapital": 49900.00,
        "loanBalance": 500000.00,
        "loanId": 456
      },
      {
        "id": 3,
        "state": "partial",
        "date": "2024-07-11",
        "amount": 100.00,
        "amountOwed": 0.00,
        "amountPaid": 50.00,
        "startingCapital": 1000.00,
        "endingCapital": 900.00,
        "loanBalance": 950.00,
        "loanId": 789
      }
  }],

  "metadata": {
    "totalCount": 3,
    "numPaid": 1,
    "numPartial": 1,
    "numOpen": 1
  }
}

...