RetroTax

Clients

Clients Overview

{
  "email": "foo",
String

Email address of uploader (confirmation email will be sent to this email address).

  "client_name": "foo",
String

Name of the client.

  files: [
Array

Files

    {
    { ... }
Object
      "file_name": "foo",
String

Base64 encoded string.

      "file_type": "foo",
String

Type of the File.

      "contents": "foo"
String

Contents of the file.

    }
  ]
}

POST /clients/upload

Open in API Explorer
POST /clients/upload

Example Request

Format:
curl --request POST \
  --url https://api-qa.retrotax-aci.com/clients/upload \
  --header 'accept: application/json' \
  --header 'content-type: foo' \
  --header 'x-api-key: foo' \
  --header 'x-auth-iv: foo' \
  --header 'x-auth-token: foo' \
  --data '{"email":"foo","client_name":"foo","files":[{"file_name":"foo","file_type":"foo","contents":"foo"}]}'
require 'uri'
require 'net/http'

url = URI("https://api-qa.retrotax-aci.com/clients/upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["content-type"] = 'foo'
request["x-api-key"] = 'foo'
request["x-auth-token"] = 'foo'
request["x-auth-iv"] = 'foo'
request.body = "{\"email\":\"foo\",\"client_name\":\"foo\",\"files\":[{\"file_name\":\"foo\",\"file_type\":\"foo\",\"contents\":\"foo\"}]}"

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "POST",
  "hostname": "api-qa.retrotax-aci.com",
  "port": null,
  "path": "/clients/upload",
  "headers": {
    "accept": "application/json",
    "content-type": "foo",
    "x-api-key": "foo",
    "x-auth-token": "foo",
    "x-auth-iv": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ email: 'foo',
  client_name: 'foo',
  files: [ { file_name: 'foo', file_type: 'foo', contents: 'foo' } ] }));
req.end();
import http.client

conn = http.client.HTTPSConnection("api-qa.retrotax-aci.com")

payload = "{\"email\":\"foo\",\"client_name\":\"foo\",\"files\":[{\"file_name\":\"foo\",\"file_type\":\"foo\",\"contents\":\"foo\"}]}"

headers = {
    'accept': "application/json",
    'content-type': "foo",
    'x-api-key': "foo",
    'x-auth-token': "foo",
    'x-auth-iv': "foo"
    }

conn.request("POST", "/clients/upload", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-qa.retrotax-aci.com/clients/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\"email\":\"foo\",\"client_name\":\"foo\",\"files\":[{\"file_name\":\"foo\",\"file_type\":\"foo\",\"contents\":\"foo\"}]}",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: foo",
    "x-api-key: foo",
    "x-auth-iv: foo",
    "x-auth-token: foo"
  ),
));

$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/ioutil"
)

func main() {

	url := "https://api-qa.retrotax-aci.com/clients/upload"

	payload := strings.NewReader("{\"email\":\"foo\",\"client_name\":\"foo\",\"files\":[{\"file_name\":\"foo\",\"file_type\":\"foo\",\"contents\":\"foo\"}]}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("accept", "application/json")
	req.Header.Add("content-type", "foo")
	req.Header.Add("x-api-key", "foo")
	req.Header.Add("x-auth-token", "foo")
	req.Header.Add("x-auth-iv", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Headers

Name Type Required Description Example
Content-Type String Optional foo
X-API-KEY String Optional foo
X-AUTH-TOKEN String Optional foo
X-AUTH-IV String Optional foo

Request Body

Name Type Required Description Example
clientUploads Object Required
{
  "email": "foo",
String

Email address of uploader (confirmation email will be sent to this email address).

  "client_name": "foo",
String

Name of the client.

  files: [
Array

Files

    {
    { ... }
Object
      "file_name": "foo",
String

Base64 encoded string.

      "file_type": "foo",
String

Type of the File.

      "contents": "foo"
String

Contents of the file.

    }
  ]
}

Responses

200 OK

200 response

(Empty Response)
400 Bad Request

400 response

(Empty Response)
401 Unauthorized

401 response

(Empty Response)
403 Forbidden

403 response

(Empty Response)
404 Not Found

404 response

(Empty Response)

PUT /clients/{client_id}

Open in API Explorer
PUT /clients/{client_id}

Example Request

Format:
curl --request PUT \
  --url https://api-qa.retrotax-aci.com/clients/foo \
  --header 'accept: application/json' \
  --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
  --header 'x-api-key: YOUR API KEY HERE' \
  --header 'x-auth-iv: foo' \
  --header 'x-auth-token: foo'
require 'uri'
require 'net/http'

url = URI("https://api-qa.retrotax-aci.com/clients/foo")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["x-api-key"] = 'YOUR API KEY HERE'
request["content-type"] = 'multipart/form-data; boundary=---011000010111000001101001'
request["x-auth-token"] = 'foo'
request["x-auth-iv"] = 'foo'

response = http.request(request)
puts response.read_body
var http = require("https");

var options = {
  "method": "PUT",
  "hostname": "api-qa.retrotax-aci.com",
  "port": null,
  "path": "/clients/foo",
  "headers": {
    "accept": "application/json",
    "x-api-key": "YOUR API KEY HERE",
    "content-type": "multipart/form-data; boundary=---011000010111000001101001",
    "x-auth-token": "foo",
    "x-auth-iv": "foo"
  }
};

var req = http.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function () {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();
import http.client

conn = http.client.HTTPSConnection("api-qa.retrotax-aci.com")

payload = ""

headers = {
    'accept': "application/json",
    'x-api-key': "YOUR API KEY HERE",
    'content-type': "multipart/form-data; boundary=---011000010111000001101001",
    'x-auth-token': "foo",
    'x-auth-iv': "foo"
    }

conn.request("PUT", "/clients/foo", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api-qa.retrotax-aci.com/clients/foo",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "",
  CURLOPT_HTTPHEADER => array(
    "accept: application/json",
    "content-type: multipart/form-data; boundary=---011000010111000001101001",
    "x-api-key: YOUR API KEY HERE",
    "x-auth-iv: foo",
    "x-auth-token: foo"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api-qa.retrotax-aci.com/clients/foo"

	req, _ := http.NewRequest("PUT", url, nil)

	req.Header.Add("accept", "application/json")
	req.Header.Add("x-api-key", "YOUR API KEY HERE")
	req.Header.Add("content-type", "multipart/form-data; boundary=---011000010111000001101001")
	req.Header.Add("x-auth-token", "foo")
	req.Header.Add("x-auth-iv", "foo")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Request Headers

Name Type Required Description Example
X-AUTH-TOKEN String Required foo
X-AUTH-IV String Optional foo

Path Parameters

Name Type Required Description Example
client_id String Required foo

Responses

200 OK

200 response

(Empty Response)
400 Bad Request

400 response

(Empty Response)
401 Unauthorized

401 response

(Empty Response)
403 Forbidden

403 response

(Empty Response)
404 Not Found

404 response

(Empty Response)