Create a tax filing
curl --request POST \
--url https://api.yorlet.com/v1/tax_filings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "nrl6",
"description": "<string>",
"metadata": {},
"workspace": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/tax_filings"
payload = {
"type": "nrl6",
"description": "<string>",
"metadata": {},
"workspace": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'nrl6', description: '<string>', metadata: {}, workspace: '<string>'})
};
fetch('https://api.yorlet.com/v1/tax_filings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/tax_filings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'nrl6',
'description' => '<string>',
'metadata' => [
],
'workspace' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/tax_filings"
payload := strings.NewReader("{\n \"type\": \"nrl6\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"workspace\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/tax_filings")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"nrl6\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/tax_filings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"nrl6\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "tax_filing",
"description": "<string>",
"status": "pending",
"type": "nrl6",
"account": "<string>",
"deleted": false,
"filed_count": 0,
"metadata": {},
"total_count": 0
}Authorizations
API Key authentication. Use "Bearer YOUR_API_KEY".
Body
The type of tax forms to include in this filing.
nrl6 An arbitrary string attached to the object. Often useful for displaying to users.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
The workspace the tax filing belongs to.
Response
Returns a tax filing object if successful.
Unique identifier for the object.
Time at which the object was created. Measured in seconds since the Unix epoch.
tax_filing An arbitrary string attached to the object. Often useful for displaying to users.
The current status of the tax filing.
pending, complete The type of tax forms included in this filing.
nrl6 The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.
Only returned if the object has been deleted.
The number of tax forms that have been filed in this filing.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Show child attributes
Show child attributes
The total number of tax forms included in this filing.
Was this page helpful?
curl --request POST \
--url https://api.yorlet.com/v1/tax_filings \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "nrl6",
"description": "<string>",
"metadata": {},
"workspace": "<string>"
}
'import requests
url = "https://api.yorlet.com/v1/tax_filings"
payload = {
"type": "nrl6",
"description": "<string>",
"metadata": {},
"workspace": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({type: 'nrl6', description: '<string>', metadata: {}, workspace: '<string>'})
};
fetch('https://api.yorlet.com/v1/tax_filings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.yorlet.com/v1/tax_filings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'nrl6',
'description' => '<string>',
'metadata' => [
],
'workspace' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.yorlet.com/v1/tax_filings"
payload := strings.NewReader("{\n \"type\": \"nrl6\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"workspace\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.yorlet.com/v1/tax_filings")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"nrl6\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"workspace\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yorlet.com/v1/tax_filings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"nrl6\",\n \"description\": \"<string>\",\n \"metadata\": {},\n \"workspace\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"created": 123,
"object": "tax_filing",
"description": "<string>",
"status": "pending",
"type": "nrl6",
"account": "<string>",
"deleted": false,
"filed_count": 0,
"metadata": {},
"total_count": 0
}