mintlify · jakewherlock1 · Mar 15, 2024 · Mar 15, 2024 · Mar 15, 2024 · Mar 15, 2024
diff --git a/.DS_Store b/.DS_Store
diff --git a/api-reference/accounts/create.mdx b/api-reference/accounts/create.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Create an account'
+openapi: 'POST /accounts'
+---
diff --git a/api-reference/accounts/delete.mdx b/api-reference/accounts/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Delete an account'
+openapi: 'DELETE /accounts/{account_id}'
+---
diff --git a/api-reference/accounts/get.mdx b/api-reference/accounts/get.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Get an account'
+openapi: 'GET /accounts/{account_id}'
+---
diff --git a/api-reference/accounts/list-recurring.mdx b/api-reference/accounts/list-recurring.mdx
@@ -0,0 +1,4 @@
+---
+title: 'List all recurring accounts'
+openapi: 'GET /accounts/recurring'
+---
diff --git a/api-reference/accounts/list.mdx b/api-reference/accounts/list.mdx
@@ -0,0 +1,4 @@
+---
+title: 'List all accounts'
+openapi: 'GET /accounts'
+---
diff --git a/api-reference/api-keys/create.mdx b/api-reference/api-keys/create.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Create an API Key'
+openapi: 'POST /api-keys'
+---
diff --git a/api-reference/api-keys/delete.mdx b/api-reference/api-keys/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Delete an API Key'
+openapi: 'DELETE /api-keys/{api_key_id}'
+---
diff --git a/api-reference/api-keys/list.mdx b/api-reference/api-keys/list.mdx
@@ -0,0 +1,4 @@
+---
+title: 'List API Keys'
+openapi: 'GET /api-keys'
+---
diff --git a/api-reference/configuration/get.mdx b/api-reference/configuration/get.mdx
@@ -0,0 +1,6 @@
+---
+title: 'Get client configuration'
+openapi: 'GET /configuration'
+---
+
+
diff --git a/api-reference/configuration/update.mdx b/api-reference/configuration/update.mdx
@@ -0,0 +1,6 @@
+---
+title: 'Update client configuration'
+openapi: 'PUT /configuration'
+---
+
+
diff --git a/api-reference/documents/delete.mdx b/api-reference/documents/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Delete a document'
+openapi: 'DELETE /documents/{document_id}'
+---
diff --git a/api-reference/documents/get.mdx b/api-reference/documents/get.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Retrieve a specific document'
+openapi: 'GET /documents/{document_id}'
+---
diff --git a/api-reference/documents/list.mdx b/api-reference/documents/list.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Lists all documents'
+openapi: 'GET /documents'
+---
diff --git a/api-reference/endpoint/create.mdx b/api-reference/endpoint/create.mdx
diff --git a/api-reference/endpoint/delete.mdx b/api-reference/endpoint/delete.mdx
diff --git a/api-reference/endpoint/get.mdx b/api-reference/endpoint/get.mdx
diff --git a/api-reference/entries/connections-create.mdx b/api-reference/entries/connections-create.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Create a connection'
+openapi: 'POST /entries/connections'
+---
diff --git a/api-reference/entries/delete.mdx b/api-reference/entries/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Delete an entry'
+openapi: 'DELETE /entries/{entry_id}'
+---
diff --git a/api-reference/entries/list.mdx b/api-reference/entries/list.mdx
@@ -0,0 +1,4 @@
+---
+title: 'List all entries'
+openapi: 'GET /entries'
+---
diff --git a/api-reference/entries/payslips-create.mdx b/api-reference/entries/payslips-create.mdx
@@ -0,0 +1,199 @@
+---
+title: 'Upload payslips'
+openapi: 'POST /entries/payslips'
+---
+
+
+
+<RequestExample>
+
+```bash cURL
+curl --request POST \
+  --url https://api.sandbox.goteal.co/entries/payslips \
+  --header 'Authorization: Bearer <token>' \
+  --header 'Content-Type: multipart/form-data' \
+  --form 'payslip123456=@"/local/file/file1-payslip.pdf"'
+  --form 'payslip2=@"/local/file/John-Smith-payslip18.pdf.pdf"'
+  --form 'payslip98765=@"/local/file/Payslip3.pdf"'
+```
+
+```python Python
+import requests
+
+url = "https://api.sandbox.goteal.co/entries/payslips"
+
+payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payslip\"\r\n\r\n@\"/local/file/system/path/to/payslip/Payslip_44404148.pdf\"\n\r\n-----011000010111000001101001--\r\n\r\n"
+headers = {
+    "Authorization": "Bearer <token>",
+    "Content-Type": "multipart/form-data"
+}
+
+response = requests.request("POST", url, data=payload, headers=headers)
+
+print(response.text)
+
+```
+
+
+```javascript JavaScript
+const form = new FormData();
+form.append("payslip", "@\"/local/file/system/path/to/payslip/Payslip_44404148.pdf\"\n");
+
+const options = {
+  method: 'POST',
+  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'multipart/form-data'}
+};
+
+options.body = form;
+
+fetch('https://api.sandbox.goteal.co/entries/payslips', options)
+  .then(response => response.json())
+  .then(response => console.log(response))
+  .catch(err => console.error(err));
+```
+
+
+```php PHP
+<?php
+
+$curl = curl_init();
+
+curl_setopt_array($curl, [
+  CURLOPT_URL => "https://api.sandbox.goteal.co/entries/payslips",
+  CURLOPT_RETURNTRANSFER => true,
+  CURLOPT_ENCODING => "",
+  CURLOPT_MAXREDIRS => 10,
+  CURLOPT_TIMEOUT => 30,
+  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
+  CURLOPT_CUSTOMREQUEST => "POST",
+  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payslip\"\r\n\r\n@\"/local/file/system/path/to/payslip/Payslip_44404148.pdf\"\n\r\n-----011000010111000001101001--\r\n\r\n",
+  CURLOPT_HTTPHEADER => [
+    "Authorization: Bearer <token>",
+    "Content-Type: multipart/form-data"
+  ],
+]);
+
+$response = curl_exec($curl);
+$err = curl_error($curl);
+
+curl_close($curl);
+
+if ($err) {
+  echo "cURL Error #:" . $err;
+} else {
+  echo $response;
+}
+```
+
+
+
+```go Go
+package main
+
+import (
+	"fmt"
+	"strings"
+	"net/http"
+	"io/ioutil"
+)
+
+func main() {
+
+	url := "https://api.sandbox.goteal.co/entries/payslips"
+
+	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payslip\"\r\n\r\n@\"/local/file/system/path/to/payslip/Payslip_44404148.pdf\"\n\r\n-----011000010111000001101001--\r\n\r\n")
+
+	req, _ := http.NewRequest("POST", url, payload)
+
+	req.Header.Add("Authorization", "Bearer <token>")
+	req.Header.Add("Content-Type", "multipart/form-data")
+
+	res, _ := http.DefaultClient.Do(req)
+
+	defer res.Body.Close()
+	body, _ := ioutil.ReadAll(res.Body)
+
+	fmt.Println(res)
+	fmt.Println(string(body))
+
+}
+```
+
+
+
+```java Java
+HttpResponse<String> response = Unirest.post("https://api.sandbox.goteal.co/entries/payslips")
+  .header("Authorization", "Bearer <token>")
+  .header("Content-Type", "multipart/form-data")
+  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"payslip\"\r\n\r\n@\"/local/file/system/path/to/payslip/Payslip_44404148.pdf\"\n\r\n-----011000010111000001101001--\r\n\r\n")
+  .asString();
+```
+
+</RequestExample>
+
+<ResponseExample>
+
+```json Response
+{
+  "account_id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
+  "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
+  "payroll_submissions": [
+    {
+      "id": "95a0e70b-fe02-4f47-aef9-2efff279df71",
+      "account_id": "674744df-9626-47ef-ae2b-4a491be136b5",
+      "entry_id": "be770ba4-1362-46cd-8c1c-2330ce3a8b69",
+      "created_at": "2019-05-17T00:00:00.000Z",
+      "document_external_id": "payslip123456",
+      "document_filename": "file1-payslip.pdf",
+      "identity_information": {
+        "name": "John Smith",
+        "date_of_birth": "2019-05-17T00:00:00.000Z",
+        "address": {
+          "street": "123 Main Street",
+          "county": "Greater London",
+          "city": "London",
+          "post_code": "SW1A 1AA",
+          "country": "United Kingdom"
+        },
+        "email": "john.smith@company.com",
+        "phone": 447123456789,
+        "NI_number": "AB123456C"
+      },
+      "employment_information": {
+        "employer_name": "Acme Ltd",
+        "role": "Software Engineer",
+        "type": "Full-time",
+        "status": "Active",
+        "start_date": "2019-05-17T00:00:00.000Z",
+        "leave_date": "2019-05-17T00:00:00.000Z"
+      },
+      "income_information": {
+        "pay_date": "2023-05-27T00:00:00.000Z",
+        "pay_interval_start": "2023-05-01T00:00:00.000Z",
+        "pay_interval_end": "2023-05-31T00:00:00.000Z",
+        "pay_frequency": "Monthly",
+        "earnings": {
+          "gross_pay": 3500,
+          "net_pay": 2500,
+          "base_salary": 3000,
+          "bonus": 500
+        },
+        "deductions": {
+          "income_tax": 500,
+          "employee_ni": 200,
+          "employee_pension": 300,
+          "total_deductions": 1000
+        }
+      }
+    },
+    "fraud_risk": "Low"
+    ],
+  "payslip_errors" : [{
+    "error" : "File is not a payslip",
+    "file_name" : "Payslip3.pdf"
+  }]
+}
+```
+
+</ResponseExample>
+
diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx
diff --git a/api-reference/members/create.mdx b/api-reference/members/create.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Invite a Member'
+openapi: 'POST /members'
+---
diff --git a/api-reference/members/delete.mdx b/api-reference/members/delete.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Delete a Member'
+openapi: 'DELETE /members/{member_id}'
+---
diff --git a/api-reference/members/get.mdx b/api-reference/members/get.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Retrieve a Member'
+openapi: 'GET /members/{member_id}'
+---
diff --git a/api-reference/members/list.mdx b/api-reference/members/list.mdx
@@ -0,0 +1,4 @@
+---
+title: 'List all Members'
+openapi: 'GET /members'
+---
diff --git a/api-reference/members/signin.mdx b/api-reference/members/signin.mdx
@@ -0,0 +1,4 @@
+---
+title: 'Member Sigin In'
+openapi: 'POST /members/signin'
+---