{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"ed3cc1a8-0f90-4a6e-9556-0dafec9a1247"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"57eb13b6-7bfe-4719-881d-9fedff36e4f9"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Introduction","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"/paydates","type":"text","marks":[{"type":"code"}]},{"text":" 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 ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" for authentication purposes. TaskSuite will provide the appropriate key . Pay Dates is a sub-resource of loans, and loans are the top-level resource. ","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"To access this endpoint, you need to include the ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" in the header payload. The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" serves as an authentication mechanism to ensure only authorized users can manipulate Loan Pay Date Records.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Read Pay Date Record(s)","type":"text"}]},{"type":"paragraph","content":[{"text":"There are two possible requests for pay date records.","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Return pay dates corresponding to a specific loan.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Return pay dates corresponding to all loans where the date or a range of dates are specified.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Method","type":"text"}]},{"type":"paragraph","content":[{"text":"GET","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Request Body","type":"text"}]},{"type":"paragraph","content":[{"text":"None","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"The response will indicate the success or failure of the request to the Loans Transactions endpoint. The details of the response may vary based on the implementation of the API. A typical response will be a JSON object containing a success message or an error message. A successful response will be comprised of one or more pay date records corresponding to the provided date or range of dates.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Pay Dates for a specific Loan","type":"text"}]},{"type":"paragraph","content":[{"text":"The following is an example of how one would perform a GET request for a loan pay date record in the TaskSuite system. A specific loanId is required for this request.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"End Point URLs","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www..tasksuite.com/webhook/v1/json/loans//paydates?date=2024-05-16\nhttps://www..tasksuite.com/webhook/v1/json/loans//paydates?date=today&timezone=America/NewYork\nhttps://www..tasksuite.com/webhook/v1/json/loans//paydates?date=today&timezone=America/Chicago\nhttps://www..tasksuite.com/webhook/v1/json/loans//paydates?date=today&timezone=America/Denver\nhttps://www..tasksuite.com/webhook/v1/json/loans//paydates?date=today&timezone=America/LosAngeles\nhttps://www..tasksuite.com/webhook/v1/json/loans//paydates?start_date=2024-05-16&end_date=2024-06-16\n...","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If the query parameter date=today is included, then a Time Zone argument is strongly recommended to avoid inconsistencies. If the Time Zone is not provided, the Time Zone on the server will be utilized (America/Chicago).","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Single Transaction Example (Python)","type":"text"}]},{"type":"codeBlock","content":[{"text":"import requests\nimport json\n\nurl = \"https://www..tasksuite.com/webhook/v1/json/loans//paydates?date=2024-05-16\"\n\nheaders = {\n 'Content-Type': 'application/json',\n 'Authorization': 'Bearer '\n}\n\nresponse = requests.request(\"GET\", url, headers=headers)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Single Transaction Response (Success)","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"id\": 1,\n \"state\": \"open\",\n \"date\": \"2024-05-16\",\n \"amount\": 100.00,\n \"amountOwed\": 100.00,\n \"amountPaid\": 0.00,\n \"startingCapital\": 100000.00,\n \"endingCapital\": 99900.00,\n \"loanBalance\": 100000.00,\n \"loanId\": 123\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Single Transaction Response (Failure)","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"statusCode\": 400,\n \"description\": \"LoanId not found.\",\n \"name\": \"Bad Request\"\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Batch Transaction Example GET Request","type":"text"}]},{"type":"paragraph","content":[{"text":"The following is an example of how to perform a GET request on all transaction records associated with a particular date or range of dates. Sorting by amount, or date is permitted. Filtering by the state of the pay date is permitted.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Pay Date State","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"paid - Scheduled payment for this date has been paid in full.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"partial - Scheduled payment for this date has been paid partially.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"open - Scheduled payment for this date has not been paid.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"End Point URLs","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Today","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www..tasksuite.com/webhook/json/v1/paydates?date=today&timezone=America/NewYork","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Today (Partially Paid)","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www..tasksuite.com/webhook/json/v1/paydates?date=today&timezone=America/NewYork&state=partial","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Today (Not Paid)","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www..tasksuite.com/webhook/json/v1/paydates?date=today&timezone=America/NewYork&state=open","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Today (Not paid nor Partially Paid)","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www..tasksuite.com/webhook/json/v1/paydates?date=today&timezone=America/NewYork&state=open&state=partial","type":"text"}]},{"type":"heading","attrs":{"level":4},"content":[{"text":"Today (Paid)","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www..tasksuite.com/webhook/json/v1/paydates?date=today&timezone=America/NewYork&state=paid","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Example URLs","type":"text"}]},{"type":"codeBlock","content":[{"text":"https://www..tasksuite.com/webhook/json/v1/loans//paydates?date=today&timezone=America/NewYork\nhttps://www..tasksuite.com/webhook/json/v1/paydates?date=2024-05-16\nhttps://www..tasksuite.com/webhook/json/v1/paydates?start_date=2024-05-16&end_date=2024-06-16\nhttps://www..tasksuite.com/webhook/json/v1/paydates?start_date=2024-05-16&end_date=2024-06-16&sort=amount&order=asc\nhttps://www..tasksuite.com/webhook/json/v1/paydates?start_date=2024-05-16&end_date=2024-06-16&sort=date&order=desc\n...","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"If the query parameter date=today is included, then a Time Zone argument is strongly recommended to avoid inconsistencies. If the Time Zone is not provided, the Time Zone on the server will be utilized (America/Chicago).","type":"text"}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Batch Pay Date Example (Python)","type":"text"}]},{"type":"codeBlock","content":[{"text":"import requests\nimport json\n\nurl = \"https://www..tasksuite.com/webhook/json/v1/paydates?date=today&timezone=America/NewYork\"\n\nheaders = {\n 'Content-Type': 'application/json',\n 'Authorization': 'Bearer '\n}\n\nresponse = requests.request(\"GET\", url, headers=headers)","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Batch Pay Date Example Response (Success)","type":"text"}]},{"type":"codeBlock","attrs":{"language":"json"},"content":[{"text":"{\n \"data\": [\n {\n \"id\": 1,\n \"state\": \"open\",\n \"date\": \"2024-07-11\",\n \"amount\": 100.00,\n \"amountOwed\": 100.00,\n \"amountPaid\": 0.00,\n \"startingCapital\": 100000.00,\n \"endingCapital\": 99900.00,\n \"loanBalance\": 100000.00,\n \"loanId\": 123\n },\n {\n \"id\": 2,\n \"state\": \"paid\",\n \"date\": \"2024-07-11\",\n \"amount\": 100.00,\n \"amountOwed\": 0.00,\n \"amountPaid\": 100.00,\n \"startingCapital\": 500000.00,\n \"endingCapital\": 49900.00,\n \"loanBalance\": 500000.00,\n \"loanId\": 456\n },\n {\n \"id\": 3,\n \"state\": \"partial\",\n \"date\": \"2024-07-11\",\n \"amount\": 100.00,\n \"amountOwed\": 0.00,\n \"amountPaid\": 50.00,\n \"startingCapital\": 1000.00,\n \"endingCapital\": 900.00,\n \"loanBalance\": 950.00,\n \"loanId\": 789\n }\n ],\n\n \"metadata\": {\n \"totalCount\": 3,\n \"numPaid\": 1,\n \"numPartial\": 1,\n \"numOpen\": 1\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Error Handling","type":"text"}]},{"type":"paragraph","content":[{"text":"In case of errors, the response will contain an appropriate error message with details on what caused the error. Make sure to handle these errors.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Notes","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Ensure that the required fields are provided in the request body; otherwise, the API will return an error indicating the missing fields.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"","type":"text","marks":[{"type":"code"}]},{"text":" in the headers must be valid and active for the Loan Transaction creation to be successful.","type":"text"}]}]}]},{"type":"rule"},{"type":"heading","attrs":{"level":1},"content":[{"text":"Support","type":"text"}]},{"type":"paragraph","content":[{"text":"If there are any errors or discrepancies with this document or the related API endpoints. Please reach out to ","type":"text"},{"text":"support@tasksuite.com","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:support@tasksuite.com"}}]},{"text":" and a support engineer with handle your query.","type":"text"}]}],"version":1}

Browser not supported